Managed Hsms - Update

Ссылка

Service:: Key Vault

API Version:: 2022-07-01

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

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/managedHSMs/{name}?api-version=2022-07-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 клиента.

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

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

Ответы

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

Имя

Тип

Описание

200 OK

ManagedHsm

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

202 Accepted

ManagedHsm

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

Headers

Location: string

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	олицетворения учетной записи пользователя

Примеры

Update an existing managed HSM Pool

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

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

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_update.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.begin_update(
        resource_group_name="hsm-group",
        name="hsm1",
        parameters={"tags": {"Dept": "hsm", "Environment": "dogfood", "Slice": "A"}},
    ).result()
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/ManagedHsm_Update.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

{
  "properties": {
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "initialAdminObjectIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "enableSoftDelete": false,
    "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"
  }
}

Status code:: 202

Location: https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9

Response Body

{
  "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	Ошибка сервера.
identityType	Тип удостоверения, создавшего ресурс хранилища ключей.
ManagedHsm	Сведения о ресурсе с расширенными сведениями.
ManagedHsmError	Исключение в результате ошибки.
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	Ошибка сервера.

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/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	Тип удостоверения, которое последним изменял ресурс хранилища ключей.

Managed Hsms - Update

Параметры URI

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

Ответы

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

azure_auth

Scopes

Примеры

Update an existing managed HSM Pool

Sample Request

Sample Response

Определения

ActionsRequired

ActivationStatus

CreateMode

Error

identityType

ManagedHsm

ManagedHsmError

ManagedHsmProperties

ManagedHSMSecurityDomainProperties

ManagedHsmSku

ManagedHsmSkuFamily

ManagedHsmSkuName

MHSMIPRule

MHSMNetworkRuleSet

MHSMPrivateEndpoint

MHSMPrivateEndpointConnectionItem

MHSMPrivateLinkServiceConnectionState

MHSMVirtualNetworkRule

NetworkRuleAction

NetworkRuleBypassOptions

PrivateEndpointConnectionProvisioningState

PrivateEndpointServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SystemData

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