Managed Hsms - Update

Служба:: Key Vault

Версия API:: 2024-11-01

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

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}?api-version=2024-11-01

Параметры URI

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

Текст запроса

Имя	Тип	Описание
identity	ManagedServiceIdentity	Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения
location	string	Поддерживаемая папка Azure, в которой должен быть создан управляемый пул HSM.
properties	ManagedHsmProperties	Свойства управляемого устройства HSM
sku	ManagedHsmSku	Сведения о номере SKU
tags	object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	ManagedHsm	Исправленный управляемый пул HSM
202 Accepted	ManagedHsm	Принято, и операция будет завершена асинхронно. Заголовки Location: string
Other Status Codes	ManagedHsmError	Ответ об ошибке с описанием причины сбоя операции.

Имя

Тип

Описание

200 OK

ManagedHsm

Исправленный управляемый пул HSM

202 Accepted

ManagedHsm

Принято, и операция будет завершена асинхронно.

Заголовки

Location: string

Other Status Codes

ManagedHsmError

Ответ об ошибке с описанием причины сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

Update an existing managed HSM Pool

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

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2024-11-01

{
  "tags": {
    "Dept": "hsm",
    "Environment": "dogfood",
    "Slice": "A"
  }
}

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

Код состояния:: 200

{
  "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",
    "Slice": "A"
  }
}

Код состояния:: 202

Location: https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.KeyVault/locations/westus/managedHsmOperationResults/00000000-0000-0000-0000-000000000000

{
  "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": "Updating",
    "statusMessage": "ManagedHsm is updating."
  },
  "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",
    "Slice": "A"
  }
}

Определения

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

ActionsRequired

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

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

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

ActivationStatus

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

Статус активации

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

CreateMode

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

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

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

Error

Объект

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

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

GeoReplicationRegionProvisioningState

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

Состояние подготовки геореплицированного региона.

Значение	Описание
Preprovisioning
Provisioning
Succeeded
Failed
Deleting
Cleanup

identityType

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

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

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

ManagedHsm

Объект

Информация о ресурсах с расширенными сведениями.

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

ManagedHsmError

Объект

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

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

ManagedHsmProperties

Объект

Свойства управляемого пула 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 из общедоступных сетей.
regions	MHSMGeoReplicatedRegion[]		Список всех регионов, связанных с управляемым пулом 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

Объект

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

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

ManagedHsmSku

Объект

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

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

ManagedHsmSkuFamily

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

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

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

ManagedHsmSkuName

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

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

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

ManagedServiceIdentity

Объект

Управляемое удостоверение службы (назначенные системой удостоверения и (или) назначенные пользователем удостоверения

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string (uuid)	Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
userAssignedIdentities	<string, UserAssignedIdentity>	удостоверения User-Assigned Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

ManagedServiceIdentityType

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

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Значение	Описание
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MHSMGeoReplicatedRegion

Объект

Регион, на который был расширен этот управляемый пул HSM.

Имя	Тип	Описание
isPrimary	boolean	Логическое значение, указывающее, является ли регион основным регионом или дополнительным регионом.
name	string	Имя геореплицированного региона.
provisioningState	GeoReplicationRegionProvisioningState	Состояние подготовки геореплицированного региона.

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" или "Нет". Если значение по умолчанию не задано, — 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
Deny

NetworkRuleBypassOptions

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

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

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

PrivateEndpointConnectionProvisioningState

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

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

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

PrivateEndpointServiceConnectionStatus

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

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

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

ProvisioningState

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

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

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

PublicNetworkAccess

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

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

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

SystemData

Объект

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

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

UserAssignedIdentity

Объект

Свойства назначаемого пользователем удостоверения

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента назначенного удостоверения.
principalId	string (uuid)	Основной идентификатор назначенного удостоверения.

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

Managed Hsms - Update

Параметры URI

Текст запроса

Ответы

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

azure_auth

Области

Примеры

Update an existing managed HSM Pool

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

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

Определения

ActionsRequired

ActivationStatus

CreateMode

Error

GeoReplicationRegionProvisioningState

identityType

ManagedHsm

ManagedHsmError

ManagedHsmProperties

ManagedHSMSecurityDomainProperties

ManagedHsmSku

ManagedHsmSkuFamily

ManagedHsmSkuName

ManagedServiceIdentity

ManagedServiceIdentityType

MHSMGeoReplicatedRegion

MHSMIPRule

MHSMNetworkRuleSet

MHSMPrivateEndpoint

MHSMPrivateEndpointConnectionItem

MHSMPrivateLinkServiceConnectionState

MHSMVirtualNetworkRule

NetworkRuleAction

NetworkRuleBypassOptions

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SystemData

UserAssignedIdentity