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=2022-07-01

URI Parameters

Name In Required Type Description
name
path True

string

Name of the managed HSM Pool

resourceGroupName
path True

string

Name of the resource group that contains the managed HSM pool.

subscriptionId
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

MHSMPrivateLinkResourceListResult

Successfully retrieved private link resources.

Other Status Codes

CloudError

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

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/privateLinkResources?api-version=2022-07-01

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
CloudError

An error response from Key Vault resource provider

CloudErrorBody

An error response from Key Vault resource provider

identityType

The type of identity that created the key vault resource.

ManagedHsmSku

SKU details

ManagedHsmSkuFamily

SKU Family of the managed HSM Pool

ManagedHsmSkuName

SKU of the managed HSM Pool

MHSMPrivateLinkResource

A private link resource

MHSMPrivateLinkResourceListResult

A list of private link resources

SystemData

Metadata pertaining to creation and last modification of the key vault resource.

CloudError

An error response from Key Vault resource provider

Name Type Description
error

CloudErrorBody

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.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ManagedHsmSku

SKU details

Name Type Description
family

ManagedHsmSkuFamily

SKU Family of the managed HSM Pool

name

ManagedHsmSkuName

SKU of the managed HSM Pool

ManagedHsmSkuFamily

SKU Family of the managed HSM Pool

Name Type Description
B

string

ManagedHsmSkuName

SKU of the managed HSM Pool

Name Type Description
Custom_B32

string

Custom_B6

string

Standard_B1

string

MHSMPrivateLinkResource

A private link resource

Name Type Description
id

string

The Azure Resource Manager resource ID for the managed HSM Pool.

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

ManagedHsmSku

SKU details

systemData

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

MHSMPrivateLinkResource[]

Array of private link resources

SystemData

Metadata pertaining to creation and last modification of the key vault resource.

Name Type Description
createdAt

string

The timestamp of the key vault resource creation (UTC).

createdBy

string

The identity that created the key vault resource.

createdByType

identityType

The type of identity that created the key vault resource.

lastModifiedAt

string

The timestamp of the key vault resource last modification (UTC).

lastModifiedBy

string

The identity that last modified the key vault resource.

lastModifiedByType

identityType

The type of identity that last modified the key vault resource.