PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}/?api-version=2023-10-02
Creates or updates a disk encryption set
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
diskEncryptionSetName |
String | Yes |
The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. |
subscriptionId |
String | Yes |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
resourceGroupName |
String | Yes |
The name of the resource group. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id |
name |
String | No |
Resource name |
properties |
Object | No | |
properties.autoKeyRotationError |
Object | No |
Api error. |
properties.autoKeyRotationError.message |
String | No |
The error message. |
properties.autoKeyRotationError.target |
String | No |
The target of the particular error. |
properties.autoKeyRotationError.innererror |
Object | No |
Inner error details. |
properties.autoKeyRotationError.innererror.errordetail |
String | No |
The internal error message or exception dump. |
properties.autoKeyRotationError.innererror.exceptiontype |
String | No |
The exception type. |
properties.autoKeyRotationError.code |
String | No |
The error code. |
properties.autoKeyRotationError.details[] |
Array | No |
The Api error details |
properties.autoKeyRotationError.details[].message |
String | No |
The error message. |
properties.autoKeyRotationError.details[].target |
String | No |
The target of the particular error. |
properties.autoKeyRotationError.details[].code |
String | No |
The error code. |
properties.federatedClientId |
String | No |
Multi-tenant application client id to access key vault in a different tenant. Setting the value to 'None' will clear the property. |
properties.previousKeys[] |
Array | No |
A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation. |
properties.previousKeys[].sourceVault |
Object | No |
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} |
properties.previousKeys[].sourceVault.id |
String | No |
Resource Id |
properties.previousKeys[].keyUrl |
String | Yes |
Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. |
properties.provisioningState |
String | No |
The disk encryption set provisioning state. |
properties.rotationToLatestKeyVersionEnabled |
Boolean | No |
Set this flag to true to enable auto-updating of this disk encryption set to the latest key version. |
properties.encryptionType |
String | No |
The type of key used to encrypt the data of the disk. Possible values:
|
properties.lastKeyRotationTimestamp |
String | No |
The time when the active key of this disk encryption set was updated. |
properties.activeKey |
Object | No |
Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots |
properties.activeKey.sourceVault |
Object | No |
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} |
properties.activeKey.sourceVault.id |
String | No |
Resource Id |
properties.activeKey.keyUrl |
String | Yes |
Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. |
location |
String | No |
Resource location |
tags |
Object | No |
Resource tags |
type |
String | No |
Resource type |
identity |
Object | No |
The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. |
identity.tenantId |
String | No |
The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity |
identity.type |
String | No |
The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. Possible values:
|
identity.userAssignedIdentities |
Object | No |
The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
identity.principalId |
String | No |
The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.