Managed Hsms - List By Subscription

Ссылка

Service:: Key Vault

API Version:: 2022-07-01

Операция List получает сведения об управляемых пулах HSM, связанных с подпиской.

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

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.
$top	query		integer int32	Максимальное количество отображаемых результатов.

Ответы

Имя	Тип	Описание
200 OK	ManagedHsmListResult	Получение сведений обо всех управляемых пулах 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 managed HSM Pools in a subscription

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


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListBySubscription.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": [
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": false,
        "hsmUri": "https://westus.hsm1.managedhsm.azure.net",
        "provisioningState": "Succeeded",
        "statusMessage": "ManagedHsm is functional."
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1",
      "name": "hsm1",
      "type": "Microsoft.KeyVault/managedHSMs",
      "location": "westus",
      "sku": {
        "family": "B",
        "name": "Standard_B1"
      },
      "tags": {
        "Dept": "hsm",
        "Environment": "dogfood"
      }
    },
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": false,
        "hsmUri": "https://westus.hsm2.managedhsm.azure.net",
        "provisioningState": "Succeeded",
        "statusMessage": "ManagedHsm is functional."
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm2",
      "name": "hsm2",
      "type": "Microsoft.KeyVault/managedHSMs",
      "location": "westus",
      "sku": {
        "family": "B",
        "name": "Standard_B1"
      },
      "tags": {
        "Dept": "hsm",
        "Environment": "production"
      }
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/managedHSMs?api-version=2022-07-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Определения

Имя	Описание
ActionsRequired	Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления на потребителе.
ActivationStatus	Состояние активации
CreateMode	Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса.
Error	Ошибка сервера.
identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
ManagedHsm	Сведения о ресурсе с расширенными сведениями.
ManagedHsmError	Исключение в результате ошибки.
ManagedHsmListResult	Список управляемых пулов HSM
ManagedHsmProperties	Свойства управляемого пула HSM
ManagedHSMSecurityDomainProperties	Свойства домена безопасности управляемого модуля HSM.
ManagedHsmSku	Сведения о номере SKU
ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
ManagedHsmSkuName	SKU управляемого пула HSM
MHSMIPRule	Правило, регулирующее доступность управляемого пула HSM из определенного IP-адреса или диапазона IP-адресов.
MHSMNetworkRuleSet	Набор правил, определяющих доступность сети для управляемого пула HSM.
MHSMPrivateEndpoint	Свойства объекта частной конечной точки.
MHSMPrivateEndpointConnectionItem	Элемент подключения к частной конечной точке.
MHSMPrivateLinkServiceConnectionState	Объект , представляющий состояние утверждения подключения приватного канала.
MHSMVirtualNetworkRule	Правило, регулирующее доступность управляемого пула HSM из определенной виртуальной сети.
NetworkRuleAction	Действие по умолчанию, если не совпадают правила из ipRules и virtualNetworkRules. Используется только после оценки свойства обхода.
NetworkRuleBypassOptions	Указывает, какой трафик может обходить сетевые правила. Это может быть AzureServices или None. Если значение не указано, по умолчанию используется значение AzureServices.
PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
PrivateEndpointServiceConnectionStatus	Указывает, было ли подключение утверждено, отклонено или удалено владельцем хранилища ключей.
ProvisioningState	Состояние подготовки.
PublicNetworkAccess	Управление разрешением на управляемый модуль HSM из общедоступных сетей.
SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса хранилища ключей.

ActionsRequired

Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления на потребителе.

Имя	Тип	Описание
None	string

ActivationStatus

Состояние активации

Имя	Тип	Описание
Active	string	Пул управляемых устройств HSM активен.
Failed	string	Не удалось активировать управляемый модуль HSM.
NotActivated	string	Пул управляемых устройств HSM еще не активирован.
Unknown	string	При активации управляемого модуля HSM произошла неизвестная ошибка.

