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

vw_disk_encryption_sets

Name	Datatype	Description
id	text	Resource Id
name	text	Resource name
active_key	text	field from the properties object
auto_key_rotation_error	text	field from the properties object
diskEncryptionSetName	text	field from the properties object
encryption_type	text	field from the properties object
federated_client_id	text	field from the properties object
identity	text	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.
last_key_rotation_timestamp	text	field from the properties object
location	text	Resource location
previous_keys	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
rotation_to_latest_key_version_enabled	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags
type	text	Resource type

disk_encryption_sets

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

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

SELECT examples

Lists all the disk encryption sets under a subscription.

vw_disk_encryption_sets

SELECT
id,
name,
active_key,
auto_key_rotation_error,
diskEncryptionSetName,
encryption_type,
federated_client_id,
identity,
last_key_rotation_timestamp,
location,
previous_keys,
provisioning_state,
resourceGroupName,
rotation_to_latest_key_version_enabled,
subscriptionId,
tags,
type
FROM azure.compute.vw_disk_encryption_sets
WHERE subscriptionId = '{{ subscriptionId }}';

disk_encryption_sets

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

INSERT example

Use the following StackQL query and manifest file to create a new disk_encryption_sets resource.

All Properties

/*+ create */
INSERT INTO azure.compute.disk_encryption_sets (
diskEncryptionSetName,
resourceGroupName,
subscriptionId,
identity,
properties,
location,
tags
)
SELECT 
'{{ diskEncryptionSetName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ identity }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: identity
      value:
        - name: type
          value: string
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: userAssignedIdentities
          value: []
    - name: properties
      value:
        - name: encryptionType
          value: []
        - name: activeKey
          value:
            - name: sourceVault
              value:
                - name: id
                  value: string
            - name: keyUrl
              value: string
        - name: previousKeys
          value:
            - - name: keyUrl
                value: string
        - name: provisioningState
          value: string
        - name: rotationToLatestKeyVersionEnabled
          value: boolean
        - name: lastKeyRotationTimestamp
          value: string
        - name: autoKeyRotationError
          value:
            - name: details
              value:
                - - name: code
                    value: string
                  - name: target
                    value: string
                  - name: message
                    value: string
            - name: innererror
              value:
                - name: exceptiontype
                  value: string
                - name: errordetail
                  value: string
            - name: code
              value: string
            - name: target
              value: string
            - name: message
              value: string
        - name: federatedClientId
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

UPDATE example

Updates a disk_encryption_sets resource.

/*+ update */
UPDATE azure.compute.disk_encryption_sets
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
diskEncryptionSetName = '{{ diskEncryptionSetName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified disk_encryption_sets resource.

/*+ delete */
DELETE FROM azure.compute.disk_encryption_sets
WHERE diskEncryptionSetName = '{{ diskEncryptionSetName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';