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

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

resource symbolicname 'Microsoft.KeyVault/vaults/privateEndpointConnections@2021-04-01-preview' = {
  name: 'string'
  etag: 'string'
  properties: {
    privateEndpoint: {}
    privateLinkServiceConnectionState: {
      actionsRequired: 'None'
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

Property values

vaults/privateEndpointConnections

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.KeyVault/vaults/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)
etag Modified whenever there is a change in the state of private endpoint connection. string
properties Properties of the private endpoint connection resource. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateEndpoint

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

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 The private endpoint connection status. 'Approved'
'Disconnected'
'Pending'
'Rejected'