Share via

Microsoft.KeyVault vaults/privateEndpointConnections

Bicep resource definition

The vaults/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/vaults/privateEndpointConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.KeyVault/vaults/privateEndpointConnections@2024-12-01-preview' = {
  parent: resourceSymbolicName
  etag: 'string'
  name: 'string'
  properties: {
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

Property Values

Microsoft.KeyVault/vaults/privateEndpointConnections

Name Description Value
etag Modified whenever there is a change in the state of private endpoint connection. 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: vaults
properties Resource properties. PrivateEndpointConnectionProperties

PrivateEndpoint

Name Description Value

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Properties of the private endpoint object. PrivateEndpoint
privateLinkServiceConnectionState Approval state of the private link connection. PrivateLinkServiceConnectionState
provisioningState Provisioning state of the private endpoint connection. 'Creating'
'Deleting'
'Disconnected'
'Failed'
'Succeeded'
'Updating'

PrivateLinkServiceConnectionState

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'

ARM template resource definition

The vaults/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/vaults/privateEndpointConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "etag": "string",
  "properties": {
    "privateEndpoint": {
    },
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  }
}

Property Values

Microsoft.KeyVault/vaults/privateEndpointConnections

Name Description Value
apiVersion The api version '2024-12-01-preview'
etag Modified whenever there is a change in the state of private endpoint connection. string
name The resource name string (required)
properties Resource properties. PrivateEndpointConnectionProperties
type The resource type 'Microsoft.KeyVault/vaults/privateEndpointConnections'

PrivateEndpoint

Name Description Value

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Properties of the private endpoint object. PrivateEndpoint
privateLinkServiceConnectionState Approval state of the private link connection. PrivateLinkServiceConnectionState
provisioningState Provisioning state of the private endpoint connection. 'Creating'
'Deleting'
'Disconnected'
'Failed'
'Succeeded'
'Updating'

PrivateLinkServiceConnectionState

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'

Usage Examples

Terraform (AzAPI provider) resource definition

The vaults/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/vaults/privateEndpointConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.KeyVault/vaults/privateEndpointConnections@2024-12-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    etag = "string"
    properties = {
      privateEndpoint = {
      }
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
      provisioningState = "string"
    }
  }
}

Property Values

Microsoft.KeyVault/vaults/privateEndpointConnections

Name Description Value
etag Modified whenever there is a change in the state of private endpoint connection. 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: vaults
properties Resource properties. PrivateEndpointConnectionProperties
type The resource type "Microsoft.KeyVault/vaults/privateEndpointConnections@2024-12-01-preview"

PrivateEndpoint

Name Description Value

PrivateEndpointConnectionProperties

Name Description Value
privateEndpoint Properties of the private endpoint object. PrivateEndpoint
privateLinkServiceConnectionState Approval state of the private link connection. PrivateLinkServiceConnectionState
provisioningState Provisioning state of the private endpoint connection. 'Creating'
'Deleting'
'Disconnected'
'Failed'
'Succeeded'
'Updating'

PrivateLinkServiceConnectionState

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'