mhsm_private_link_resources

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

Overview

Name	mhsm_private_link_resources
Type	Resource
Id	azure.key_vault.mhsm_private_link_resources

Fields

The following fields are returned by SELECT queries:

list_by_mhsm_resource

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.
groupId	string	Group identifier of private link resource.
identity	object	Managed service identity (system assigned and/or user assigned identities).
location	string	The geo-location where the resource lives. Required.
requiredMembers	array	Required member names of private link resource.
requiredZoneNames	array	Required DNS zone names of the the private link resource.
sku	object	SKU details.
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_mhsm_resource	select	resource_group_name, name, subscription_id		Gets the private link resources supported for 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_mhsm_resource

Gets the private link resources supported for the managed hsm pool.

SELECT
id,
name,
groupId,
identity,
location,
requiredMembers,
requiredZoneNames,
sku,
systemData,
tags,
type
FROM azure.key_vault.mhsm_private_link_resources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND name = '{{ name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;