Microsoft.KeyVault vaults/privateEndpointConnections

Template format

To create a Microsoft.KeyVault/vaults/privateEndpointConnections resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
  "apiVersion": "2019-09-01",
  "properties": {
    "privateEndpoint": {},
    "privateLinkServiceConnectionState": {
      "status": "string",
      "description": "string",
      "actionRequired": "string"
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.KeyVault/vaults/privateEndpointConnections object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes Name of the private endpoint connection associated with the key vault.
type enum Yes For JSON -privateEndpointConnections
-or-
Microsoft.KeyVault/vaults/privateEndpointConnections

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2019-09-01
properties object Yes Resource properties. - PrivateEndpointConnectionProperties object

PrivateEndpointConnectionProperties object

Name Type Required Value
privateEndpoint object No Properties of the private endpoint object. - PrivateEndpoint object
privateLinkServiceConnectionState object No Approval state of the private link connection. - PrivateLinkServiceConnectionState object

PrivateLinkServiceConnectionState object

Name Type Required Value
status enum No Indicates whether the connection has been approved, rejected or removed by the key vault owner. - Pending, Approved, Rejected, Disconnected
description string No The reason for approval or rejection.
actionRequired string No A message indicating if changes on the service provider require any updates on the consumer.