< Back
Get-CrmFlights
Post
NAME Get-CrmFlights
SYNTAX
Get-CrmFlights [-ApiUrl] <uri> [[-Credential] <pscredential>] [[-TenantId] <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
-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.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:\\> Get-CrmGenerateProtectionKey -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-CrmGenerateProtectionKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmGenerateProtectionKey;
name=Get-CrmGenerateProtectionKey}
description : {@{Text=The Get-CrmGenerateProtectionKey cmdlet returns a new protection key}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmGenerateProtectionKey}}
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-CrmGenerateProtectionKey
Category : Cmdlet
Synopsis : Returns a new protection key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstance -Id <Guid> -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=Get-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstance;
name=Get-CrmInstance}
description : {@{Text=The Get-CrmInstance cmdlet retrieves a Dynamics 365 Customer Engagement (online) instance in
your Office 365 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-CrmInstance
Category : Cmdlet
Synopsis : Retrieves a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstanceBackup -ApiUrl $connectionhost -InstanceId <instance id>
-RestorePointId <restore point id> -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=Get-CrmInstanceBackup; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstanceBackup;
name=Get-CrmInstanceBackup}
description : {@{Text=The Get-CrmInstanceBackup cmdlet retrieves a Dynamics 365 Customer Engagement (online)
instance backup based on the InstanceId and BackupId parameters.}}
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 : Get-CrmInstanceBackup
Category : Cmdlet
Synopsis : Retrieves a specific Dynamics 365 Customer Engagement (online) instance backup based on the backup id.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstanceBackups -ApiUrl $connectionhost -InstanceId <instanceid>
-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=Get-CrmInstanceBackups; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstanceBackups;
name=Get-CrmInstanceBackups}
description : {@{Text=The Get-CrmInstanceBackups cmdlet retrieves all backups for a Dynamics 365 Customer Engagement
(online) instance.}}
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 : Get-CrmInstanceBackups
Category : Cmdlet
Synopsis : Retrieves all backups for a Dynamics 365 Customer Engagement (online) instance.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstances -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-CrmInstances; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstances;
name=Get-CrmInstances}
description : {@{Text=The Get-CrmInstances cmdlet retrieves details for all Dynamics 365 Customer Engagement
(online) instances that are in your tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmInstance}}
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-CrmInstances
Category : Cmdlet
Synopsis : Retrieves details for Dynamics 365 Customer Engagement (online) instances that are in your tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstanceType -ApiUrl $connectionhost -InstanceType Production
-Credential $cred; remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.InstanceType};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=Get-CrmInstanceType; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstanceType;
name=Get-CrmInstanceType}
description : {@{Text=The Get-CrmInstanceType cmdlet retrieves information about a Dynamics 365 Customer Engagement
(online) instance type.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmInstanceTypes}}
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-CrmInstanceType
Category : Cmdlet
Synopsis : Retrieves information about a Dynamics 365 Customer Engagement (online) instance type.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstanceTypes -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-CrmInstanceTypes; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstanceTypes;
name=Get-CrmInstanceTypes}
description : {@{Text=The Get-CrmInstanceTypes cmdlet retrieves information about all the instance types available,
such as production, sandbox, support, preview, and trial, in the Dynamics 365 Customer Engagement
(online) tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmInstanceType}}
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-CrmInstanceTypes
Category : Cmdlet
Synopsis : Retrieves information about all the instance types available, such as production, sandbox, support,
preview, and trial, in the Dynamics 365 Customer Engagement (online) tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmLanguages -ApiUrl $connectionhost -Credential $cred -ServiceReleaseId
015e6a5c-2fa5-e411-80ce-00155db07c21; 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=Get-CrmLanguages; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmLanguages;
name=Get-CrmLanguages}
description : {@{Text=The Get-CrmLanguages cmdlet retrieves all languages supported by Dynamics 365 Customer
Enagagement (online) for the specified service release.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmServiceVersions}}
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-CrmLanguages
Category : Cmdlet
Synopsis : Retrieves all languages supported by Dynamics 365 Customer Enagagement (online) for the specified
service release.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-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=Get-CrmManagementApp; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmManagementApp;
name=Get-CrmManagementApp}
description : {@{Text=The Get-CrmManagementApp cmdlet returns the specified registered Azure Active Directory Web
app/API application.}}
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 : Get-CrmManagementApp
Category : Cmdlet
Synopsis : Returns the specified registered Azure Active Directory Web app/API application.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmManagementApps -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-CrmManagementApps; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmManagementApps;
name=Get-CrmManagementApps}
description : {@{Text=The Get-CrmManagementApps cmdlet returns a list of all registered Azure Active Directory Web
app/API applications under the tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmManagementApp}}
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-CrmManagementApps
Category : Cmdlet
Synopsis : Returns a list of all registered Azure Active Directory Web app/API applications under the tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmOperationStatus -Id <OperationIdGuid> -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=Get-CrmOperationStatus; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmOperationStatus;
name=Get-CrmOperationStatus}
description : {@{Text=The Get-CrmOperationStatus retrieves the status of an operation from your Dynamics 365
Customer Engagement (online) instance.}}
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 : Get-CrmOperationStatus
Category : Cmdlet
Synopsis : Retrieves the status for an operation from your Dynamics 365 Customer Engagement (online) instance.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmProtectedInstances -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=Get-CrmProtectedInstances; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmProtectedInstances;
name=Get-CrmProtectedInstances}
description : {@{Text=The Get-CrmProtectedInstances cmdlet retrieves a list of tenant protected instances in your
Office 365 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-CrmProtectedInstances
Category : Cmdlet
Synopsis : Retrieves a list of tenant protected instances in your Office 365 tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmRetrieveAvailableTenantProtectionKeys -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-CrmRetrieveAvailableTenantProtectionKeys;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get;
noun=CrmRetrieveAvailableTenantProtectionKeys; name=Get-CrmRetrieveAvailableTenantProtectionKeys}
description : {@{Text=The Get-CrmRetrieveAvailableTenantProtectionKeys cmdlet returns the available tenant
protection keys}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmRetrieveAvailableTenantProtectionKeys}}
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-CrmRetrieveAvailableTenantProtectionKeys
Category : Cmdlet
Synopsis : Returns the available protection keys for current tenant
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmRetrieveTenantProtectionKey -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-CrmRetrieveTenantProtectionKey;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmRetrieveTenantProtectionKey;
name=Get-CrmRetrieveTenantProtectionKey}
description : {@{Text=The Get-CrmRetrieveTenantProtectionKey cmdlet returns the current tenant protection key}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmRetrieveTenantProtectionKey}}
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-CrmRetrieveTenantProtectionKey
Category : Cmdlet
Synopsis : Returns the current tenant protection key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmServiceVersions -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-CrmServiceVersions; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmServiceVersions;
name=Get-CrmServiceVersions}
description : {@{Text=The Get-CrmServiceVersions cmdlet retrieves information about all currently supported releases
for Dynamics 365 Customer Engagement (online).}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmLanguages}}
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-CrmServiceVersions
Category : Cmdlet
Synopsis : Retrieves information about all currently supported releases for Dynamics 365 Customer Engagement
(online).
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmTemplates -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-CrmTemplates; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmTemplates;
name=Get-CrmTemplates}
description : {@{Text=The Get-CrmTemplates cmdlet retrieves a list of application templates supported for
provisioning a Dynamics 365 Customer Engagement (online) instance.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Microsoft.Xrm.OnlineManagementAPI Module}}
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-CrmTemplates
Category : Cmdlet
Synopsis : Retrieves a list of application templates supported for provisioning a Dynamics 365 Customer
Engagement (online) instance.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\>$MyAdminModeSetting = New-CrmAdminModeSetting -AllowBackgroundOperations 1
-NotificationText Only administrators and customizers may access this instance while we complete
operational changes -OverrideUserAADObjectId <Guid>; remarks=System.Management.Automation.PSObject[];
title=Example 1}}
inputTypes : @{inputType=@{type=@{name=System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0,
Culture=neutral, PublicKeyToken=b77a5c561934e089]]};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=New-CrmAdminModeSetting; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmAdminModeSetting;
name=New-CrmAdminModeSetting}
description : {@{Text=The New-CrmAdminModeSetting cmdlet defines the object that can be passed to the
Enable-CrmAdminMode and Enable-CrmAdminMode cmdlets to enable or disable administration mode for an
instance of Dynamics 365 Customer Engagement (online).}}
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 : New-CrmAdminModeSetting
Category : Cmdlet
Synopsis : Defines the object that can be passed to the Enable-CrmAdminMode and Disable-CrmAdminMode cmdlets to
enable or disable administration mode for an instance of Dynamics 365 Customer Engagement (online).
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.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> $MyBackupInfo = New-CrmBackupInfo -InstanceId <instanceId> -Label ???????Contoso
SFA 05/11/2017 backup??????? -IsAzureBackup 0 -Notes ???????Daily Contoso sales force automation backup???????;
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=New-CrmBackupInfo; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmBackupInfo;
name=New-CrmBackupInfo}
description : {@{Text=The New-CrmBackupInfo cmdlet defines the object that can be passed to the Backup-CrmInstance
cmdlet to create a system or Azure Storage serviced backup of an instance of Dynamics 365 Customer
Engagement (online). An Azure Storage account is required to use Azure Storage.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Backup-CrmInstance}}
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 : New-CrmBackupInfo
Category : Cmdlet
Synopsis : Defines the object that can be passed to the Backup-CrmInstance cmdlet to create a system or Azure
serviced backup of an instance of Dynamics 365 Customer Engagement (online).
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> New-CrmImportProtectionKey -ApiUrl $connectionhost -Credential $cred -KeyName
$keyName -Key $keyContent -KeyType 0 -KeyPassword $keyPassword;
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=New-CrmImportProtectionKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmImportProtectionKey;
name=New-CrmImportProtectionKey}
description : {@{Text=The New-CrmImportProtectionKey cmdlet add a new protection key}}
relatedLinks : @{navigationLink=@{uri=; linkText=New-CrmImportProtectionKey}}
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 : New-CrmImportProtectionKey
Category : Cmdlet
Synopsis : Import a new protection key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=New-CrmInstance -ApiUrl $connectionhost -NewInstanceInfo $NewCrmInstance -Credential
$cred; remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.NewInstance};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=New-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmInstance;
name=New-CrmInstance}
description : {@{Text=The New-CrmInstance cmdlet provisions (creates) a Dynamics 365 Customer Engagement (online)
instance in your Office 365 tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=New-CrmInstanceInfo}}
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 : New-CrmInstance
Category : Cmdlet
Synopsis : Provisions (creates) a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> $CopyRequestInfo = New-CrmInstanceCopyRequestInfo -FriendlyName "Contoso
production instance" -TargetInstanceId "3c7fa7b4-b93a-4794-8913-6807e0c3aea3" -CopyType "FullCopy";
remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=System.Int32}; description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=New-CrmInstanceCopyRequestInfo; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmInstanceCopyRequestInfo;
name=New-CrmInstanceCopyRequestInfo}
description : {@{Text=The New-CrmInstanceCopyRequestInfo cmdlet creates the object that defines the parameters used
to copy a instance of Dynamics 365 Customer Enagagement (online) by using the Copy-CrmInstance
cmdlet.}}
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 : New-CrmInstanceCopyRequestInfo
Category : Cmdlet
Synopsis : Creates the object that defines the parameters used to copy a instance of Dynamics 365 Customer
Enagagement (online) by using the Copy-CrmInstance cmdlet.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> $NewCrmInstance = New-CrmInstanceInfo -BaseLanguage 1033 -DomainName matptest
-FriendlyName "Contoso production instance" -InitialUserEmail admin@contoso.onmicrosoft.com
-InstanceType Sandbox -ServiceVersionId 31cafafe-c6b1-4c0a-bb53-73927841bc5c -CurrencyCode 840
-CurrencyName USD -CurrencyPrecision 2 -CurrencySymbol $ -Purpose "This is a new production instance
for Contoso."; remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=System.Int32}; description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=System.Management.Automation.PSObject[]}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmInstanceInfo;
name=New-CrmInstanceInfo}
description : {@{Text=The New-CrmInstanceInfo cmdlet creates the object that defines the parameters used to create a
new instance of Dynamics 365 Customer Enagagement (online) by using the New-CrmInstance 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 : New-CrmInstanceInfo
Category : Cmdlet
Synopsis : Creates the object that defines the parameters used to create a new instance of Dynamics 365 Customer
Enagagement (online) by using the New-CrmInstance cmdlet.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> $ResetRequestInfo = New-CrmInstanceResetRequestInfo -BaseLanguage 1033
-DomainName matptest -FriendlyName "Contoso production instance" -CurrencyCode 840 -CurrencyName USD
-CurrencyPrecision 2 -CurrencySymbol $ -Purpose "This is a new production instance for Contoso."
-TargetReleaseName "Dynamics 365, version 9.0"; remarks=System.Management.Automation.PSObject[];
title=Example 1}}
inputTypes : @{inputType=@{type=@{name=System.Int32}; description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=New-CrmInstanceResetRequestInfo;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmInstanceResetRequestInfo;
name=New-CrmInstanceResetRequestInfo}
description : {@{Text=The New-CrmInstanceResetRequestInfo cmdlet creates the object that defines the parameters used
to reset a instance of Dynamics 365 Customer Enagagement (online) by using the Reset-CrmInstance
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 : New-CrmInstanceResetRequestInfo
Category : Cmdlet
Synopsis : Creates the object that defines the parameters used to reset a instance of Dynamics 365 Customer
Enagagement (online) by using the Reset-CrmInstance cmdlet.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=New-CrmManagementApp -AppId <App Id Guid> -Enable -ApiUrl $connectionhost -Credential
$cred; remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.TenantApplicationIdentity};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=System.Management.Automation.PSObject[]}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmManagementApp;
name=New-CrmManagementApp}
description : {@{Text=The New-CrmManagementApp cmdlet registers an Azure Active Directory Web app/API based on the
app Id so it can be used with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.}}
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 : New-CrmManagementApp
Category : Cmdlet
Synopsis : Registers an Azure Active Directory Web app/API to be used with the Microsoft.Xrm.OnlineManagementAPI
PowerShell module.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
SYNTAX
Get-CrmFlights [-ApiUrl] <uri> [[-Credential] <pscredential>] [[-TenantId] <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
-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.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:\\> Get-CrmGenerateProtectionKey -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-CrmGenerateProtectionKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmGenerateProtectionKey;
name=Get-CrmGenerateProtectionKey}
description : {@{Text=The Get-CrmGenerateProtectionKey cmdlet returns a new protection key}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmGenerateProtectionKey}}
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-CrmGenerateProtectionKey
Category : Cmdlet
Synopsis : Returns a new protection key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstance -Id <Guid> -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=Get-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstance;
name=Get-CrmInstance}
description : {@{Text=The Get-CrmInstance cmdlet retrieves a Dynamics 365 Customer Engagement (online) instance in
your Office 365 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-CrmInstance
Category : Cmdlet
Synopsis : Retrieves a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstanceBackup -ApiUrl $connectionhost -InstanceId <instance id>
-RestorePointId <restore point id> -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=Get-CrmInstanceBackup; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstanceBackup;
name=Get-CrmInstanceBackup}
description : {@{Text=The Get-CrmInstanceBackup cmdlet retrieves a Dynamics 365 Customer Engagement (online)
instance backup based on the InstanceId and BackupId parameters.}}
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 : Get-CrmInstanceBackup
Category : Cmdlet
Synopsis : Retrieves a specific Dynamics 365 Customer Engagement (online) instance backup based on the backup id.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstanceBackups -ApiUrl $connectionhost -InstanceId <instanceid>
-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=Get-CrmInstanceBackups; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstanceBackups;
name=Get-CrmInstanceBackups}
description : {@{Text=The Get-CrmInstanceBackups cmdlet retrieves all backups for a Dynamics 365 Customer Engagement
(online) instance.}}
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 : Get-CrmInstanceBackups
Category : Cmdlet
Synopsis : Retrieves all backups for a Dynamics 365 Customer Engagement (online) instance.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstances -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-CrmInstances; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstances;
name=Get-CrmInstances}
description : {@{Text=The Get-CrmInstances cmdlet retrieves details for all Dynamics 365 Customer Engagement
(online) instances that are in your tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmInstance}}
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-CrmInstances
Category : Cmdlet
Synopsis : Retrieves details for Dynamics 365 Customer Engagement (online) instances that are in your tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstanceType -ApiUrl $connectionhost -InstanceType Production
-Credential $cred; remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.InstanceType};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=Get-CrmInstanceType; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstanceType;
name=Get-CrmInstanceType}
description : {@{Text=The Get-CrmInstanceType cmdlet retrieves information about a Dynamics 365 Customer Engagement
(online) instance type.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmInstanceTypes}}
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-CrmInstanceType
Category : Cmdlet
Synopsis : Retrieves information about a Dynamics 365 Customer Engagement (online) instance type.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmInstanceTypes -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-CrmInstanceTypes; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmInstanceTypes;
name=Get-CrmInstanceTypes}
description : {@{Text=The Get-CrmInstanceTypes cmdlet retrieves information about all the instance types available,
such as production, sandbox, support, preview, and trial, in the Dynamics 365 Customer Engagement
(online) tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmInstanceType}}
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-CrmInstanceTypes
Category : Cmdlet
Synopsis : Retrieves information about all the instance types available, such as production, sandbox, support,
preview, and trial, in the Dynamics 365 Customer Engagement (online) tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmLanguages -ApiUrl $connectionhost -Credential $cred -ServiceReleaseId
015e6a5c-2fa5-e411-80ce-00155db07c21; 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=Get-CrmLanguages; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmLanguages;
name=Get-CrmLanguages}
description : {@{Text=The Get-CrmLanguages cmdlet retrieves all languages supported by Dynamics 365 Customer
Enagagement (online) for the specified service release.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmServiceVersions}}
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-CrmLanguages
Category : Cmdlet
Synopsis : Retrieves all languages supported by Dynamics 365 Customer Enagagement (online) for the specified
service release.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-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=Get-CrmManagementApp; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmManagementApp;
name=Get-CrmManagementApp}
description : {@{Text=The Get-CrmManagementApp cmdlet returns the specified registered Azure Active Directory Web
app/API application.}}
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 : Get-CrmManagementApp
Category : Cmdlet
Synopsis : Returns the specified registered Azure Active Directory Web app/API application.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmManagementApps -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-CrmManagementApps; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmManagementApps;
name=Get-CrmManagementApps}
description : {@{Text=The Get-CrmManagementApps cmdlet returns a list of all registered Azure Active Directory Web
app/API applications under the tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmManagementApp}}
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-CrmManagementApps
Category : Cmdlet
Synopsis : Returns a list of all registered Azure Active Directory Web app/API applications under the tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmOperationStatus -Id <OperationIdGuid> -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=Get-CrmOperationStatus; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmOperationStatus;
name=Get-CrmOperationStatus}
description : {@{Text=The Get-CrmOperationStatus retrieves the status of an operation from your Dynamics 365
Customer Engagement (online) instance.}}
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 : Get-CrmOperationStatus
Category : Cmdlet
Synopsis : Retrieves the status for an operation from your Dynamics 365 Customer Engagement (online) instance.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmProtectedInstances -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=Get-CrmProtectedInstances; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmProtectedInstances;
name=Get-CrmProtectedInstances}
description : {@{Text=The Get-CrmProtectedInstances cmdlet retrieves a list of tenant protected instances in your
Office 365 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-CrmProtectedInstances
Category : Cmdlet
Synopsis : Retrieves a list of tenant protected instances in your Office 365 tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmRetrieveAvailableTenantProtectionKeys -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-CrmRetrieveAvailableTenantProtectionKeys;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get;
noun=CrmRetrieveAvailableTenantProtectionKeys; name=Get-CrmRetrieveAvailableTenantProtectionKeys}
description : {@{Text=The Get-CrmRetrieveAvailableTenantProtectionKeys cmdlet returns the available tenant
protection keys}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmRetrieveAvailableTenantProtectionKeys}}
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-CrmRetrieveAvailableTenantProtectionKeys
Category : Cmdlet
Synopsis : Returns the available protection keys for current tenant
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmRetrieveTenantProtectionKey -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-CrmRetrieveTenantProtectionKey;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmRetrieveTenantProtectionKey;
name=Get-CrmRetrieveTenantProtectionKey}
description : {@{Text=The Get-CrmRetrieveTenantProtectionKey cmdlet returns the current tenant protection key}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmRetrieveTenantProtectionKey}}
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-CrmRetrieveTenantProtectionKey
Category : Cmdlet
Synopsis : Returns the current tenant protection key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmServiceVersions -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-CrmServiceVersions; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmServiceVersions;
name=Get-CrmServiceVersions}
description : {@{Text=The Get-CrmServiceVersions cmdlet retrieves information about all currently supported releases
for Dynamics 365 Customer Engagement (online).}}
relatedLinks : @{navigationLink=@{uri=; linkText=Get-CrmLanguages}}
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-CrmServiceVersions
Category : Cmdlet
Synopsis : Retrieves information about all currently supported releases for Dynamics 365 Customer Engagement
(online).
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Get-CrmTemplates -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-CrmTemplates; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Get; noun=CrmTemplates;
name=Get-CrmTemplates}
description : {@{Text=The Get-CrmTemplates cmdlet retrieves a list of application templates supported for
provisioning a Dynamics 365 Customer Engagement (online) instance.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Microsoft.Xrm.OnlineManagementAPI Module}}
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-CrmTemplates
Category : Cmdlet
Synopsis : Retrieves a list of application templates supported for provisioning a Dynamics 365 Customer
Engagement (online) instance.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\>$MyAdminModeSetting = New-CrmAdminModeSetting -AllowBackgroundOperations 1
-NotificationText Only administrators and customizers may access this instance while we complete
operational changes -OverrideUserAADObjectId <Guid>; remarks=System.Management.Automation.PSObject[];
title=Example 1}}
inputTypes : @{inputType=@{type=@{name=System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0,
Culture=neutral, PublicKeyToken=b77a5c561934e089]]};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=New-CrmAdminModeSetting; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmAdminModeSetting;
name=New-CrmAdminModeSetting}
description : {@{Text=The New-CrmAdminModeSetting cmdlet defines the object that can be passed to the
Enable-CrmAdminMode and Enable-CrmAdminMode cmdlets to enable or disable administration mode for an
instance of Dynamics 365 Customer Engagement (online).}}
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 : New-CrmAdminModeSetting
Category : Cmdlet
Synopsis : Defines the object that can be passed to the Enable-CrmAdminMode and Disable-CrmAdminMode cmdlets to
enable or disable administration mode for an instance of Dynamics 365 Customer Engagement (online).
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.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> $MyBackupInfo = New-CrmBackupInfo -InstanceId <instanceId> -Label ???????Contoso
SFA 05/11/2017 backup??????? -IsAzureBackup 0 -Notes ???????Daily Contoso sales force automation backup???????;
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=New-CrmBackupInfo; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmBackupInfo;
name=New-CrmBackupInfo}
description : {@{Text=The New-CrmBackupInfo cmdlet defines the object that can be passed to the Backup-CrmInstance
cmdlet to create a system or Azure Storage serviced backup of an instance of Dynamics 365 Customer
Engagement (online). An Azure Storage account is required to use Azure Storage.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Backup-CrmInstance}}
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 : New-CrmBackupInfo
Category : Cmdlet
Synopsis : Defines the object that can be passed to the Backup-CrmInstance cmdlet to create a system or Azure
serviced backup of an instance of Dynamics 365 Customer Engagement (online).
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> New-CrmImportProtectionKey -ApiUrl $connectionhost -Credential $cred -KeyName
$keyName -Key $keyContent -KeyType 0 -KeyPassword $keyPassword;
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=New-CrmImportProtectionKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmImportProtectionKey;
name=New-CrmImportProtectionKey}
description : {@{Text=The New-CrmImportProtectionKey cmdlet add a new protection key}}
relatedLinks : @{navigationLink=@{uri=; linkText=New-CrmImportProtectionKey}}
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 : New-CrmImportProtectionKey
Category : Cmdlet
Synopsis : Import a new protection key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=New-CrmInstance -ApiUrl $connectionhost -NewInstanceInfo $NewCrmInstance -Credential
$cred; remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.NewInstance};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=New-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmInstance;
name=New-CrmInstance}
description : {@{Text=The New-CrmInstance cmdlet provisions (creates) a Dynamics 365 Customer Engagement (online)
instance in your Office 365 tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=New-CrmInstanceInfo}}
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 : New-CrmInstance
Category : Cmdlet
Synopsis : Provisions (creates) a Dynamics 365 Customer Engagement (online) instance in your Office 365 tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> $CopyRequestInfo = New-CrmInstanceCopyRequestInfo -FriendlyName "Contoso
production instance" -TargetInstanceId "3c7fa7b4-b93a-4794-8913-6807e0c3aea3" -CopyType "FullCopy";
remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=System.Int32}; description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=New-CrmInstanceCopyRequestInfo; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmInstanceCopyRequestInfo;
name=New-CrmInstanceCopyRequestInfo}
description : {@{Text=The New-CrmInstanceCopyRequestInfo cmdlet creates the object that defines the parameters used
to copy a instance of Dynamics 365 Customer Enagagement (online) by using the Copy-CrmInstance
cmdlet.}}
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 : New-CrmInstanceCopyRequestInfo
Category : Cmdlet
Synopsis : Creates the object that defines the parameters used to copy a instance of Dynamics 365 Customer
Enagagement (online) by using the Copy-CrmInstance cmdlet.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> $NewCrmInstance = New-CrmInstanceInfo -BaseLanguage 1033 -DomainName matptest
-FriendlyName "Contoso production instance" -InitialUserEmail admin@contoso.onmicrosoft.com
-InstanceType Sandbox -ServiceVersionId 31cafafe-c6b1-4c0a-bb53-73927841bc5c -CurrencyCode 840
-CurrencyName USD -CurrencyPrecision 2 -CurrencySymbol $ -Purpose "This is a new production instance
for Contoso."; remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=System.Int32}; description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=System.Management.Automation.PSObject[]}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmInstanceInfo;
name=New-CrmInstanceInfo}
description : {@{Text=The New-CrmInstanceInfo cmdlet creates the object that defines the parameters used to create a
new instance of Dynamics 365 Customer Enagagement (online) by using the New-CrmInstance 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 : New-CrmInstanceInfo
Category : Cmdlet
Synopsis : Creates the object that defines the parameters used to create a new instance of Dynamics 365 Customer
Enagagement (online) by using the New-CrmInstance cmdlet.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> $ResetRequestInfo = New-CrmInstanceResetRequestInfo -BaseLanguage 1033
-DomainName matptest -FriendlyName "Contoso production instance" -CurrencyCode 840 -CurrencyName USD
-CurrencyPrecision 2 -CurrencySymbol $ -Purpose "This is a new production instance for Contoso."
-TargetReleaseName "Dynamics 365, version 9.0"; remarks=System.Management.Automation.PSObject[];
title=Example 1}}
inputTypes : @{inputType=@{type=@{name=System.Int32}; description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=New-CrmInstanceResetRequestInfo;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmInstanceResetRequestInfo;
name=New-CrmInstanceResetRequestInfo}
description : {@{Text=The New-CrmInstanceResetRequestInfo cmdlet creates the object that defines the parameters used
to reset a instance of Dynamics 365 Customer Enagagement (online) by using the Reset-CrmInstance
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 : New-CrmInstanceResetRequestInfo
Category : Cmdlet
Synopsis : Creates the object that defines the parameters used to reset a instance of Dynamics 365 Customer
Enagagement (online) by using the Reset-CrmInstance cmdlet.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=New-CrmManagementApp -AppId <App Id Guid> -Enable -ApiUrl $connectionhost -Credential
$cred; remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.TenantApplicationIdentity};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=System.Management.Automation.PSObject[]}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=New; noun=CrmManagementApp;
name=New-CrmManagementApp}
description : {@{Text=The New-CrmManagementApp cmdlet registers an Azure Active Directory Web app/API based on the
app Id so it can be used with the Microsoft.Xrm.OnlineManagementAPI PowerShell module.}}
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 : New-CrmManagementApp
Category : Cmdlet
Synopsis : Registers an Azure Active Directory Web app/API to be used with the Microsoft.Xrm.OnlineManagementAPI
PowerShell module.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI