az disk-encryption-set

  • Reference

Disk Encryption Set resource.

Commands

az disk-encryption-set create

Create a disk encryption set.
az disk-encryption-set delete

Delete a disk encryption set.
az disk-encryption-set list

List disk encryption sets.
az disk-encryption-set list-associated-resources

Lists all resources that are encrypted with this disk encryption set.
az disk-encryption-set show

Get information of a disk encryption sets.
az disk-encryption-set update

Update a disk encryption set.

az disk-encryption-set create

Create a disk encryption set.

az disk-encryption-set create --key-url
                              --name
                              --resource-group
                              --source-vault
                              [--encryption-type {EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey}]
                              [--location]
                              [--no-wait]
                              [--subscription]
                              [--tags]

Examples

Create a disk encryption set.

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault

Create a disk encryption set that supports double encryption.

az disk-encryption-set create --resource-group MyResourceGroup --name MyDiskEncryptionSet --key-url MyKey --source-vault MyVault --encryption-type EncryptionAtRestWithPlatformAndCustomerKeys

Required Parameters

--key-url

URL pointing to a key or secret in KeyVault.

--name -n

Name of disk encryption set.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--source-vault

Name or ID of the KeyVault containing the key or secret.

Optional Parameters

--encryption-type

The type of key used to encrypt the data of the disk. EncryptionAtRestWithPlatformKey: Disk is encrypted at rest with Platform managed key. It is the default encryption type. EncryptionAtRestWithCustomerKey: Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. EncryptionAtRestWithPlatformAndCustomerKeys: Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed.

accepted values: EncryptionAtRestWithCustomerKey, EncryptionAtRestWithPlatformAndCustomerKeys, EncryptionAtRestWithPlatformKey
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az disk-encryption-set delete

Delete a disk encryption set.

az disk-encryption-set delete [--ids]
                              [--name]
                              [--resource-group]
                              [--subscription]

Examples

Delete a disk encryption set. (autogenerated)

az disk-encryption-set delete --name MyDiskEncryptionSet --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of disk encryption set.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az disk-encryption-set list

List disk encryption sets.

az disk-encryption-set list [--query-examples]
                            [--resource-group]
                            [--subscription]

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az disk-encryption-set list-associated-resources

Lists all resources that are encrypted with this disk encryption set.

az disk-encryption-set list-associated-resources [--ids]
                                                 [--name]
                                                 [--resource-group]
                                                 [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of disk encryption set.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az disk-encryption-set show

Get information of a disk encryption sets.

az disk-encryption-set show [--ids]
                            [--name]
                            [--query-examples]
                            [--resource-group]
                            [--subscription]

Examples

Get information of a disk encryption sets (autogenerated)

az disk-encryption-set show --name MyDiskEncryptionSet --resource-group MyResourceGroup

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of disk encryption set.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

az disk-encryption-set update

Update a disk encryption set.

az disk-encryption-set update [--add]
                              [--force-string]
                              [--ids]
                              [--key-url]
                              [--name]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--source-vault]
                              [--subscription]

Examples

Update a disk encryption set. (autogenerated)

az disk-encryption-set update --name MyDiskEncryptionSet --resource-group MyResourceGroup --key-url MyKey --source-vault MyVault

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--key-url

URL pointing to a key or secret in KeyVault.

--name -n

Name of disk encryption set.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--source-vault

Name or ID of the KeyVault containing the key or secret.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.