mhsm_regions

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

Overview

Name	mhsm_regions
Type	Resource
Id	azure.key_vault.mhsm_regions

Fields

The following fields are returned by SELECT queries:

list_by_resource

Get information about all managed HSM Pools in the specified subscription.

Name	Datatype	Description
name	string	Name of the geo replicated region.
isPrimary	boolean	A boolean value that indicates whether the region is the primary region or a secondary region.
provisioningState	string	Provisioning state of the geo replicated region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource	select	subscriptionId, resourceGroupName, name		The List operation gets information about the regions associated with the managed HSM Pool.

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 managed HSM Pool
resourceGroupName	string	Name of the resource group that contains the managed HSM pool.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

list_by_resource

The List operation gets information about the regions associated with the managed HSM Pool.

SELECT
name,
isPrimary,
provisioningState
FROM azure.key_vault.mhsm_regions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
;