dedicated_hsms

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

Overview

Name	dedicated_hsms
Type	Resource
Id	azure.hardware_security_modules.dedicated_hsms

Fields

vw_dedicated_hsms

Name	Datatype	Description
name	text	field from the properties object
location	text	The geo-location where the resource lives
management_network_profile	text	field from the properties object
network_profile	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	The resource model definition representing SKU
stamp_id	text	field from the properties object
status_message	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
zones	text	The Dedicated Hsm zones.

dedicated_hsms

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of the dedicated hsm
sku	object	The resource model definition representing SKU
tags	object	Resource tags.
zones	array	The Dedicated Hsm zones.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	name, resourceGroupName, subscriptionId	Gets the specified Azure dedicated HSM.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	The List operation gets information about the dedicated hsms associated with the subscription and within the specified resource group.
list_by_subscription	SELECT	subscriptionId	The List operation gets information about the dedicated HSMs associated with the subscription.
create_or_update	INSERT	name, resourceGroupName, subscriptionId, data__location, data__properties, data__sku	Create or Update a dedicated HSM in the specified subscription.
delete	DELETE	name, resourceGroupName, subscriptionId	Deletes the specified Azure Dedicated HSM.
update	UPDATE	name, resourceGroupName, subscriptionId	Update a dedicated HSM in the specified subscription.

SELECT examples

The List operation gets information about the dedicated HSMs associated with the subscription.

vw_dedicated_hsms

SELECT
name,
location,
management_network_profile,
network_profile,
provisioning_state,
resourceGroupName,
sku,
stamp_id,
status_message,
subscriptionId,
tags,
zones
FROM azure.hardware_security_modules.vw_dedicated_hsms
WHERE subscriptionId = '{{ subscriptionId }}';

dedicated_hsms

SELECT
location,
properties,
sku,
tags,
zones
FROM azure.hardware_security_modules.dedicated_hsms
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.hardware_security_modules.dedicated_hsms (
name,
resourceGroupName,
subscriptionId,
data__location,
data__properties,
data__sku,
sku,
zones,
properties,
tags,
location
)
SELECT 
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ data__properties }}',
'{{ data__sku }}',
'{{ sku }}',
'{{ zones }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: []
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: zones
      value:
        - string
    - name: properties
      value:
        - name: networkProfile
          value:
            - name: subnet
              value:
                - name: resourceId
                  value: string
            - name: networkInterfaces
              value:
                - - name: resourceId
                    value: string
                  - name: privateIpAddress
                    value: string
        - name: stampId
          value: string
        - name: statusMessage
          value: string
        - name: provisioningState
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a dedicated_hsms resource.

/*+ update */
UPDATE azure.hardware_security_modules.dedicated_hsms
SET 
tags = '{{ tags }}'
WHERE 
name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified dedicated_hsms resource.

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