Microsoft.KeyVault managedHSMs/privateEndpointConnections 2024-11-01

• Latest
• 2024-12-01-preview
• 2024-11-01
• 2024-04-01-preview
• 2023-07-01
• 2023-02-01
• 2022-11-01
• 2022-07-01
• 2022-02-01-preview
• 2021-11-01-preview
• 2021-10-01
• 2021-06-01-preview
• 2021-04-01-preview

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2024-11-01' = {
  parent: resourceSymbolicName
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
  sku: {
    family: 'string'
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

ManagedHsmResourceTags

Name	Description	Value

ManagedHsmSku

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

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

MhsmPrivateEndpoint

Name	Description	Value

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'

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'

Microsoft.KeyVault/managedHSMs/privateEndpointConnections

Name	Description	Value
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
location	The supported Azure location where the managed HSM Pool should be created.	string
name	The resource name	string (required)
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
properties	Resource properties.	MhsmPrivateEndpointConnectionProperties
sku	SKU details	ManagedHsmSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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": "2024-11-01",
  "name": "string",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "privateEndpoint": {
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  },
  "sku": {
    "family": "string",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

ManagedHsmResourceTags

Name	Description	Value

ManagedHsmSku

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

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

MhsmPrivateEndpoint

Name	Description	Value

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'

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'

Microsoft.KeyVault/managedHSMs/privateEndpointConnections

Name	Description	Value
apiVersion	The api version	'2024-11-01'
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
location	The supported Azure location where the managed HSM Pool should be created.	string
name	The resource name	string (required)
properties	Resource properties.	MhsmPrivateEndpointConnectionProperties
sku	SKU details	ManagedHsmSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.KeyVault/managedHSMs/privateEndpointConnections'

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value

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@2024-11-01"
  name = "string"
  etag = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  sku = {
    family = "string"
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      privateEndpoint = {
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
      provisioningState = "string"
    }
  })
}

Property values

ManagedHsmResourceTags

Name	Description	Value

ManagedHsmSku

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

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

MhsmPrivateEndpoint

Name	Description	Value

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'

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'

Microsoft.KeyVault/managedHSMs/privateEndpointConnections

Name	Description	Value
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
location	The supported Azure location where the managed HSM Pool should be created.	string
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: managedHSMs
properties	Resource properties.	MhsmPrivateEndpointConnectionProperties
sku	SKU details	ManagedHsmSku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.KeyVault/managedHSMs/privateEndpointConnections@2024-11-01"

UserAssignedIdentities

Name	Description	Value

UserAssignedIdentity

Name	Description	Value