Vaults - Get Deleted

Service:

Key Vault

API Version:

2022-07-01

取得已刪除的 Azure 金鑰保存庫。

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

URI 參數

名稱	位於	必要	類型	Description
location	path	True	string	已刪除保存庫的位置。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
vaultName	path	True	string	保存庫的名稱。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	DeletedVault	擷取已刪除保存庫的相關信息。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

範例

Retrieve a deleted vault

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedVaults/sample-vault?api-version=2022-07-01

Python

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

Sample Response

Status code:

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

定義

名稱	Description
CloudError	來自 金鑰保存庫 資源提供者的錯誤回應
CloudErrorBody	來自 金鑰保存庫 資源提供者的錯誤回應
DeletedVault	已刪除具有擴充詳細數據的保存庫資訊。
DeletedVaultProperties	已刪除保存庫的屬性。

CloudError

來自 金鑰保存庫 資源提供者的錯誤回應

名稱	類型	Description
error	CloudErrorBody	來自 金鑰保存庫 資源提供者的錯誤回應

CloudErrorBody

來自 金鑰保存庫 資源提供者的錯誤回應

名稱	類型	Description
code	string	錯誤碼。 這是可透過程序設計方式取用的助記鍵。
message	string	使用者易記的錯誤訊息。 訊息通常會當地語系化，而且可能會隨服務版本而有所不同。

DeletedVault

已刪除具有擴充詳細數據的保存庫資訊。

名稱	類型	Description
id	string	已刪除金鑰保存庫的資源識別碼。
name	string	金鑰保存庫的名稱。
properties	DeletedVaultProperties	保存庫的屬性
type	string	金鑰保存庫的資源類型。

DeletedVaultProperties

已刪除保存庫的屬性。

名稱	類型	Description
deletionDate	string	已刪除的日期。
location	string	原始保存庫的位置。
purgeProtectionEnabled	boolean	清除原始保存庫的保護狀態。
scheduledPurgeDate	string	排程的清除日期。
tags	object	原始保存庫的標記。
vaultId	string	原始保存庫的資源標識碼。