disk_encryption_sets

Creates, updates, deletes, gets or lists a disk_encryption_sets resource.

Overview

Name	disk_encryption_sets
Type	Resource
Id	azure.compute.disk_encryption_sets

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
identity	object	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.
location	string	Resource location
properties	object
tags	object	Resource tags
type	string	Resource type

list_by_resource_group

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
identity	object	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.
location	string	Resource location
properties	object
tags	object	Resource tags
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
identity	object	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.
location	string	Resource location
properties	object
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, diskEncryptionSetName		Gets information about a disk encryption set.
list_by_resource_group	select	subscriptionId, resourceGroupName		Lists all the disk encryption sets under a resource group.
list	select	subscriptionId		Lists all the disk encryption sets under a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, diskEncryptionSetName		Creates or updates a disk encryption set
update	update	subscriptionId, resourceGroupName, diskEncryptionSetName		Updates (patches) a disk encryption set.
delete	delete	subscriptionId, resourceGroupName, diskEncryptionSetName		Deletes a disk encryption set.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
diskEncryptionSetName	string	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.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets information about a disk encryption set.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.compute.disk_encryption_sets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND diskEncryptionSetName = '{{ diskEncryptionSetName }}' -- required
;

list_by_resource_group

Lists all the disk encryption sets under a resource group.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.compute.disk_encryption_sets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

Lists all the disk encryption sets under a subscription.

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.compute.disk_encryption_sets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a disk encryption set

INSERT INTO azure.compute.disk_encryption_sets (
data__identity,
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
diskEncryptionSetName
)
SELECT 
'{{ identity }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ diskEncryptionSetName }}'
RETURNING
id,
name,
identity,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: disk_encryption_sets
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the disk_encryption_sets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the disk_encryption_sets resource.
    - name: diskEncryptionSetName
      value: string
      description: Required parameter for the disk_encryption_sets resource.
    - name: identity
      value: object
      description: |
        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.
    - name: properties
      value: object
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

Updates (patches) a disk encryption set.

UPDATE azure.compute.disk_encryption_sets
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND diskEncryptionSetName = '{{ diskEncryptionSetName }}' --required
RETURNING
id,
name,
identity,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes a disk encryption set.

DELETE FROM azure.compute.disk_encryption_sets
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND diskEncryptionSetName = '{{ diskEncryptionSetName }}' --required
;