Vaults - List Deleted

Referens

Service:: Key Vault

API Version:: 2022-07-01

Hämtar information om borttagna valv i en prenumeration.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
subscriptionId	path	True	string	Autentiseringsuppgifter för prenumeration som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	DeletedVaultListResult	Hämtad information om alla borttagna nyckelvalv i en prenumeration.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Exempel

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

Definitioner

Name	Description
CloudError	Ett felsvar från Key Vault resursprovider
CloudErrorBody	Ett felsvar från Key Vault resursprovider
DeletedVault	Tog bort valvinformation med utökad information.
DeletedVaultListResult	Lista över valv
DeletedVaultProperties	Egenskaper för det borttagna valvet.

CloudError

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
error	CloudErrorBody	Ett felsvar från Key Vault resursprovider

CloudErrorBody

Ett felsvar från Key Vault resursprovider

Name	Typ	Description
code	string	Felkod. Detta är en mnemonic som kan konsumeras programmatiskt.
message	string	Användarvänligt felmeddelande. Meddelandet är vanligtvis lokaliserat och kan variera beroende på tjänstversion.

DeletedVault

Tog bort valvinformation med utökad information.

Name	Typ	Description
id	string	Resurs-ID för det borttagna nyckelvalvet.
name	string	Namnet på nyckelvalvet.
properties	DeletedVaultProperties	Egenskaper för valvet
type	string	Nyckelvalvets resurstyp.

DeletedVaultListResult

Lista över valv

Name	Typ	Description
nextLink	string	URL:en för att hämta nästa uppsättning borttagna valv.
value	DeletedVault[]	Listan över borttagna valv.

DeletedVaultProperties

Egenskaper för det borttagna valvet.

Name	Typ	Description
deletionDate	string	Det borttagna datumet.
location	string	Platsen för det ursprungliga valvet.
purgeProtectionEnabled	boolean	Rensa skyddsstatus för det ursprungliga valvet.
scheduledPurgeDate	string	Det schemalagda rensade datumet.
tags	object	Taggar för det ursprungliga valvet.
vaultId	string	Resurs-ID för det ursprungliga valvet.