Managed Hsms - List Deleted

Ссылка

Service:: Key Vault

API Version:: 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. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.

Ответы

Имя	Тип	Описание
200 OK	DeletedManagedHsmListResult	Получена информация обо всех управляемых модулях HSM в указанной подписке.
Other Status Codes	ManagedHsmError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
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=="
}

Определения

Имя	Описание
DeletedManagedHsm
DeletedManagedHsmListResult	Список удаленных пулов управляемых устройств HSM
DeletedManagedHsmProperties	Свойства удаленного управляемого модуля HSM.
Error	Ошибка сервера.
ManagedHsmError	Исключение в результате ошибки.

DeletedManagedHsm

Имя	Тип	Описание
id	string	Идентификатор ресурса azure Resource Manager для удаленного пула управляемых устройств HSM.
name	string	Имя управляемого пула HSM.
properties	DeletedManagedHsmProperties	Свойства удаленного управляемого модуля HSM
type	string	Тип ресурса управляемого пула HSM.

DeletedManagedHsmListResult

Список удаленных пулов управляемых устройств HSM

Имя	Тип	Описание
nextLink	string	URL-адрес для получения следующего набора удаленных управляемых пулов HSM.
value	DeletedManagedHsm[]	Список удаленных управляемых пулов HSM.

DeletedManagedHsmProperties

Свойства удаленного управляемого модуля HSM.

Имя	Тип	Описание
deletionDate	string	Дата удаления.
location	string	Расположение исходного управляемого модуля HSM.
mhsmId	string	Идентификатор ресурса исходного управляемого модуля HSM.
purgeProtectionEnabled	boolean	Состояние защиты от очистки исходного управляемого модуля HSM.
scheduledPurgeDate	string	Запланированная дата очистки.
tags	object	Теги исходного управляемого модуля HSM.

Error

Ошибка сервера.

Имя	Тип	Описание
code	string	Код ошибки.
innererror	Error	Внутренняя ошибка содержит более конкретный код ошибки.
message	string	Сообщение об ошибке.

ManagedHsmError

Исключение в результате ошибки.

Имя	Тип	Описание
error	Error	Ошибка сервера.