Set-CrmProtectWithTenantKey

Reference

Module:: Microsoft.Xrm.OnlineManagementAPI

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

Protects an environment with the tenant key.

Syntax

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

Description

The Set-CrmProtectWithTenantKey cmdlet protects a given environment with the tenant key and returns the operation status.

Examples

Example 1

PS C:\> Set-CrmProtectWithTenantKey -ApiUrl $connecthost -Credential $cred -Verbose -InstanceId $InstanceId

Triggers the protection of the environment and returns the operation status.

Parameters

-ApiUrl

URL of the Dataverse 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

Tenant environment Id.

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

Share via