Share via

Microsoft.KeyVault managedHSMs/privateEndpointConnections

  • Article

Bicep resource definition

The managedHSMs/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2023-07-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    family: 'B'
    name: 'string'
  }
  parent: resourceSymbolicName
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionsRequired: 'None'
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

Property values

managedHSMs/privateEndpointConnections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 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
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: managedHSMs
etag Modified whenever there is a change in the state of private endpoint connection. string
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
properties Resource properties. MhsmPrivateEndpointConnectionProperties

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. UserAssignedIdentities

UserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

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

MhsmPrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Properties of the private endpoint object. MhsmPrivateEndpoint
privateLinkServiceConnectionState Approval state of the private link connection. MhsmPrivateLinkServiceConnectionState
provisioningState Provisioning state of the private endpoint connection. '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 Indicates whether the connection has been approved, rejected or removed by the key vault owner. 'Approved'
'Disconnected'
'Pending'
'Rejected'

ManagedHsmSku

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

ARM template resource definition

The managedHSMs/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.KeyVault/managedHSMs/privateEndpointConnections",
  "apiVersion": "2023-07-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "family": "B",
    "name": "string"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "privateEndpoint": {},
    "privateLinkServiceConnectionState": {
      "actionsRequired": "None",
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  }
}

Property values

managedHSMs/privateEndpointConnections

Name Description Value
type The resource type 'Microsoft.KeyVault/managedHSMs/privateEndpointConnections'
apiVersion The resource api version '2023-07-01'
name The resource name

See how to set names and types for child resources in 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
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
properties Resource properties. MhsmPrivateEndpointConnectionProperties

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (required)
userAssignedIdentities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. UserAssignedIdentities

UserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

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

MhsmPrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Properties of the private endpoint object. MhsmPrivateEndpoint
privateLinkServiceConnectionState Approval state of the private link connection. MhsmPrivateLinkServiceConnectionState
provisioningState Provisioning state of the private endpoint connection. '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 Indicates whether the connection has been approved, rejected or removed by the key vault owner. 'Approved'
'Disconnected'
'Pending'
'Rejected'

ManagedHsmSku

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

Terraform (AzAPI provider) resource definition

The managedHSMs/privateEndpointConnections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2023-07-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      privateEndpoint = {}
      privateLinkServiceConnectionState = {
        actionsRequired = "None"
        description = "string"
        status = "string"
      }
      provisioningState = "string"
    }
    sku = {
      family = "B"
      name = "string"
    }
    etag = "string"
  })
}

Property values

managedHSMs/privateEndpointConnections

Name Description Value
type The resource type "Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2023-07-01"
name The resource name string (required)
location The supported Azure location where the managed HSM Pool should be created. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: managedHSMs
tags Resource tags Dictionary of tag names and values.
sku SKU details ManagedHsmSku
etag Modified whenever there is a change in the state of private endpoint connection. string
identity Managed service identity (system assigned and/or user assigned identities) ManagedServiceIdentity
properties Resource properties. MhsmPrivateEndpointConnectionProperties

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (required)
identity_ids The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. Array of user identity IDs.

UserAssignedIdentities

Name Description Value
{customized property} UserAssignedIdentity

UserAssignedIdentity

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

MhsmPrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Properties of the private endpoint object. MhsmPrivateEndpoint
privateLinkServiceConnectionState Approval state of the private link connection. MhsmPrivateLinkServiceConnectionState
provisioningState Provisioning state of the private endpoint connection. "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 Indicates whether the connection has been approved, rejected or removed by the key vault owner. "Approved"
"Disconnected"
"Pending"
"Rejected"

ManagedHsmSku

Name Description Value
family SKU Family of the managed HSM Pool "B" (required)
name SKU of the managed HSM Pool "Custom_B32"
"Custom_B6"
"Standard_B1" (required)