Microsoft.KeyVault vaults/privateEndpointConnections
Bicep resource definition
The vaults/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/vaults/privateEndpointConnections resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.KeyVault/vaults/privateEndpointConnections@2023-07-01' = {
name: 'string'
parent: resourceSymbolicName
etag: 'string'
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'None'
description: 'string'
status: 'string'
}
provisioningState: 'string'
}
}
Property values
vaults/privateEndpointConnections
Name | Description | Value |
---|---|---|
name | The resource name See how to set names and types for child resources in Bicep. |
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 |
etag | Modified whenever there is a change in the state of private endpoint connection. | string |
properties | Resource properties. | PrivateEndpointConnectionProperties |
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' |
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 | 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:
- 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/vaults/privateEndpointConnections resource, add the following JSON to your template.
{
"type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
"apiVersion": "2023-07-01",
"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 | 'Microsoft.KeyVault/vaults/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) |
etag | Modified whenever there is a change in the state of private endpoint connection. | string |
properties | Resource properties. | PrivateEndpointConnectionProperties |
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' |
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 | Indicates whether the connection has been approved, rejected or removed by the key vault owner. | 'Approved' 'Disconnected' 'Pending' 'Rejected' |
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@2023-07-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "None"
description = "string"
status = "string"
}
provisioningState = "string"
}
etag = "string"
})
}
Property values
vaults/privateEndpointConnections
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.KeyVault/vaults/privateEndpointConnections@2023-07-01" |
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 |
etag | Modified whenever there is a change in the state of private endpoint connection. | string |
properties | Resource properties. | PrivateEndpointConnectionProperties |
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" |
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 | Indicates whether the connection has been approved, rejected or removed by the key vault owner. | "Approved" "Disconnected" "Pending" "Rejected" |