Private Endpoint Connections - Delete

Reference

Service:: Key Vault

API Version:: 2022-07-01

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
privateEndpointConnectionName	path	True	string	Name of the private endpoint connection associated with the key vault.
resourceGroupName	path	True	string	Name of the resource group that contains the key vault.
subscriptionId	path	True	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vaultName	path	True	string	The name of the key vault. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	PrivateEndpointConnection	The private endpoint connection was successfully deleted.
202 Accepted		The private endpoint connection is being deleted. Headers Retry-After: integer Location: string
204 No Content		The private endpoint connection does not exist.
Other Status Codes	CloudError	Error response describing why the operation failed.

Examples

KeyVaultDeletePrivateEndpointConnection

DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec?api-version=2022-07-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python delete_private_endpoint_connection.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.private_endpoint_connections.begin_delete(
        resource_group_name="sample-group",
        vault_name="sample-vault",
        private_endpoint_connection_name="sample-pec",
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/deletePrivateEndpointConnection.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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"
  }
}

Status code:: 202

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

Status code:: 204

Definitions

Name	Description
ActionsRequired	A message indicating if changes on the service provider require any updates on the consumer.
CloudError	An error response from Key Vault resource provider
CloudErrorBody	An error response from Key Vault resource provider
PrivateEndpoint	Private endpoint object properties.
PrivateEndpointConnection	Private endpoint connection resource.
PrivateEndpointConnectionProvisioningState	The current provisioning state.
PrivateEndpointServiceConnectionStatus	The private endpoint connection status.
PrivateLinkServiceConnectionState	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	CloudErrorBody	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	PrivateEndpoint	Properties of the private endpoint object.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Approval state of the private link connection.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	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	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	PrivateEndpointServiceConnectionStatus	Indicates whether the connection has been approved, rejected or removed by the key vault owner.