Vaults - Get Deleted

Référence

Service:: Key Vault

Version d'API:: 2022-07-01

Obtient le coffre de clés Azure supprimé.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.KeyVault/locations/{location}/deletedVaults/{vaultName}?api-version=2022-07-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
location	path	True	string	Emplacement du coffre supprimé.
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.
vaultName	path	True	string	Nom du coffre.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	DeletedVault	Informations récupérées sur le coffre supprimé.
Other Status Codes	CloudError	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Exemples

Retrieve a deleted vault

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault?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 get_deleted_vault.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.vaults.get_deleted(
        vault_name="sample-vault",
        location="westus",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/getDeletedVault.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/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault",
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/deletedVaults",
  "properties": {
    "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault",
    "location": "westus",
    "tags": {},
    "deletionDate": "2017-01-01T00:00:59Z",
    "scheduledPurgeDate": "2017-04-01T00:00:59Z",
    "purgeProtectionEnabled": true
  }
}

Définitions

Nom	Description
CloudError	Réponse d’erreur de Key Vault fournisseur de ressources
CloudErrorBody	Réponse d’erreur de Key Vault fournisseur de ressources
DeletedVault	Informations de coffre supprimées avec des détails étendus.
DeletedVaultProperties	Propriétés du coffre supprimé.

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.

DeletedVault

Informations de coffre supprimées avec des détails étendus.

Nom	Type	Description
id	string	ID de ressource pour le coffre de clés supprimé.
name	string	Nom du coffre de clés.
properties	DeletedVaultProperties	Propriétés du coffre
type	string	Type de ressource du coffre de clés.

DeletedVaultProperties

Propriétés du coffre supprimé.

Nom	Type	Description
deletionDate	string	Date de suppression.
location	string	Emplacement du coffre d’origine.
purgeProtectionEnabled	boolean	Status de protection contre le vidage du coffre d’origine.
scheduledPurgeDate	string	Date de purge planifiée.
tags	object	Étiquettes du coffre d’origine.
vaultId	string	ID de ressource du coffre d’origine.

Partager via