managed_hsms

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

Overview

Name	managed_hsms
Type	Resource
Id	azure.key_vault.managed_hsms

Fields

vw_managed_hsms

Name	Datatype	Description
id	text	The Azure Resource Manager resource ID for the managed HSM Pool.
name	text	The name of the managed HSM Pool.
create_mode	text	field from the properties object
enable_purge_protection	text	field from the properties object
enable_soft_delete	text	field from the properties object
hsm_uri	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
initial_admin_object_ids	text	field from the properties object
location	text	The supported Azure location where the managed HSM Pool should be created.
network_acls	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
regions	text	field from the properties object
resourceGroupName	text	field from the properties object
scheduled_purge_date	text	field from the properties object
security_domain_properties	text	field from the properties object
sku	text	SKU details
soft_delete_retention_in_days	text	field from the properties object
status_message	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags
tenant_id	text	field from the properties object
type	text	The resource type of the managed HSM Pool.

managed_hsms

Name	Datatype	Description
id	string	The Azure Resource Manager resource ID for the managed HSM Pool.
name	string	The name of the managed HSM Pool.
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The supported Azure location where the managed HSM Pool should be created.
properties	object	Properties of the managed HSM Pool
sku	object	SKU details
systemData	object	Metadata pertaining to creation and last modification of the key vault resource.
tags	object	Resource tags
type	string	The resource type of the managed HSM Pool.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	name, resourceGroupName, subscriptionId	Gets the specified managed HSM Pool.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	The List operation gets information about the managed HSM Pools associated with the subscription and within the specified resource group.
list_by_subscription	SELECT	subscriptionId	The List operation gets information about the managed HSM Pools associated with the subscription.
create_or_update	INSERT	name, resourceGroupName, subscriptionId	Create or update a managed HSM Pool in the specified subscription.
delete	DELETE	name, resourceGroupName, subscriptionId	Deletes the specified managed HSM Pool.
update	UPDATE	name, resourceGroupName, subscriptionId	Update a managed HSM Pool in the specified subscription.
check_mhsm_name_availability	EXEC	subscriptionId, data__name	Checks that the managed hsm name is valid and is not already in use.
purge_deleted	EXEC	location, name, subscriptionId	Permanently deletes the specified managed HSM.

SELECT examples

The List operation gets information about the managed HSM Pools associated with the subscription.

vw_managed_hsms

SELECT
id,
name,
create_mode,
enable_purge_protection,
enable_soft_delete,
hsm_uri,
identity,
initial_admin_object_ids,
location,
network_acls,
private_endpoint_connections,
provisioning_state,
public_network_access,
regions,
resourceGroupName,
scheduled_purge_date,
security_domain_properties,
sku,
soft_delete_retention_in_days,
status_message,
subscriptionId,
system_data,
tags,
tenant_id,
type
FROM azure.key_vault.vw_managed_hsms
WHERE subscriptionId = '{{ subscriptionId }}';

managed_hsms

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.key_vault.managed_hsms
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.key_vault.managed_hsms (
name,
resourceGroupName,
subscriptionId,
properties,
location,
sku,
tags,
systemData,
identity
)
SELECT 
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ location }}',
'{{ sku }}',
'{{ tags }}',
'{{ systemData }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: tenantId
          value: string
        - name: initialAdminObjectIds
          value:
            - string
        - name: hsmUri
          value: string
        - name: enableSoftDelete
          value: boolean
        - name: softDeleteRetentionInDays
          value: integer
        - name: enablePurgeProtection
          value: boolean
        - name: createMode
          value: string
        - name: statusMessage
          value: string
        - name: provisioningState
          value: string
        - name: networkAcls
          value:
            - name: bypass
              value: string
            - name: defaultAction
              value: string
            - name: ipRules
              value:
                - - name: value
                    value: string
            - name: virtualNetworkRules
              value:
                - - name: id
                    value: string
        - name: regions
          value:
            - - name: name
                value: string
              - name: provisioningState
                value: []
              - name: isPrimary
                value: boolean
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: etag
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
        - name: publicNetworkAccess
          value: string
        - name: scheduledPurgeDate
          value: string
        - name: securityDomainProperties
          value:
            - name: activationStatus
              value: string
            - name: activationStatusMessage
              value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: sku
      value:
        - name: family
          value: string
        - name: name
          value: string
    - name: tags
      value: object
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: []
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedAt
          value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []

UPDATE example

Updates a managed_hsms resource.

/*+ update */
UPDATE azure.key_vault.managed_hsms
SET 
properties = '{{ properties }}',
location = '{{ location }}',
sku = '{{ sku }}',
tags = '{{ tags }}',
systemData = '{{ systemData }}',
identity = '{{ identity }}'
WHERE 
name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified managed_hsms resource.

/*+ delete */
DELETE FROM azure.key_vault.managed_hsms
WHERE name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';