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
Successfully retrieved private link resources.
Name | Datatype | Description |
---|---|---|
id | string | The Azure Resource Manager resource ID for the managed HSM Pool. |
name | string | The name of the managed HSM Pool. |
identity | object | Managed service identity (system assigned and/or user assigned identities) |
location | string | The supported Azure location where the managed HSM Pool should be created. |
properties | object | Resource properties. |
sku | object | SKU details |
systemData | object | Metadata pertaining to creation and last modification of the key vault resource. |
tags | object | Resource tags |
type | string | The resource type of the managed HSM Pool. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list_by_mhsm_resource | select | subscriptionId , resourceGroupName , name | 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 | 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_mhsm_resource
Gets the private link resources supported for the managed hsm pool.
SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.key_vault.mhsm_private_link_resources
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
;