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

The following fields are returned by SELECT queries:

get

Retrieved dedicated HSM

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

list_by_resource_group

Get information about all dedicated HSMs in the specified resource group.

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

list_by_subscription

Get information about all dedicated HSMs in the specified subscription.

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

Methods

The following methods are available for this resource:

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

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$top	integer (int32)	Maximum number of results to return.

SELECT examples

get

Gets the specified Azure dedicated HSM.

SELECT
location,
properties,
sku,
tags,
zones
FROM azure.hardware_security_modules.dedicated_hsms
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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
location,
properties,
sku,
tags,
zones
FROM azure.hardware_security_modules.dedicated_hsms
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $top = '{{ $top }}'
;

list_by_subscription

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

SELECT
location,
properties,
sku,
tags,
zones
FROM azure.hardware_security_modules.dedicated_hsms
WHERE subscriptionId = '{{ subscriptionId }}' -- 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_hsms (
data__sku,
data__zones,
data__properties,
data__tags,
data__location,
resourceGroupName,
name,
subscriptionId
)
SELECT 
'{{ sku }}' /* required */,
'{{ zones }}',
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}' /* required */,
'{{ resourceGroupName }}',
'{{ name }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
sku,
tags,
zones
;

Manifest

# Description fields are for documentation purposes
- name: dedicated_hsms
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the dedicated_hsms resource.
    - name: name
      value: string
      description: Required parameter for the dedicated_hsms resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the dedicated_hsms resource.
    - name: sku
      value: object
      description: |
        SKU details
    - name: zones
      value: array
      description: |
        The Dedicated Hsm zones.
    - name: properties
      value: object
      description: |
        Properties of the dedicated HSM
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a dedicated HSM in the specified subscription.

UPDATE azure.hardware_security_modules.dedicated_hsms
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
sku,
tags,
zones;

DELETE examples

delete

Deletes the specified Azure Dedicated HSM.

DELETE FROM azure.hardware_security_modules.dedicated_hsms
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;