你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Managed Hsms - List Deleted

参考

服务:: Key Vault

API 版本:: 2022-07-01

List 操作获取与订阅关联的已删除托管 HSM 的相关信息。

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	DeletedManagedHsmListResult	检索了有关指定订阅中所有托管 HSM 的信息。
Other Status Codes	ManagedHsmError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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

示例响应

状态代码:: 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=="
}

定义

名称	说明
DeletedManagedHsm
DeletedManagedHsmListResult	已删除的托管 HSM 池列表
DeletedManagedHsmProperties	已删除的托管 HSM 的属性。
Error	服务器错误。
ManagedHsmError	错误异常。

DeletedManagedHsm

名称	类型	说明
id	string	已删除的托管 HSM 池的 Azure 资源管理器资源 ID。
name	string	托管 HSM 池的名称。
properties	DeletedManagedHsmProperties	已删除的托管 HSM 的属性
type	string	托管 HSM 池的资源类型。

DeletedManagedHsmListResult

已删除的托管 HSM 池列表

名称	类型	说明
nextLink	string	用于获取下一组已删除的托管 HSM 池的 URL。
value	DeletedManagedHsm[]	已删除的托管 HSM 池的列表。

DeletedManagedHsmProperties

已删除的托管 HSM 的属性。

名称	类型	说明
deletionDate	string	删除的日期。
location	string	原始托管 HSM 的位置。
mhsmId	string	原始托管 HSM 的资源 ID。
purgeProtectionEnabled	boolean	清除原始托管 HSM 的保护状态。
scheduledPurgeDate	string	计划的清除日期。
tags	object	原始托管 HSM 的标记。

Error

服务器错误。

名称	类型	说明
code	string	错误代码。
innererror	Error	内部错误包含更具体的错误代码。
message	string	错误消息。

ManagedHsmError

错误异常。

名称	类型	说明
error	Error	服务器错误。

通过