dedicated_hsm

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

Overview

Name	dedicated_hsm
Type	Resource
Id	azure.hardware_security_modules.dedicated_hsm

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
managementNetworkProfile	object	Specifies the management network interfaces of the dedicated hsm.
networkProfile	object	Specifies the network interfaces of the dedicated hsm.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Provisioning", "Allocating", "Connecting", "Failed", "CheckingQuota", and "Deleting". (Succeeded, Provisioning, Allocating, Connecting, Failed, CheckingQuota, Deleting)
sku	object	SKU details. Required.
stampId	string	This field will be used when RP does not support Availability zones.
statusMessage	string	Resource Status Message.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
managementNetworkProfile	object	Specifies the management network interfaces of the dedicated hsm.
networkProfile	object	Specifies the network interfaces of the dedicated hsm.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Provisioning", "Allocating", "Connecting", "Failed", "CheckingQuota", and "Deleting". (Succeeded, Provisioning, Allocating, Connecting, Failed, CheckingQuota, Deleting)
sku	object	SKU details. Required.
stampId	string	This field will be used when RP does not support Availability zones.
statusMessage	string	Resource Status Message.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
managementNetworkProfile	object	Specifies the management network interfaces of the dedicated hsm.
networkProfile	object	Specifies the network interfaces of the dedicated hsm.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Provisioning", "Allocating", "Connecting", "Failed", "CheckingQuota", and "Deleting". (Succeeded, Provisioning, Allocating, Connecting, Failed, CheckingQuota, Deleting)
sku	object	SKU details. Required.
stampId	string	This field will be used when RP does not support Availability zones.
statusMessage	string	Resource Status Message.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, name, subscription_id		Gets the specified Azure dedicated HSM.
list_by_resource_group	select	resource_group_name, subscription_id	$top	The List operation gets information about the dedicated HSMs associated with the subscription and within the specified resource group.
list_by_subscription	select	subscription_id	$top	The List operation gets information about the dedicated HSMs associated with the subscription.
create_or_update	insert	resource_group_name, name, subscription_id, location, sku, properties		Create or Update a dedicated HSM in the specified subscription.
update	update	resource_group_name, name, subscription_id		Update a dedicated HSM in the specified subscription.
create_or_update	replace	resource_group_name, name, subscription_id, location, sku, properties		Create or Update a dedicated HSM in the specified subscription.
delete	delete	resource_group_name, name, subscription_id		Deletes the specified Azure Dedicated HSM.
list_outbound_network_dependencies_endpoints	exec	resource_group_name, name, subscription_id		Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. The operation returns properties of each egress endpoint.

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
name	string	Name of the dedicated Hsm. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	Maximum number of results to return. Default value is None.

SELECT examples

get

Gets the specified Azure dedicated HSM.

SELECT
id,
name,
location,
managementNetworkProfile,
networkProfile,
provisioningState,
sku,
stampId,
statusMessage,
systemData,
tags,
type,
zones
FROM azure.hardware_security_modules.dedicated_hsm
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

The List operation gets information about the dedicated HSMs associated with the subscription and within the specified resource group.

SELECT
id,
name,
location,
managementNetworkProfile,
networkProfile,
provisioningState,
sku,
stampId,
statusMessage,
systemData,
tags,
type,
zones
FROM azure.hardware_security_modules.dedicated_hsm
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

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

SELECT
id,
name,
location,
managementNetworkProfile,
networkProfile,
provisioningState,
sku,
stampId,
statusMessage,
systemData,
tags,
type,
zones
FROM azure.hardware_security_modules.dedicated_hsm
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create or Update a dedicated HSM in the specified subscription.

INSERT INTO azure.hardware_security_modules.dedicated_hsm (
tags,
location,
sku,
zones,
properties,
resource_group_name,
name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ sku }}' /* required */,
'{{ zones }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: dedicated_hsm
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dedicated_hsm resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the dedicated_hsm resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dedicated_hsm resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: sku
    description: |
      SKU details. Required.
    value:
      name: "{{ name }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.
  - name: properties
    description: |
      Properties of the dedicated HSM. Required.
    value:
      networkProfile:
        subnet:
          resourceId: "{{ resourceId }}"
        networkInterfaces:
          - resourceId: "{{ resourceId }}"
            privateIpAddress: "{{ privateIpAddress }}"
      managementNetworkProfile:
        subnet:
          resourceId: "{{ resourceId }}"
        networkInterfaces:
          - resourceId: "{{ resourceId }}"
            privateIpAddress: "{{ privateIpAddress }}"
      stampId: "{{ stampId }}"
      statusMessage: "{{ statusMessage }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a dedicated HSM in the specified subscription.

UPDATE azure.hardware_security_modules.dedicated_hsm
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type,
zones;

REPLACE examples

create_or_update

Create or Update a dedicated HSM in the specified subscription.

REPLACE azure.hardware_security_modules.dedicated_hsm
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
zones = '{{ zones }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND sku = '{{ sku }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
location,
properties,
sku,
systemData,
tags,
type,
zones;

DELETE examples

delete

Deletes the specified Azure Dedicated HSM.

DELETE FROM azure.hardware_security_modules.dedicated_hsm
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND name = '{{ name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_outbound_network_dependencies_endpoints

Gets a list of egress endpoints (network endpoints of all outbound dependencies) in the specified dedicated hsm resource. The operation returns properties of each egress endpoint.

EXEC azure.hardware_security_modules.dedicated_hsm.list_outbound_network_dependencies_endpoints 
@resource_group_name='{{ resource_group_name }}' --required, 
@name='{{ name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;