Set-CrmLockTenantProtectedInstances

  • Reference
Module:
Microsoft.Xrm.OnlineManagementAPI

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

Locks all the environnments associated with the tenant.

!WARNING Locking the encryption for the tenant disables all the environments that are in the tenant. All locked environments remain inaccessible to everyone, including Microsoft, until a tenant administrator in your organization unlocks it by using the key that was used to lock it.

Syntax

Set-CrmLockTenantProtectedInstances
   -KeyName <String>
   [-ApiUrl] <Uri>
   [[-Credential] <PSCredential>]
   [-MaxCrmConnectionTimeOutMinutes <Int32>]
   [<CommonParameters>]

Description

The Set-CrmLockTenantProtectedInstances cmdlet locks all the environments associated with the tenant.

Examples

Example 1

PS C:\> Set-CrmLockTenantProtectedInstances -ApiUrl $connectionhost -Credential $cred -KeyName $keyName

Locks all the environments associated with the tenant.

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

-KeyName

Name for the protection key.

Type:String
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