MHSM Private Link Resources - List By MHSM Resource
Gets the private link resources supported for the managed hsm pool.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}/privateLinkResources?api-version=2024-11-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
name
|
path | True |
string |
Name of the managed HSM Pool |
|
resource
|
path | True |
string |
Name of the resource group that contains the managed HSM pool. |
|
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
|
api-version
|
query | True |
string |
Client Api Version. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Successfully retrieved private link resources. |
|
| Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
KeyVaultListPrivateLinkResources
Sample request
Sample response
{
"value": [
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateLinkResources/managedhsm",
"name": "managedhsm",
"type": "Microsoft.KeyVault/managedhsms/privateLinkResources",
"properties": {
"groupId": "managedhsms",
"requiredMembers": [
"default"
],
"requiredZoneNames": [
"privatelink.managedhsm.azure.net"
]
}
}
]
}
Definitions
| Name | Description |
|---|---|
|
Cloud |
An error response from Key Vault resource provider |
|
Cloud |
An error response from Key Vault resource provider |
|
identity |
The type of identity that created the key vault resource. |
|
Managed |
SKU details |
|
Managed |
SKU Family of the managed HSM Pool |
|
Managed |
SKU of the managed HSM Pool |
|
Managed |
Managed service identity (system assigned and/or user assigned identities) |
|
Managed |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
|
MHSMPrivate |
A private link resource |
|
MHSMPrivate |
A list of private link resources |
|
System |
Metadata pertaining to creation and last modification of the key vault resource. |
|
User |
User assigned identity properties |
CloudError
An error response from Key Vault resource provider
| Name | Type | Description |
|---|---|---|
| error |
An error response from Key Vault resource provider |
CloudErrorBody
An error response from Key Vault resource provider
| Name | Type | Description |
|---|---|---|
| code |
string |
Error code. This is a mnemonic that can be consumed programmatically. |
| message |
string |
User friendly error message. The message is typically localized and may vary with service version. |
identityType
The type of identity that created the key vault resource.
| Value | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ManagedHsmSku
SKU details
| Name | Type | Description |
|---|---|---|
| family |
SKU Family of the managed HSM Pool |
|
| name |
SKU of the managed HSM Pool |
ManagedHsmSkuFamily
SKU Family of the managed HSM Pool
| Value | Description |
|---|---|
| B | |
| C |
ManagedHsmSkuName
SKU of the managed HSM Pool
| Value | Description |
|---|---|
| Standard_B1 | |
| Custom_B32 | |
| Custom_B6 | |
| Custom_C42 | |
| Custom_C10 |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
| Name | Type | Description |
|---|---|---|
| principalId |
string (uuid) |
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. |
| tenantId |
string (uuid) |
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. |
| type |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
|
| userAssignedIdentities |
<string,
User |
User-Assigned Identities |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
| Value | Description |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned,UserAssigned |
MHSMPrivateLinkResource
A private link resource
| Name | Type | Description |
|---|---|---|
| id |
string |
The Azure Resource Manager resource ID for the managed HSM Pool. |
| identity |
Managed service identity (system assigned and/or user assigned identities) |
|
| location |
string |
The supported Azure location where the managed HSM Pool should be created. |
| name |
string |
The name of the managed HSM Pool. |
| properties.groupId |
string |
Group identifier of private link resource. |
| properties.requiredMembers |
string[] |
Required member names of private link resource. |
| properties.requiredZoneNames |
string[] |
Required DNS zone names of the the private link resource. |
| sku |
SKU details |
|
| systemData |
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. |
MHSMPrivateLinkResourceListResult
A list of private link resources
| Name | Type | Description |
|---|---|---|
| value |
Array of private link resources |
SystemData
Metadata pertaining to creation and last modification of the key vault resource.
| Name | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
The timestamp of the key vault resource creation (UTC). |
| createdBy |
string |
The identity that created the key vault resource. |
| createdByType |
The type of identity that created the key vault resource. |
|
| lastModifiedAt |
string (date-time) |
The timestamp of the key vault resource last modification (UTC). |
| lastModifiedBy |
string |
The identity that last modified the key vault resource. |
| lastModifiedByType |
The type of identity that last modified the key vault resource. |
UserAssignedIdentity
User assigned identity properties
| Name | Type | Description |
|---|---|---|
| clientId |
string (uuid) |
The client ID of the assigned identity. |
| principalId |
string (uuid) |
The principal ID of the assigned identity. |