< Back
Remove-CrmFlightAudience
Post
NAME Remove-CrmFlightAudience
SYNTAX
Remove-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:\\> Remove-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=Remove-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Remove; noun=CrmInstance;
name=Remove-CrmInstance}
description : {@{Text=The Remove-CrmInstance cmdlet removes (deletes) the specified Dynamics 365 Customer Engagement
(online) instance.}}
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 : Remove-CrmInstance
Category : Cmdlet
Synopsis : Removes (deletes) the specified Dynamics 365 Customer Engagement (online) instance.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Remove-CrmManagementApp -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=Remove-CrmManagementApp; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Remove; noun=CrmManagementApp;
name=Remove-CrmManagementApp}
description : {@{Text=The Remove-CrmManagementApp cmdlet removes the specified registered Azure Active Directory Web
app/API application so it cannot be used with 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 : Remove-CrmManagementApp
Category : Cmdlet
Synopsis : Removes the specified registered Azure Active Directory Web app/API application so it cannot be used
with Microsoft.Xrm.OnlineManagementAPI PowerShell module.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=Reset-CrmInstance -ApiUrl $connectionhost -ResetInstanceRequestDetails
ResetInstanceRequestDetails -Credential $cred -TargetInstanceIdToReset $InstanceId;
remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.ResetRequest};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=Reset-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Reset; noun=CrmInstance;
name=Reset-CrmInstance}
description : {@{Text=The Reset-CrmInstance cmdlet performs a reset operation on a Dynamics 365 Customer Engagement
(online) Sandbox instance in your Office 365 tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=New-CrmInstanceResetRequestInfo}}
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 : Reset-CrmInstance
Category : Cmdlet
Synopsis : Reset a (v9 or higher) Dynamics 365 Customer Engagement (online) sandbox instance in your Office 365
tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Restore-CrmInstance -BackupId <Guid> -SourceInstanceId <Guid>
-TargetInstanceId <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=Restore-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Restore; noun=CrmInstance;
name=Restore-CrmInstance}
description : {@{Text=The Restore-CrmInstance cmdlet restores a Dynamics 365 Customer Engagement (online) instance
from the specified backup and instance restore point ids.}}
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 : Restore-CrmInstance
Category : Cmdlet
Synopsis : Restores a Dynamics 365 Customer Engagement (online) instance from the specified backup and instance
restore point ids.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmLockTenantProtectedInstances -ApiUrl $connectionhost -Credential $cred
-KeyName $keyName; 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=Set-CrmLockTenantProtectedInstances;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Set; noun=CrmLockTenantProtectedInstances;
name=Set-CrmLockTenantProtectedInstances}
description : {@{Text=Set-CrmLockTenantProtectedInstances locks all the instances associated with the tenant}}
relatedLinks : @{navigationLink=@{uri=; linkText=Lock all the instances associated with the tenant}}
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 : Set-CrmLockTenantProtectedInstances
Category : Cmdlet
Synopsis : Lock all the instances associated with the tenant
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmProtectWithMicrosoftKey -ApiUrl $connectionhost -Credential $cred
-InstanceId $InstanceId; 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=Set-CrmProtectWithMicrosoftKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Set; noun=ProtectWithMicrosoftKey;
name=Set-CrmProtectWithMicrosoftKey}
description : {@{Text=The Set-CrmProtectWithMicrosoftKey cmdlet Protects an instance with default microsoft key}}
relatedLinks : @{navigationLink=@{uri=; linkText=Set-CrmProtectWithTenantKey}}
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 : Set-CrmProtectWithMicrosoftKey
Category : Cmdlet
Synopsis : Protects an instance with default Microsoft key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmProtectWithTenantKey -ApiUrl $connecthost -Credential $cred -Verbose
-InstanceId $InstanceId; 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=Set-CrmProtectWithTenantKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Post; noun=CrmProtectWithTenantKey;
name=Set-CrmProtectWithTenantKey}
description : {@{Text=The Set-CrmProtectWithTenantKey cmdlet protects a given instance with the Tenant Key and
returns operation status.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Set-CrmProtectWithMicrosoftKey}}
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 : Set-CrmProtectWithTenantKey
Category : Cmdlet
Synopsis : Protects and Instance with the Tenant Key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmTenantProtectionKey -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=Set-CrmTenantProtectionKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Post; noun=CrmSetTenantProtectionKey;
name=Set-CrmTenantProtectionKey}
description : {@{Text=The Set-CrmTenantProtectionKey cmdlet sets an existing tenant protection key and returns the
operation status.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Set-CrmTenantProtectionKey}}
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 : Set-CrmTenantProtectionKey
Category : Cmdlet
Synopsis : Sets an existing tenant protection key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmUnLockTenantProtectedInstance -ApiUrl $connectionhost -Credential
$cred -InstanceId $InstanceId; 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=Set-CrmUnLockTenantProtectedInstance;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Set;
noun=CrmUnLockTenantProtectedInstance; name=Set-CrmUnLockTenantProtectedInstance}
description : {@{Text=Set-CrmUnLockTenantProtectedInstance unlocks the target instance}}
relatedLinks : @{navigationLink=@{uri=; linkText=Unlock the tenant instance}}
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 : Set-CrmUnLockTenantProtectedInstance
Category : Cmdlet
Synopsis : Unlock the target instance
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
SYNTAX
Remove-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:\\> Remove-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=Remove-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Remove; noun=CrmInstance;
name=Remove-CrmInstance}
description : {@{Text=The Remove-CrmInstance cmdlet removes (deletes) the specified Dynamics 365 Customer Engagement
(online) instance.}}
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 : Remove-CrmInstance
Category : Cmdlet
Synopsis : Removes (deletes) the specified Dynamics 365 Customer Engagement (online) instance.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Remove-CrmManagementApp -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=Remove-CrmManagementApp; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Remove; noun=CrmManagementApp;
name=Remove-CrmManagementApp}
description : {@{Text=The Remove-CrmManagementApp cmdlet removes the specified registered Azure Active Directory Web
app/API application so it cannot be used with 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 : Remove-CrmManagementApp
Category : Cmdlet
Synopsis : Removes the specified registered Azure Active Directory Web app/API application so it cannot be used
with Microsoft.Xrm.OnlineManagementAPI PowerShell module.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=Reset-CrmInstance -ApiUrl $connectionhost -ResetInstanceRequestDetails
ResetInstanceRequestDetails -Credential $cred -TargetInstanceIdToReset $InstanceId;
remarks=System.Management.Automation.PSObject[]; title=Example 1}}
inputTypes : @{inputType=@{type=@{name=Microsoft.Xrm.Services.Admin.Client.Models.ResetRequest};
description=System.Management.Automation.PSObject[]}}
alertSet : @{alert=System.Management.Automation.PSObject[]}
syntax : @{syntaxItem=@{name=Reset-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Reset; noun=CrmInstance;
name=Reset-CrmInstance}
description : {@{Text=The Reset-CrmInstance cmdlet performs a reset operation on a Dynamics 365 Customer Engagement
(online) Sandbox instance in your Office 365 tenant.}}
relatedLinks : @{navigationLink=@{uri=; linkText=New-CrmInstanceResetRequestInfo}}
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 : Reset-CrmInstance
Category : Cmdlet
Synopsis : Reset a (v9 or higher) Dynamics 365 Customer Engagement (online) sandbox instance in your Office 365
tenant.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Restore-CrmInstance -BackupId <Guid> -SourceInstanceId <Guid>
-TargetInstanceId <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=Restore-CrmInstance; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Restore; noun=CrmInstance;
name=Restore-CrmInstance}
description : {@{Text=The Restore-CrmInstance cmdlet restores a Dynamics 365 Customer Engagement (online) instance
from the specified backup and instance restore point ids.}}
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 : Restore-CrmInstance
Category : Cmdlet
Synopsis : Restores a Dynamics 365 Customer Engagement (online) instance from the specified backup and instance
restore point ids.
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmLockTenantProtectedInstances -ApiUrl $connectionhost -Credential $cred
-KeyName $keyName; 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=Set-CrmLockTenantProtectedInstances;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Set; noun=CrmLockTenantProtectedInstances;
name=Set-CrmLockTenantProtectedInstances}
description : {@{Text=Set-CrmLockTenantProtectedInstances locks all the instances associated with the tenant}}
relatedLinks : @{navigationLink=@{uri=; linkText=Lock all the instances associated with the tenant}}
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 : Set-CrmLockTenantProtectedInstances
Category : Cmdlet
Synopsis : Lock all the instances associated with the tenant
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmProtectWithMicrosoftKey -ApiUrl $connectionhost -Credential $cred
-InstanceId $InstanceId; 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=Set-CrmProtectWithMicrosoftKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Set; noun=ProtectWithMicrosoftKey;
name=Set-CrmProtectWithMicrosoftKey}
description : {@{Text=The Set-CrmProtectWithMicrosoftKey cmdlet Protects an instance with default microsoft key}}
relatedLinks : @{navigationLink=@{uri=; linkText=Set-CrmProtectWithTenantKey}}
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 : Set-CrmProtectWithMicrosoftKey
Category : Cmdlet
Synopsis : Protects an instance with default Microsoft key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmProtectWithTenantKey -ApiUrl $connecthost -Credential $cred -Verbose
-InstanceId $InstanceId; 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=Set-CrmProtectWithTenantKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Post; noun=CrmProtectWithTenantKey;
name=Set-CrmProtectWithTenantKey}
description : {@{Text=The Set-CrmProtectWithTenantKey cmdlet protects a given instance with the Tenant Key and
returns operation status.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Set-CrmProtectWithMicrosoftKey}}
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 : Set-CrmProtectWithTenantKey
Category : Cmdlet
Synopsis : Protects and Instance with the Tenant Key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmTenantProtectionKey -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=Set-CrmTenantProtectionKey; parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Post; noun=CrmSetTenantProtectionKey;
name=Set-CrmTenantProtectionKey}
description : {@{Text=The Set-CrmTenantProtectionKey cmdlet sets an existing tenant protection key and returns the
operation status.}}
relatedLinks : @{navigationLink=@{uri=; linkText=Set-CrmTenantProtectionKey}}
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 : Set-CrmTenantProtectionKey
Category : Cmdlet
Synopsis : Sets an existing tenant protection key
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI
examples : @{example=@{code=PS C:\\> Set-CrmUnLockTenantProtectedInstance -ApiUrl $connectionhost -Credential
$cred -InstanceId $InstanceId; 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=Set-CrmUnLockTenantProtectedInstance;
parameter=System.Management.Automation.PSObject[]}}
parameters : @{parameter=System.Management.Automation.PSObject[]}
details : @{description=System.Management.Automation.PSObject[]; verb=Set;
noun=CrmUnLockTenantProtectedInstance; name=Set-CrmUnLockTenantProtectedInstance}
description : {@{Text=Set-CrmUnLockTenantProtectedInstance unlocks the target instance}}
relatedLinks : @{navigationLink=@{uri=; linkText=Unlock the tenant instance}}
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 : Set-CrmUnLockTenantProtectedInstance
Category : Cmdlet
Synopsis : Unlock the target instance
Component :
Role :
Functionality :
PSSnapIn :
ModuleName : Microsoft.Xrm.OnlineManagementAPI