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

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. Known values are: "Preprovisioning", "Provisioning", "Succeeded", "Failed", "Deleting", and "Cleanup". (Preprovisioning, Provisioning, Succeeded, Failed, Deleting, Cleanup)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_resource	select	resource_group_name, name, subscription_id		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	The name of the managed HSM Pool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

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 resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;