< Back

Add-CrmFlightAudience

Sat Jan 18, 2020 4:08 pm

NAME Add-CrmFlightAudience



SYNTAX

Add-CrmFlightAudience [-ApiUrl] <uri> [[-Credential] <pscredential>] [[-TenantId] <guid>] -FlightId <guid>

-InstanceId <guid> [-MaxCrmConnectionTimeOutMinutes <int>] [-NonInteractive] [<CommonParameters>]





PARAMETERS

-ApiUrl <uri>



Required? true

Position? 0

Accept pipeline input? true (ByPropertyName)

Parameter set name ServiceReq

Aliases None

Dynamic? false



-Credential <pscredential>



Required? false

Position? 1

Accept pipeline input? true (ByValue, ByPropertyName)

Parameter set name ServiceReq

Aliases None

Dynamic? false



-FlightId <guid>



Required? true

Position? Named

Accept pipeline input? true (ByPropertyName)

Parameter set name (All)

Aliases None

Dynamic? false



-InstanceId <guid>



Required? true

Position? Named

Accept pipeline input? true (ByPropertyName)

Parameter set name (All)

Aliases None

Dynamic? false



-MaxCrmConnectionTimeOutMinutes <int>



Required? false

Position? Named

Accept pipeline input? true (ByPropertyName)

Parameter set name ServiceReq

Aliases None

Dynamic? false



-NonInteractive

Set to indicate a headless, non-interactive session that will not popup prompts e.g. when authenticating and

MFA is required



Required? false

Position? Named

Accept pipeline input? true (ByPropertyName)

Parameter set name ServiceReq

Aliases None

Dynamic? false



-TenantId <guid>

Tenant ID to use for creating the Authentication Token, required for Client ID / Client Secret Auth type



Required? false

Position? 2

Accept pipeline input? true (ByValue, ByPropertyName)

Parameter set name ServiceReq

Aliases None

Dynamic? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).





INPUTS

System.Guid

System.Uri

System.Management.Automation.PSCredential

System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

System.Int32

System.Management.Automation.SwitchParameter





OUTPUTS

System.Object



ALIASES

None





REMARKS

None





examples : @{example=@{code=PS C:\\> Backup-CrmInstance -ApiUrl $connectionhost -BackupInfo $MyBackupInfo

-Credential $cred; remarks=System.Management.Automation.PSObject[]; title=Example 1}}

inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.NewInstanceBackup};

description=System.Management.Automation.PSObject[]}}

alertSet : @{alert=System.Management.Automation.PSObject[]}

syntax : @{syntaxItem=@{name=Backup-CrmInstance; parameter=System.Management.Automation.PSObject[]}}

parameters : @{parameter=System.Management.Automation.PSObject[]}

details : @{description=System.Management.Automation.PSObject[]; verb=Backup; noun=CrmInstance;

name=Backup-CrmInstance}

description : {@{Text=The Backup-CrmInstance cmdlet initiates a back up of a Dynamics 365 Customer Engagement

(online) instance.}}

relatedLinks : @{navigationLink=@{uri=; linkText=New-CrmBackupInfo}}

returnValues : @{returnValue=@{type=@{name=System.Object}; description=System.Management.Automation.PSObject[]}}

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:MSHelp : http://msdn.microsoft.com/mshelp

Name : Backup-CrmInstance

Category : Cmdlet

Synopsis : Initiates a back up a Dynamics 365 Customer Engagement (online) instance.

Component :

Role :

Functionality :

PSSnapIn :

ModuleName : Microsoft.Xrm.OnlineManagementAPI





examples : @{example=@{code=Copy-CrmInstance -ApiUrl $connectionhost -CopyInstanceRequestDetails

CopyInstanceRequestDetails -Credential $cred -SourceInstanceIdToCopy $InstanceId;

remarks=System.Management.Automation.PSObject[]; title=Example 1}}

inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.CopyRequest};

description=System.Management.Automation.PSObject[]}}

alertSet : @{alert=System.Management.Automation.PSObject[]}

syntax : @{syntaxItem=@{name=Copy-CrmInstance; parameter=System.Management.Automation.PSObject[]}}

parameters : @{parameter=System.Management.Automation.PSObject[]}

