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

az dedicated-hsm

Note

This reference is part of the hardware-security-modules extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az dedicated-hsm command. Learn more about extensions.

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

Команды

Имя Описание Тип Состояние
az dedicated-hsm create

Создайте выделенный HSM в указанной подписке.

 Extension GA
az dedicated-hsm delete

Удаляет указанный выделенный HSM Azure.

 Extension GA
az dedicated-hsm list

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

 Extension GA
az dedicated-hsm list-outbound-network-dependency-endpoint

Возвращает список конечных точек исходящего трафика (сетевых конечных точек всех исходящих зависимостей) в указанном выделенном ресурсе hsm. Операция возвращает свойства каждой конечной точки исходящего трафика.

 Extension GA
az dedicated-hsm show

Возвращает указанный выделенный HSM Azure.

 Extension GA
az dedicated-hsm update

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

 Extension GA
az dedicated-hsm wait

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

 Extension GA

az dedicated-hsm create

Создайте выделенный HSM в указанной подписке.

az dedicated-hsm create --name
                        --resource-group
                        [--location]
                        [--mgmt-network-interfaces]
                        [--mgmt-network-subnet]
                        [--network-interfaces]
                        [--no-wait]
                        [--sku {SafeNet Luna Network HSM A790, payShield10K_LMK1_CPS250, payShield10K_LMK1_CPS2500, payShield10K_LMK1_CPS60, payShield10K_LMK2_CPS250, payShield10K_LMK2_CPS2500, payShield10K_LMK2_CPS60}]
                        [--stamp-id]
                        [--subnet]
                        [--tags]
                        [--zones]

Примеры

Создание нового или обновление существующего выделенного устройства HSM

az dedicated-hsm create --name "hsm1" --location "westus" --network-interfaces private-ip-address="1.0.0.1" --subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp01" --sku "SafeNet Luna Network HSM A790" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

Создание нового или обновления существующего HSM оплаты

az dedicated-hsm create --name "hsm1" --location "westus" --mgmt-network-interfaces private-ip-address="1.0.0.1" --mgmt-network-subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp01" --sku "payShield10K_LMK1_CPS60" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

Создание нового или обновление существующего HSM оплаты с помощью профиля управления

az dedicated-hsm create --name "hsm1" --location "westus" --network-interfaces private-ip-address="1.0.0.2" --subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --mgmt-network-interfaces private-ip-address="1.0.0.1" --mgmt-network-subnet id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/stamp01/subnets/stamp01" --stamp-id "stamp02" --sku "payShield10K_LMK1_CPS60" --tags Dept="hsm" Environment="dogfood" --resource-group "hsm-group"

Обязательные параметры

--name

Имя выделенного Hsm.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--mgmt-network-interfaces -m

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

Использование: --mgmt-network-interfaces private-ip-address=XX

private-ip-address: Частный IP-адрес интерфейса

Несколько действий можно указать с помощью нескольких аргументов --mgmt-network-interfaces.

Свойство Значение
Parameter group: Management Network Profile Arguments
--mgmt-network-subnet

Указывает идентификатор подсети.

Использование: --mgmt-network-subnet id=XX

id: идентификатор ресурса ARM в виде /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

Свойство Значение
Parameter group: Management Network Profile Arguments
--network-interfaces -i

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

Использование: --network-interfaces private-ip-address=XX

private-ip-address: Частный IP-адрес интерфейса

Несколько действий можно указать с помощью нескольких аргументов --network-interfaces.

Свойство Значение
Parameter group: Network Profile Arguments
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--sku

SKU выделенного HSM.

Свойство Значение
Parameter group: Sku Arguments
Допустимые значения: SafeNet Luna Network HSM A790, payShield10K_LMK1_CPS250, payShield10K_LMK1_CPS2500, payShield10K_LMK1_CPS60, payShield10K_LMK2_CPS250, payShield10K_LMK2_CPS2500, payShield10K_LMK2_CPS60
--stamp-id

Это поле будет использоваться, если RP не поддерживает зоны доступности.

--subnet

Указывает идентификатор подсети.

Использование: --subnet id=XX

id: идентификатор ресурса ARM в виде /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

Свойство Значение
Parameter group: Network Profile Arguments
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--zones

