Set-CrmProtectWithMicrosoftKey

  • Reference
Module:
Microsoft.Xrm.OnlineManagementAPI

[This topic is pre-release documentation and is subject to change.]

Protects an environment with the default Microsoft key.

Syntax

Set-CrmProtectWithMicrosoftKey
   -InstanceId <Guid>
   [-ApiUrl] <Uri>
   [[-Credential] <PSCredential>]
   [-MaxCrmConnectionTimeOutMinutes <Int32>]
   [<CommonParameters>]

Description

The Set-CrmProtectWithMicrosoftKey cmdlet protects an environment by using the default Microsoft key.

Examples

Example 1

PS C:\> Set-CrmProtectWithMicrosoftKey -ApiUrl $connectionhost -Credential $cred -InstanceId $InstanceId

Protects the environment specified by using the Microsoft default protection key.

Parameters

-ApiUrl

URL of the Admin API root service endpoint. For information about this parameter see Establish your credentials and connection.

Type:Uri
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Credential

User credential for signing in to Dataverse. For information about this parameter see Establish your credentials and connection.

Type:PSCredential
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InstanceId

Id of the environment to protect.

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-MaxCrmConnectionTimeOutMinutes

Maximum number in minutes to wait before quitting the operation.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

System.Uri

System.Management.Automation.PSCredential System.Int32

Outputs

System.Object