details : @{description=System.Management.Automation.PSObject[]; verb=Copy; noun=CrmInstance;

name=Copy-CrmInstance}

description : {@{Text=The Copy-CrmInstance cmdlet performs a copy operation on a Dynamics 365 Customer Engagement

(online) instance to another Sandbox instance in your Office 365 tenant.}}

relatedLinks : @{navigationLink=@{uri=; linkText=New-CrmInstanceCopyRequestInfo}}

returnValues : @{returnValue=@{type=@{name=System.Object}; description=System.Management.Automation.PSObject[]}}

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:MSHelp : http://msdn.microsoft.com/mshelp

Name : Copy-CrmInstance

Category : Cmdlet

Synopsis : Copy a (v9 or higher) Dynamics 365 Customer Engagement (online) production or sandbox instance to

another sandbox instance in your Office 365 tenant.

Component :

Role :

Functionality :

PSSnapIn :

ModuleName : Microsoft.Xrm.OnlineManagementAPI





examples : @{example=System.Management.Automation.PSObject[]}

inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.InstanceAdminModeSettings};

description=System.Management.Automation.PSObject[]}}

alertSet : @{alert=System.Management.Automation.PSObject[]}

syntax : @{syntaxItem=@{name=Disable-CrmAdminMode; parameter=System.Management.Automation.PSObject[]}}

parameters : @{parameter=System.Management.Automation.PSObject[]}

details : @{description=System.Management.Automation.PSObject[]; verb=Disable; noun=CrmAdminMode;

name=Disable-CrmAdminMode}

description : {@{Text=The Disable-CrmAdminMode cmdlet disables administration mode on a sandbox instance that has

administration mode enabled. When you place a Sandbox instance in administration mode only users with

Dynamics 365 System Administrator or System Customizer security roles will be able to sign in to that

instance. Administration mode is useful when you want to make operational changes and not have regular

users affect your work, and not have your work affect regular users.}}

relatedLinks : @{navigationLink=System.Management.Automation.PSObject[]}

returnValues : @{returnValue=@{type=@{name=System.Object}; description=System.Management.Automation.PSObject[]}}

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:MSHelp : http://msdn.microsoft.com/mshelp

Name : Disable-CrmAdminMode

Category : Cmdlet

Synopsis : Disables administration mode on a sandbox instance that has administration mode enabled.

Component :

Role :

Functionality :

PSSnapIn :

ModuleName : Microsoft.Xrm.OnlineManagementAPI





examples : @{example=@{code=PS C:\\> Disable-CrmManagementApp -Id <RegistrationGuid> -ApiUrl $connectionhost

-Credential $cred; remarks=System.Management.Automation.PSObject[]; title=Example 1}}

inputTypes : @{inputType=@{type=@{name=System.Guid}; description=System.Management.Automation.PSObject[]}}

alertSet : @{alert=System.Management.Automation.PSObject[]}

syntax : @{syntaxItem=@{name=Disable-CrmManagementApp; parameter=System.Management.Automation.PSObject[]}}

parameters : @{parameter=System.Management.Automation.PSObject[]}

details : @{description=System.Management.Automation.PSObject[]; verb=Disable; noun=CrmManagementApp;

name=Disable-CrmManagementApp}

description : {@{Text=The Disable-CrmManagementApp cmdlet disables the specified registered Azure Active Directory

Web app/API application.}}

relatedLinks : @{navigationLink=System.Management.Automation.PSObject[]}

returnValues : @{returnValue=@{type=@{name=System.Object}; description=System.Management.Automation.PSObject[]}}

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:MSHelp : http://msdn.microsoft.com/mshelp

Name : Disable-CrmManagementApp

Category : Cmdlet

Synopsis : Disables the specified registered Azure Active Directory Web app/API application.

Component :

Role :

Functionality :

PSSnapIn :

ModuleName : Microsoft.Xrm.OnlineManagementAPI





examples : @{example=System.Management.Automation.PSObject[]}

inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.InstanceAdminModeSettings};

description=System.Management.Automation.PSObject[]}}

alertSet : @{alert=System.Management.Automation.PSObject[]}

