MHSM Private Endpoint Connections - Delete

Référence

Service:: Key Vault

Version d'API:: 2022-07-01

Supprime la connexion de point de terminaison privé spécifiée associée au pool hsm managé.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom du pool HSM managé
privateEndpointConnectionName	path	True	string	Nom de la connexion de point de terminaison privé associée au pool hsm managé.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient le pool HSM managé.
subscriptionId	path	True	string	Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	MHSMPrivateEndpointConnection	La connexion de point de terminaison privé a été supprimée.
202 Accepted		La connexion de point de terminaison privé est en cours de suppression. En-têtes Location: string
204 No Content		La connexion de point de terminaison privé n’existe pas.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ManagedHsmDeletePrivateEndpointConnection

DELETE https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedHSMs/sample-mhsm/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 managed_hsm_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.mhsm_private_endpoint_connections.begin_delete(
        resource_group_name="sample-group",
        name="sample-mhsm",
        private_endpoint_connection_name="sample-pec",
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_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

Exemple de réponse

Code d’état:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-vault/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/managedhsms/privateEndpointConnections",
  "properties": {
    "provisioningState": "Disconnected"
  }
}

Code d’état:: 202

Location: https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/managedhsms/sample-mhsm/privateEndpointConnections/sample-pec?operationid=25334578

Code d’état:: 204

Définitions

Nom	Description
ActionsRequired	Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
CloudError	Réponse d’erreur de Key Vault fournisseur de ressources
CloudErrorBody	Réponse d’erreur de Key Vault fournisseur de ressources
identityType	Type d’identité qui a créé la ressource de coffre de clés.
ManagedHsmSku	Détails de la référence SKU
ManagedHsmSkuFamily	Famille de références SKU du pool HSM managé
ManagedHsmSkuName	Référence SKU du pool HSM managé
MHSMPrivateEndpoint	Propriétés de l’objet de point de terminaison privé.
MHSMPrivateEndpointConnection	Ressource de connexion de point de terminaison privé.
MHSMPrivateLinkServiceConnectionState	Objet qui représente l’état d’approbation de la connexion de liaison privée.
PrivateEndpointConnectionProvisioningState	État d’approvisionnement de la connexion de point de terminaison privé.
PrivateEndpointServiceConnectionStatus	Indique si la connexion a été approuvée, rejetée ou supprimée par le propriétaire du coffre de clés.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource de coffre de clés.

ActionsRequired

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.

Nom	Type	Description
None	string

CloudError

Réponse d’erreur de Key Vault fournisseur de ressources

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur de Key Vault fournisseur de ressources

CloudErrorBody

Réponse d’erreur de Key Vault fournisseur de ressources

Nom	Type	Description
code	string	Code d’erreur. Il s’agit d’un mnémonique qui peut être consommé par programmation.
message	string	Message d’erreur convivial. Le message est généralement localisé et peut varier en fonction de la version du service.

identityType

Type d’identité qui a créé la ressource de coffre de clés.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsmSku

Détails de la référence SKU

Nom	Type	Description
family	ManagedHsmSkuFamily	Famille de références SKU du pool HSM managé
name	ManagedHsmSkuName	Référence SKU du pool HSM managé

ManagedHsmSkuFamily

Famille de références SKU du pool HSM managé

Nom	Type	Description
B	string

ManagedHsmSkuName

Référence SKU du pool HSM managé

Nom	Type	Description
Custom_B32	string
Custom_B6	string
Standard_B1	string