CreateMode

Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса.

Имя	Тип	Описание
default	string	Создайте управляемый пул HSM. Это параметр по умолчанию.
recover	string	Восстановление управляемого пула HSM из обратимо удаленного ресурса.

Error

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

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

identityType

Тип удостоверения, создавшего ресурс хранилища ключей.

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

Сведения о ресурсе с расширенными сведениями.

Имя	Тип	Описание
id	string	Идентификатор ресурса azure Resource Manager для управляемого пула HSM.
location	string	Поддерживаемая служба Azure, в которой должен быть создан управляемый пул HSM.
name	string	Имя управляемого пула HSM.
properties	ManagedHsmProperties	Свойства управляемого модуля HSM
sku	ManagedHsmSku	Сведения о номере SKU
systemData	SystemData	Метаданные, относящиеся к созданию и последнему изменению ресурса хранилища ключей.
tags	object	Теги ресурсов
type	string	Тип ресурса управляемого пула HSM.

ManagedHsmError

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

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

ManagedHsmListResult

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

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

ManagedHsmProperties

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

Имя	Тип	Значение по умолчанию	Описание
createMode	CreateMode		Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса.
enablePurgeProtection	boolean	True	Свойство, указывающее, включена ли защита от очистки для этого управляемого пула HSM. Если установить для этого свойства значение true, активируется защита от очистки для этого пула управляемого устройства HSM и его содержимого. Только служба управляемого модуля HSM может инициировать жесткое, безвозвратное удаление. Включение этой функции необратимо.
enableSoftDelete	boolean	True	Свойство , указывая, включена ли функция обратимого удаления для этого управляемого пула HSM. Обратимое удаление включено по умолчанию для всех управляемых модулей HSM и неизменяемо.
hsmUri	string		Универсальный код ресурса (URI) управляемого пула HSM для выполнения операций с ключами.
initialAdminObjectIds	string[]		Массив начальных идентификаторов объектов администраторов для этого управляемого пула HSM.
networkAcls	MHSMNetworkRuleSet		Правила, определяющие доступность хранилища ключей из определенных сетевых расположений.
privateEndpointConnections	MHSMPrivateEndpointConnectionItem[]		Список подключений к частной конечной точке, связанных с управляемым пулом HSM.
provisioningState	ProvisioningState		Состояние подготовки.
publicNetworkAccess	PublicNetworkAccess	Enabled	Управление разрешением на управляемый модуль HSM из общедоступных сетей.
scheduledPurgeDate	string		Запланированная дата очистки в формате UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Свойства домена безопасности управляемого устройства HSM.
softDeleteRetentionInDays	integer	90	Обратимо удаленные данные в днях хранения. При удалении модуля HSM или ключа они остаются пригодными для восстановления в течение настроенного периода хранения или периода по умолчанию в 90 дней. Он принимает значения от 7 до 90.
statusMessage	string		Сообщение о состоянии ресурса.
tenantId	string		Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM.

ManagedHSMSecurityDomainProperties

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

Имя	Тип	Описание
activationStatus	ActivationStatus	Состояние активации
activationStatusMessage	string	Сообщение о состоянии активации.

ManagedHsmSku

Сведения о номере SKU

Имя	Тип	Описание
family	ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
name	ManagedHsmSkuName	SKU управляемого пула HSM

ManagedHsmSkuFamily

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

Имя	Тип	Описание
B	string

ManagedHsmSkuName

SKU управляемого пула HSM

Имя	Тип	Описание
Custom_B32	string
Custom_B6	string
Standard_B1	string

MHSMIPRule

Правило, регулирующее доступность управляемого пула HSM из определенного IP-адреса или диапазона IP-адресов.

Имя	Тип	Описание
value	string	Диапазон адресов IPv4 в нотации CIDR, например "124.56.78.91" (простой IP-адрес) или "124.56.78.0/24" (все адреса, начинающиеся с 124.56.78).