Выделенные зоны Hsm.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az dedicated-hsm delete

Удаляет указанный выделенный HSM Azure.

az dedicated-hsm delete [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--yes]

Примеры

Удаление выделенного устройства HSM

az dedicated-hsm delete --name "hsm1" --resource-group "hsm-group"

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--name

Имя выделенного устройства HSM для удаления.

Свойство Значение
Parameter group: Resource Id Arguments
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Parameter group: Resource Id Arguments
--yes -y

Не запрашивать подтверждение.

Свойство Значение
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az dedicated-hsm list

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

az dedicated-hsm list [--resource-group]
                      [--top]

Примеры

Перечисление выделенных устройств HSM в группе ресурсов

az dedicated-hsm list --resource-group "hsm-group"

Вывод списка выделенных устройств HSM в группе ресурсов, включая HSM оплаты

az dedicated-hsm list --resource-group "hsm-group"

Вывод списка выделенных устройств HSM в подписке

az dedicated-hsm list

Вывод списка выделенных устройств HSM в подписке, включая оплату HSM

az dedicated-hsm list

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--top

Максимальное количество возвращаемых результатов.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az dedicated-hsm list-outbound-network-dependency-endpoint

Возвращает список конечных точек исходящего трафика (сетевых конечных точек всех исходящих зависимостей) в указанном выделенном ресурсе hsm. Операция возвращает свойства каждой конечной точки исходящего трафика.

az dedicated-hsm list-outbound-network-dependency-endpoint --name
                                                           --resource-group

Примеры

Вывод списка outboundNetworkDependenciesEndpoints по управляемому кластеру

az dedicated-hsm list-outbound-network-dependency-endpoint --name "hsm1" --resource-group "hsm-group"

Обязательные параметры

--name

Имя выделенного HSM.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az dedicated-hsm show

Возвращает указанный выделенный HSM Azure.

az dedicated-hsm show [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Примеры

Получение выделенного устройства HSM

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

Получение оплаты HSM

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

Получение оплаты HSM с версией API 2018-10-31Preview

az dedicated-hsm show --name "hsm1" --resource-group "hsm-group"

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--name

Имя выделенного HSM.

Свойство Значение
Parameter group: Resource Id Arguments
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Parameter group: Resource Id Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az dedicated-hsm update

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

az dedicated-hsm update [--ids]
                        [--name]
                        [--no-wait]
                        [--resource-group]
                        [--subscription]
                        [--tags]

Примеры

Обновление существующего выделенного устройства HSM

az dedicated-hsm update --name "hsm1" --tags Dept="hsm" Environment="dogfood" Slice="A" --resource-group "hsm-group"

Обновление существующего HSM для оплаты

az dedicated-hsm update --name "hsm1" --tags Dept="hsm" Environment="dogfood" Slice="A" --resource-group "hsm-group"

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--name

Имя выделенного устройства HSM.

Свойство Значение
Parameter group: Resource Id Arguments
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Parameter group: Resource Id Arguments
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az dedicated-hsm wait

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

az dedicated-hsm wait [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--ids]
                      [--interval]
                      [--name]
                      [--resource-group]
                      [--subscription]
                      [--timeout]
                      [--updated]

Примеры

Приостанавливает выполнение следующей строки скрипта CLI до тех пор, пока выделенный hsm не будет успешно создан.

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --created

Приостанавливает выполнение следующей строки скрипта CLI до успешного обновления выделенного hsm.

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --updated

Приостанавливайте выполнение следующей строки скрипта CLI до тех пор, пока выделенный hsm не будет успешно удален.

az dedicated-hsm wait --name "hsm1" --resource-group "hsm-group" --deleted

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

Свойство Значение
Parameter group: Wait Condition Arguments
--deleted

Дождитесь удаления.

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--exists

Подождите, пока ресурс не существует.

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Parameter group: Resource Id Arguments
--interval

Интервал опроса в секундах.

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 30
--name

Имя выделенного HSM.

Свойство Значение
Parameter group: Resource Id Arguments
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Parameter group: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Parameter group: Resource Id Arguments
--timeout

Максимальное ожидание в секундах.

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Свойство Значение
Parameter group: Wait Condition Arguments
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False