Managed Hsms - List By Resource Group

Ссылка

Служба:: Key Vault

Версия API:: 2022-07-01

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

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей управляемый пул HSM.
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

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List managed HSM Pools in a resource group

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/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_resource_group.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_resource_group(
        resource_group_name="hsm-group",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_ListByResourceGroup.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": [
    {
      "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/resourceGroups/hsm-group/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" или "Нет". Если значение по умолчанию не задано, — AzureServices.
PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.
PrivateEndpointServiceConnectionStatus	Указывает, утверждено ли подключение, отклонено или удалено владельцем хранилища ключей.
ProvisioningState	Состояние подготовки.
PublicNetworkAccess	Управление разрешением на управляемый HSM из общедоступных сетей.
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса хранилища ключей.

ActionsRequired

Перечисление

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

Значение	Описание
None

ActivationStatus

Перечисление

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

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

CreateMode

Перечисление

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

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

Error

Object

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

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

identityType

Перечисление

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

Значение	Описание
Application
Key
ManagedIdentity
User

ManagedHsm

Object

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

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

Object

Исключение ошибки.

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

ManagedHsmListResult

Object

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

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

ManagedHsmProperties

Object

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

Имя	Тип	Default value	Описание
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 (date-time)		Дата запланированной очистки в формате UTC.
securityDomainProperties	ManagedHSMSecurityDomainProperties		Свойства домена безопасности управляемого контроллера безопасности HSM.
softDeleteRetentionInDays	integer (int32)	90	Обратимое удаление дней хранения данных. При удалении HSM или ключа он будет оставаться восстановленным в течение настроенного периода хранения или в течение 90 дней по умолчанию. Он принимает значения от 7 до 90.
statusMessage	string		Сообщение о состоянии ресурса.
tenantId	string (uuid)		Идентификатор клиента Azure Active Directory, который следует использовать для проверки подлинности запросов к управляемому пулу HSM.

ManagedHSMSecurityDomainProperties

Object

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

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

ManagedHsmSku

Object

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

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

ManagedHsmSkuFamily

Перечисление

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

Значение	Описание
B

ManagedHsmSkuName

Перечисление

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

Значение	Описание
Custom_B32
Custom_B6
Standard_B1

MHSMIPRule

Object

Правило, которое управляет специальными возможностями управляемого пула hsm из определенного IP-адреса или диапазона IP-адресов.

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

MHSMNetworkRuleSet

Object

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

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

MHSMPrivateEndpoint

Object

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

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

MHSMPrivateEndpointConnectionItem

Object

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

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

MHSMPrivateLinkServiceConnectionState

Object

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

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

MHSMVirtualNetworkRule

Object

Правило, которое управляет специальными возможностями управляемого пула hsm из определенной виртуальной сети.

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

NetworkRuleAction

Перечисление

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

Значение	Описание
Allow
Deny

NetworkRuleBypassOptions

Перечисление

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

Значение	Описание
AzureServices
None

PrivateEndpointConnectionProvisioningState

Перечисление

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

Значение	Описание
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

Перечисление

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

Значение	Описание
Approved
Disconnected
Pending
Rejected

ProvisioningState

Перечисление

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

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

PublicNetworkAccess

Перечисление

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

Значение	Описание
Disabled
Enabled

SystemData

Object

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

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

Поделиться через

Managed Hsms - List By Resource Group

Параметры URI

Ответы

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

azure_auth

Области

Примеры

List managed HSM Pools in a resource group

Образец запроса

Пример ответа

Определения

ActionsRequired

ActivationStatus

CreateMode

Error

identityType

ManagedHsm

ManagedHsmError

ManagedHsmListResult

ManagedHsmProperties

ManagedHSMSecurityDomainProperties

ManagedHsmSku

ManagedHsmSkuFamily

ManagedHsmSkuName

MHSMIPRule

MHSMNetworkRuleSet

MHSMPrivateEndpoint

MHSMPrivateEndpointConnectionItem

MHSMPrivateLinkServiceConnectionState

MHSMVirtualNetworkRule

NetworkRuleAction

NetworkRuleBypassOptions

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SystemData

Дополнительные ресурсы