MHSMNetworkRuleSet

Набор правил, определяющих доступность сети для управляемого пула HSM.

Имя	Тип	Описание
bypass	NetworkRuleBypassOptions	Указывает, какой трафик может обходить сетевые правила. Это может быть AzureServices или None. Если значение не указано, по умолчанию используется значение AzureServices.
defaultAction	NetworkRuleAction	Действие по умолчанию, если не совпадают правила из ipRules и virtualNetworkRules. Используется только после оценки свойства обхода.
ipRules	MHSMIPRule[]	Список правил IP-адресов.
virtualNetworkRules	MHSMVirtualNetworkRule[]	Список правил виртуальной сети.

MHSMPrivateEndpoint

Свойства объекта частной конечной точки.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса частной конечной точки.

MHSMPrivateEndpointConnectionItem

Элемент подключения к частной конечной точке.

Имя	Тип	Описание
etag	string	Изменение при изменении состояния подключения к частной конечной точке.
id	string	Идентификатор подключения к частной конечной точке.
properties.privateEndpoint	MHSMPrivateEndpoint	Свойства объекта частной конечной точки.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Состояние утверждения подключения к приватному каналу.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.

MHSMPrivateLinkServiceConnectionState

Объект , представляющий состояние утверждения подключения приватного канала.

Имя	Тип	Описание
actionsRequired	ActionsRequired	Сообщение, указывающее, требуют ли изменения в поставщике услуг каких-либо обновлений для потребителя.
description	string	Причина утверждения или отклонения.
status	PrivateEndpointServiceConnectionStatus	Указывает, было ли подключение утверждено, отклонено или удалено владельцем хранилища ключей.

MHSMVirtualNetworkRule

Правило, регулирующее доступность управляемого пула HSM из определенной виртуальной сети.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса подсети виртуальной сети, например "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1".

NetworkRuleAction

Действие по умолчанию, если не совпадают правила из ipRules и virtualNetworkRules. Используется только после оценки свойства обхода.

Имя	Тип	Описание
Allow	string
Deny	string

NetworkRuleBypassOptions

Указывает, какой трафик может обходить сетевые правила. Это может быть AzureServices или None. Если значение не указано, по умолчанию используется значение AzureServices.

Имя	Тип	Описание
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

Состояние подготовки подключения к частной конечной точке.

Имя	Тип	Описание
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Указывает, было ли подключение утверждено, отклонено или удалено владельцем хранилища ключей.

Имя	Тип	Описание
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

Состояние подготовки.

Имя	Тип	Описание
Activated	string	Управляемый пул HSM готов к нормальному использованию.
Deleting	string	Управляемый пул HSM в настоящее время удаляется.
Failed	string	Сбой подготовки управляемого пула HSM.
Provisioning	string	Сейчас выполняется подготовка управляемого пула HSM.
Restoring	string	Управляемый пул HSM восстанавливается из полной резервной копии HSM.
SecurityDomainRestore	string	Управляемый пул HSM ожидает действия по восстановлению домена безопасности.
Succeeded	string	Управляемый пул HSM подготовлен полностью.
Updating	string	Управляемый пул HSM в настоящее время обновляется.

PublicNetworkAccess

Управление разрешением на управляемый модуль HSM из общедоступных сетей.

Имя	Тип	Описание
Disabled	string
Enabled	string

SystemData

Метаданные, относящиеся к созданию и последнему изменению ресурса хранилища ключей.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса хранилища ключей (UTC).
createdBy	string	Удостоверение, создающее ресурс хранилища ключей.
createdByType	identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
lastModifiedAt	string	Метка времени последнего изменения ресурса хранилища ключей (UTC).
lastModifiedBy	string	Удостоверение, которое в последний раз изменял ресурс хранилища ключей.
lastModifiedByType	identityType	Тип удостоверения, который в последний раз изменял ресурс хранилища ключей.