Managed Hsms - List Deleted

參考

Service:: Key Vault

API Version:: 2022-07-01

清單作業會取得與訂用帳戶相關聯的已刪除受控 HSM 相關信息。

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

URI 參數

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

回應

名稱	類型	Description
200 OK	DeletedManagedHsmListResult	擷取指定訂用帳戶中所有受控 HSM 的相關信息。
Other Status Codes	ManagedHsmError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List deleted managed HSMs in the specified subscription

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


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/DeletedManagedHsm_List.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/deletedManagedHSMs/hsm1",
      "name": "vault-agile-drawer-6404",
      "type": "Microsoft.KeyVault/deletedManagedHSMs",
      "properties": {
        "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
        "location": "westus",
        "deletionDate": "2021-04-01T00:00:59Z",
        "scheduledPurgeDate": "2021-04-01T00:00:59Z",
        "purgeProtectionEnabled": true,
        "tags": {
          "Dept": "hsm",
          "Environment": "production"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/deletedManagedHSMs/hsm2",
      "name": "vault-agile-drawer-6404",
      "type": "Microsoft.KeyVault/deletedManagedHSMs",
      "properties": {
        "mhsmId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2",
        "location": "westus",
        "deletionDate": "2021-04-01T00:00:59Z",
        "scheduledPurgeDate": "2021-04-01T00:00:59Z",
        "purgeProtectionEnabled": true,
        "tags": {
          "Dept": "hsm",
          "Environment": "production"
        }
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/deletedManagedHSMs?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

定義

名稱	Description
DeletedManagedHsm
DeletedManagedHsmListResult	已刪除的受控 HSM 集區清單
DeletedManagedHsmProperties	已刪除受控 HSM 的屬性。
Error	伺服器錯誤。
ManagedHsmError	錯誤例外狀況。

DeletedManagedHsm

名稱	類型	Description
id	string	已刪除受控 HSM 集區的 Azure Resource Manager 資源識別碼。
name	string	受控 HSM 集區的名稱。
properties	DeletedManagedHsmProperties	已刪除受控 HSM 的屬性
type	string	受控 HSM 集區的資源類型。

DeletedManagedHsmListResult

已刪除的受控 HSM 集區清單

名稱	類型	Description
nextLink	string	要取得下一組已刪除受控 HSM 集區的 URL。
value	DeletedManagedHsm[]	已刪除的受控 HSM 集區清單。

DeletedManagedHsmProperties

已刪除受控 HSM 的屬性。

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

Error

伺服器錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	Error	內部錯誤包含更明確的錯誤碼。
message	string	錯誤訊息。

ManagedHsmError

錯誤例外狀況。

名稱	類型	Description
error	Error	伺服器錯誤。