Vaults - List Deleted

Referenz

Service:: Key Vault

API Version:: 2022-07-01

Ruft Informationen zu den gelöschten Tresoren in einem Abonnement ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	DeletedVaultListResult	Informationen zu allen gelöschten Schlüsseltresoren in einem Abonnement abgerufen.
Other Status Codes	CloudError	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Beispiele

List deleted vaults in the specified subscription

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedVaults?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 list_deleted_vaults.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.list_deleted()
    for item in response:
        print(item)


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

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault",
      "name": "vault-agile-drawer-6404",
      "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
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedVaults?api-version=2022-07-01&%24skiptoken=HY3RaoMwAEX%2fRcbeYhJrnRXKYNWOuqpME0sfNcYui0Yxade19N8ne7hcDlzOvVuKX81eKKmt4G4dooLQwgqsL2NGHUDYV6o68Z4rY1e388RtNvRQn2vNJjEaMSgNvcbneMUcsKg8BFwft8DndQ0w9hu2QOiFLRs4TsNFNHzSMBFsGvTQGvuD%2f5bVuTOw4R03vPkH%2fVqNAlzm5SxfOwh7ACOA8POTlvPjILlaU1ke8jImOc23JCppQVfZnna0DXc4ISc3vSVuRo5zJE6%2bj25C3vwk2v2kEV2mMn7PyOc1DbtNGkonnzuLym1G400uI5QRZj0efw%3d%3d"
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort von Key Vault Ressourcenanbieter
CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter
DeletedVault	Gelöschte Tresorinformationen mit erweiterten Details.
DeletedVaultListResult	Liste der Tresore
DeletedVaultProperties	Eigenschaften des gelöschten Tresors.

CloudError

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
error	CloudErrorBody	Eine Fehlerantwort von Key Vault Ressourcenanbieter

CloudErrorBody

Eine Fehlerantwort von Key Vault Ressourcenanbieter

Name	Typ	Beschreibung
code	string	Fehlercode Dies ist ein mnemonisches, das programmgesteuert genutzt werden kann.
message	string	Benutzerfreundliche Fehlermeldung. Die Nachricht ist in der Regel lokalisiert und kann je nach Dienstversion variieren.

DeletedVault

Gelöschte Tresorinformationen mit erweiterten Details.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID für den gelöschten Schlüsseltresor.
name	string	Der Name des Schlüsseltresors.
properties	DeletedVaultProperties	Eigenschaften des Tresors
type	string	Der Ressourcentyp des Schlüsseltresors.

DeletedVaultListResult

Liste der Tresore

Name	Typ	Beschreibung
nextLink	string	Die URL zum Abrufen des nächsten Satzes gelöschter Tresore.
value	DeletedVault[]	Die Liste der gelöschten Tresore.

DeletedVaultProperties

Eigenschaften des gelöschten Tresors.

Name	Typ	Beschreibung
deletionDate	string	Das gelöschte Datum.
location	string	Der Speicherort des ursprünglichen Tresors.
purgeProtectionEnabled	boolean	Löschschutz status des ursprünglichen Tresors.
scheduledPurgeDate	string	Das geplante Gelöschte Datum.
tags	object	Tags des ursprünglichen Tresors.
vaultId	string	Die Ressourcen-ID des ursprünglichen Tresors.