Set-CrmTenantProtectionKey
[This topic is pre-release documentation and is subject to change.]
Sets your tenant’s active database encryption key using your imported certificate. This command kicks off the process to set the key and will return a response status of either Installing or Failed.
Syntax
Set-CrmTenantProtectionKey
-KeyName <String>
[-ApiUrl] <Uri>
[[-Credential] <PSCredential>]
[-MaxCrmConnectionTimeOutMinutes <Int32>]
[<CommonParameters>] Description
The Set-CrmTenantProtectionKey cmdlet sets an existing tenant protection key and returns the operation status.
Examples
Example 1
PS C:\> Set-CrmTenantProtectionKey -ApiUrl $connectionhost -Credential $credReturns an 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 |
-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.Uri
Outputs
System.Object