Managed Hsms - List By Resource Group

Ссылка

Service:: Key Vault

API Version:: 2021-10-01

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

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

With optional parameters:

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

Параметры URI

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

Ответы

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

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

azure_auth

Flow OAuth2 Azure Active Directory

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

Scopes

Name	Description
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=2021-10-01

package armkeyvault_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/keyvault/armkeyvault"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2021-10-01/examples/ManagedHsm_ListByResourceGroup.json
func ExampleManagedHsmsClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armkeyvault.NewManagedHsmsClient("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := client.NewListByResourceGroupPager("hsm-group",
		&armkeyvault.ManagedHsmsClientListByResourceGroupOptions{Top: nil})
	for pager.More() {
		nextResult, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range nextResult.Value {
			// TODO: use page item
			_ = v
		}
	}
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "initialAdminObjectIds": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "enableSoftDelete": true,
        "softDeleteRetentionInDays": 90,
        "enablePurgeProtection": true,
        "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": true,
        "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=2021-10-01&$skiptoken=dmF1bHQtcGVza3ktanVyeS03MzA3Ng=="
}

Определения

ActionsRequired	Сообщение, указывающее, требуются ли изменения в поставщике услуг какие-либо обновления для потребителя.
CreateMode	Режим создания, указывающий, создается ли ресурс или восстанавливается из удаленного ресурса.
Error	Ошибка сервера.
identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
ManagedHsm	Сведения о ресурсе с расширенными сведениями.
ManagedHsmError	Исключение в результате ошибки.
ManagedHsmListResult	Список управляемых пулов HSM
ManagedHsmProperties	Свойства управляемого пула 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	Разрешение на управление трафиком плоскости данных, поступающим из общедоступных сетей, в то время как частная конечная точка включена.
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса хранилища ключей.

ActionsRequired

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

Name	Type	Description
None	string

CreateMode

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

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

Error

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

Name	Type	Description
code	string	Код ошибки.
innererror	Error	Внутренняя ошибка содержит более конкретный код ошибки.
message	string	Сообщение об ошибке.

identityType

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

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ManagedHsm

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

Name	Type	Description
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

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

Name	Type	Description
error	Error	Ошибка сервера.

ManagedHsmListResult

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

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

ManagedHsmProperties

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

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

ManagedHsmSku

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

Name	Type	Description
family	ManagedHsmSkuFamily	Семейство SKU управляемого пула HSM
name	ManagedHsmSkuName	SKU управляемого пула HSM

ManagedHsmSkuFamily

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

Name	Type	Description
B	string

ManagedHsmSkuName

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

Name	Type	Description
Custom_B32	string
Standard_B1	string

MHSMIPRule

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

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

MHSMNetworkRuleSet

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

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

MHSMPrivateEndpoint

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

Name	Type	Description
id	string	Полный идентификатор ресурса частной конечной точки.

MHSMPrivateEndpointConnectionItem

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

Name	Type	Description
properties.privateEndpoint	MHSMPrivateEndpoint	Свойства объекта частной конечной точки.
properties.privateLinkServiceConnectionState	MHSMPrivateLinkServiceConnectionState	Состояние утверждения подключения приватного канала.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подготовки подключения к частной конечной точке.

MHSMPrivateLinkServiceConnectionState

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

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

MHSMVirtualNetworkRule

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

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

NetworkRuleAction

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

Name	Type	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

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

Name	Type	Description
AzureServices	string
None	string

PrivateEndpointConnectionProvisioningState

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

Name	Type	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

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

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningState

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

Name	Type	Description
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

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

Name	Type	Description
Disabled	string
Enabled	string

SystemData

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

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