Private Endpoint Connections - Delete
Deletes the specified private endpoint connection associated with the key vault.
DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-07-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
private
|
path | True |
string |
Name of the private endpoint connection associated with the key vault. |
resource
|
path | True |
string |
Name of the resource group that contains the key vault. |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
vault
|
path | True |
string |
The name of the key vault. Regex pattern: |
api-version
|
query | True |
string |
Client Api Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The private endpoint connection was successfully deleted. |
|
202 Accepted |
The private endpoint connection is being deleted. Headers
|
|
204 No Content |
The private endpoint connection does not exist. |
|
Other Status Codes |
Error response describing why the operation failed. |
Examples
KeyVaultDeletePrivateEndpointConnection
Sample Request
Sample Response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec",
"name": "sample-pec",
"type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
"properties": {
"provisioningState": "Disconnected"
}
}
Retry-After: 60
Location: https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec?operationid=25334578
Definitions
Name | Description |
---|---|
Actions |
A message indicating if changes on the service provider require any updates on the consumer. |
Cloud |
An error response from Key Vault resource provider |
Cloud |
An error response from Key Vault resource provider |
Private |
Private endpoint object properties. |
Private |
Private endpoint connection resource. |
Private |
The current provisioning state. |
Private |
The private endpoint connection status. |
Private |
An object that represents the approval state of the private link connection. |
ActionsRequired
A message indicating if changes on the service provider require any updates on the consumer.
Name | Type | Description |
---|---|---|
None |
string |
CloudError
An error response from Key Vault resource provider
Name | Type | Description |
---|---|---|
error |
An error response from Key Vault resource provider |
CloudErrorBody
An error response from Key Vault resource provider
Name | Type | Description |
---|---|---|
code |
string |
Error code. This is a mnemonic that can be consumed programmatically. |
message |
string |
User friendly error message. The message is typically localized and may vary with service version. |
PrivateEndpoint
Private endpoint object properties.
Name | Type | Description |
---|---|---|
id |
string |
Full identifier of the private endpoint resource. |
PrivateEndpointConnection
Private endpoint connection resource.
Name | Type | Description |
---|---|---|
etag |
string |
Modified whenever there is a change in the state of private endpoint connection. |
id |
string |
Fully qualified identifier of the key vault resource. |
location |
string |
Azure location of the key vault resource. |
name |
string |
Name of the key vault resource. |
properties.privateEndpoint |
Properties of the private endpoint object. |
|
properties.privateLinkServiceConnectionState |
Approval state of the private link connection. |
|
properties.provisioningState |
Provisioning state of the private endpoint connection. |
|
tags |
object |
Tags assigned to the key vault resource. |
type |
string |
Resource type of the key vault resource. |
PrivateEndpointConnectionProvisioningState
The current provisioning state.
Name | Type | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Disconnected |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
PrivateEndpointServiceConnectionStatus
The private endpoint connection status.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PrivateLinkServiceConnectionState
An object that represents the approval state of the private link connection.
Name | Type | Description |
---|---|---|
actionsRequired |
A message indicating if changes on the service provider require any updates on the consumer. |
|
description |
string |
The reason for approval or rejection. |
status |
Indicates whether the connection has been approved, rejected or removed by the key vault owner. |