syntax : @{syntaxItem=@{name=Enable-CrmAdminMode; parameter=System.Management.Automation.PSObject[]}}

parameters : @{parameter=System.Management.Automation.PSObject[]}

details : @{description=System.Management.Automation.PSObject[]; verb=Enable; noun=CrmAdminMode;

name=Enable-CrmAdminMode}

description : {@{Text=The Enable-CrmAdminMode cmdlet enables administration mode on a sandbox instance. When you

place a Sandbox instance in administration mode only users with Dynamics 365 System Administrator or

System Customizer security roles will be able to sign in to that instance. Administration mode is

useful when you want to make operational changes and not have regular users affect your work, and not

have your work affect regular users.

}, @{Text=You can find whether a sandbox instance is enabled for administration mode by running the

Get-CrmInstances cmdlet.}}

relatedLinks : @{navigationLink=System.Management.Automation.PSObject[]}

returnValues : @{returnValue=@{type=@{name=System.Object}; description=System.Management.Automation.PSObject[]}}

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:MSHelp : http://msdn.microsoft.com/mshelp

Name : Enable-CrmAdminMode

Category : Cmdlet

Synopsis : Enables administration mode on a sandbox instance.

Component :

Role :

Functionality :

PSSnapIn :

ModuleName : Microsoft.Xrm.OnlineManagementAPI





examples : @{example=@{code=PS C:\\> Enable-CrmManagementApp -Id <RegistrationGuid> -ApiUrl $connectionhost

-Credential $cred; remarks=System.Management.Automation.PSObject[]; title=Example 1}}

inputTypes : @{inputType=@{type=@{name=System.Guid}; description=System.Management.Automation.PSObject[]}}

alertSet : @{alert=System.Management.Automation.PSObject[]}

syntax : @{syntaxItem=@{name=Enable-CrmManagementApp; parameter=System.Management.Automation.PSObject[]}}

parameters : @{parameter=System.Management.Automation.PSObject[]}

details : @{description=System.Management.Automation.PSObject[]; verb=Enable; noun=CrmManagementApp;

name=Enable-CrmManagementApp}

description : {@{Text=The Enable-CrmManagementApp cmdlet enables the specified registered Azure Active Directory Web

app/API application for use with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.}}

relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmManagementApps}}

returnValues : @{returnValue=@{type=@{name=System.Object}; description=System.Management.Automation.PSObject[]}}

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:MSHelp : http://msdn.microsoft.com/mshelp

Name : Enable-CrmManagementApp

Category : Cmdlet

Synopsis : Enables the specified registered Azure Active Directory Web app/API application.

Component :

Role :

Functionality :

PSSnapIn :

ModuleName : Microsoft.Xrm.OnlineManagementAPI





examples : @{example=@{code=PS C:\\> Get-CrmCurrencies -ApiUrl $connectionhost -Credential $cred;

remarks=System.Management.Automation.PSObject[]; title=Example 1}}

inputTypes : @{inputType=@{type=@{name=System.Uri}; description=System.Management.Automation.PSObject[]}}

alertSet : @{alert=System.Management.Automation.PSObject[]}

syntax : @{syntaxItem=@{name=Get-CrmCurrencies; parameter=System.Management.Automation.PSObject[]}}

parameters : @{parameter=System.Management.Automation.PSObject[]}

details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmCurrencies;

name=Get-CrmCurrencies}

description : {@{Text=The Get-CrmCurrencies cmdlet returns a list of currencies that are available for all instances

within the same tenant.}}

relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmInstances}}

returnValues : @{returnValue=@{type=@{name=System.Object}; description=System.Management.Automation.PSObject[]}}

xmlns:maml : http://schemas.microsoft.com/maml/2004/10

xmlns:command : http://schemas.microsoft.com/maml/dev/command/2004/10

xmlns:dev : http://schemas.microsoft.com/maml/dev/2004/10

xmlns:MSHelp : http://msdn.microsoft.com/mshelp

Name : Get-CrmCurrencies

Category : Cmdlet

Synopsis : Returns a list of currencies that are available for all instances within the same tenant.

Component :

Role :

Functionality :

PSSnapIn :

ModuleName : Microsoft.Xrm.OnlineManagementAPI