Microsoft.KeyVault managedHSMs/privateEndpointConnections 2021-04-01-preview

The managedHSMs/privateEndpointConnections resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.KeyVault/managedHSMs/privateEndpointConnections resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2021-04-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    family: 'B'
    name: 'string'
  }
  etag: 'string'
  properties: {
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionsRequired: 'None'
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

Property values

managedHSMs/privateEndpointConnections

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.KeyVault/managedHSMs/privateEndpointConnections'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-04-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
location The supported Azure location where the managed HSM Pool should be created. string
tags Resource tags Dictionary of tag names and values. See Tags in templates
sku SKU details ManagedHsmSku
etag Modified whenever there is a change in the state of private endpoint connection. string
properties Properties of the private endpoint connection resource. MhsmPrivateEndpointConnectionProperties

MhsmPrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Private endpoint object properties. MhsmPrivateEndpoint
privateLinkServiceConnectionState An object that represents the approval state of the private link connection. MhsmPrivateLinkServiceConnectionState
provisioningState The current provisioning state. 'Creating'
'Deleting'
'Disconnected'
'Failed'
'Succeeded'
'Updating'

MhsmPrivateEndpoint

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

MhsmPrivateLinkServiceConnectionState

Name Description Value
actionsRequired A message indicating if changes on the service provider require any updates on the consumer. 'None'
description The reason for approval or rejection. string
status The private endpoint connection status. 'Approved'
'Disconnected'
'Pending'
'Rejected'

ManagedHsmSku

Name Description Value
family SKU Family of the managed HSM Pool 'B'
name SKU of the managed HSM Pool 'Custom_B32'
'Standard_B1'