Private Endpoint Connections - Delete

Başvuru

Service:: Key Vault

API Version:: 2022-07-01

Anahtar kasasıyla ilişkili belirtilen özel uç nokta bağlantısını siler.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-07-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
privateEndpointConnectionName	path	True	string	Anahtar kasasıyla ilişkili özel uç nokta bağlantısının adı.
resourceGroupName	path	True	string	Anahtar kasasını içeren kaynak grubunun adı.
subscriptionId	path	True	string	Microsoft Azure aboneliğini benzersiz olarak tanımlayan abonelik kimlik bilgileri. Abonelik kimliği, her hizmet çağrısı için URI'nin bir parçasını oluşturur.
vaultName	path	True	string	Anahtar kasasının adı. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	İstemci Api Sürümü.

Yanıtlar

Name	Tür	Description
200 OK	PrivateEndpointConnection	Özel uç nokta bağlantısı başarıyla silindi.
202 Accepted		Özel uç nokta bağlantısı siliniyor. Headers Retry-After: integer Location: string
204 No Content		Özel uç nokta bağlantısı yok.
Other Status Codes	CloudError	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Örnekler

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

Tanımlar

Name	Description
ActionsRequired	Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.
CloudError	Key Vault kaynak sağlayıcısından hata yanıtı
CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı
PrivateEndpoint	Özel uç nokta nesne özellikleri.
PrivateEndpointConnection	Özel uç nokta bağlantı kaynağı.
PrivateEndpointConnectionProvisioningState	Geçerli sağlama durumu.
PrivateEndpointServiceConnectionStatus	Özel uç nokta bağlantı durumu.
PrivateLinkServiceConnectionState	Özel bağlantı bağlantısının onay durumunu temsil eden bir nesne.

ActionsRequired

Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.

Name	Tür	Description
None	string

CloudError

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
error	CloudErrorBody	Key Vault kaynak sağlayıcısından hata yanıtı

CloudErrorBody

Key Vault kaynak sağlayıcısından hata yanıtı

Name	Tür	Description
code	string	Hata kodu. Bu, program aracılığıyla kullanılabilecek bir anımsatıcıdır.
message	string	Kullanıcı dostu hata iletisi. İleti genellikle yerelleştirilir ve hizmet sürümüne göre farklılık gösterebilir.

PrivateEndpoint

Özel uç nokta nesne özellikleri.

Name	Tür	Description
id	string	Özel uç nokta kaynağının tam tanımlayıcısı.

PrivateEndpointConnection

Özel uç nokta bağlantı kaynağı.

Name	Tür	Description
etag	string	Özel uç nokta bağlantısının durumunda bir değişiklik olduğunda değiştirilir.
id	string	Anahtar kasası kaynağının tam tanımlayıcısı.
location	string	Anahtar kasası kaynağının Azure konumu.
name	string	Anahtar kasası kaynağının adı.
properties.privateEndpoint	PrivateEndpoint	Özel uç nokta nesnesinin özellikleri.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Özel bağlantı bağlantısının onay durumu.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Özel uç nokta bağlantısının sağlama durumu.
tags	object	Anahtar kasası kaynağına atanan etiketler.
type	string	Anahtar kasası kaynağının kaynak türü.

PrivateEndpointConnectionProvisioningState

Geçerli sağlama durumu.

Name	Tür	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Özel uç nokta bağlantı durumu.

Name	Tür	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Özel bağlantı bağlantısının onay durumunu temsil eden bir nesne.

Name	Tür	Description
actionsRequired	ActionsRequired	Hizmet sağlayıcısındaki değişikliklerin tüketicide herhangi bir güncelleştirme gerektirip gerektirmediğini belirten bir ileti.
description	string	Onay veya ret nedeni.
status	PrivateEndpointServiceConnectionStatus	Bağlantının anahtar kasası sahibi tarafından onaylandığını, reddedildiğini veya kaldırıldığını gösterir.