Compartilhar via

az dedicated-hsm

  • Referência

Observação

Essa referência faz parte da extensão hardware-security-modules para a CLI do Azure (versão 2.15.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az dedicated-hsm . Saiba mais sobre extensões.

Gerencie hsm dedicado com módulos de segurança de hardware.

Comandos

Nome Description Tipo Status
az dedicated-hsm create

Crie um HSM dedicado na assinatura especificada.

 Extensão GA
az dedicated-hsm delete

Exclui o HSM Dedicado do Azure especificado.

 Extensão GA
az dedicated-hsm list

A operação List obtém informações sobre os hsms dedicados associados à assinatura e dentro do grupo de recursos especificado. E a operação List obtém informações sobre os HSMs dedicados associados à assinatura.

 Extensão GA
az dedicated-hsm list-outbound-network-dependency-endpoint

Obtém uma lista de pontos de extremidade de saída (pontos de extremidade de rede de todas as dependências de saída) no recurso hsm dedicado especificado. A operação retorna propriedades de cada ponto de extremidade de saída.

 Extensão GA
az dedicated-hsm show

Obtém o HSM dedicado do Azure especificado.

 Extensão GA
az dedicated-hsm update

Atualize um HSM dedicado na assinatura especificada.

 Extensão GA
az dedicated-hsm wait

Coloque a CLI em um estado de espera até que uma condição do hsm dedicado seja atendida.

 Extensão GA

az dedicated-hsm create

Crie um HSM dedicado na assinatura especificada.

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]

Exemplos

Criar um HSM dedicado novo ou atualizá-lo

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"

Criar um HSM de pagamento novo ou atualizá-lo

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"

Criar um HSM de pagamento novo ou atualizá-lo com perfil de gerenciamento

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"

Parâmetros Exigidos

--name

Nome do Hsm dedicado.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--location -l

Local. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--mgmt-network-interfaces -m

Especifica a lista de IDs de recurso para as interfaces de rede associadas ao HSM dedicado.

Uso: --mgmt-network-interfaces private-ip-address=XX

private-ip-address: Endereço IP privado da interface

Várias ações podem ser especificadas usando mais de um argumento --mgmt-network-interfaces.

--mgmt-network-subnet

Especifica o identificador da sub-rede.

Uso: --mgmt-network-subnet id=XX

id: A ID do recurso ARM na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

--network-interfaces -i

Especifica a lista de IDs de recurso para as interfaces de rede associadas ao HSM dedicado.

Uso: --network-interfaces private-ip-address=XX

private-ip-address: Endereço IP privado da interface

Várias ações podem ser especificadas usando mais de um argumento --network-interfaces.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--sku

SKU do HSM dedicado.

Valores aceitos: 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

Esse campo será usado quando o RP não oferecer suporte a zonas de disponibilidade.

--subnet

Especifica o identificador da sub-rede.

Uso: --subnet id=XX

id: A ID do recurso ARM na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

--zones

As zonas Hsm dedicadas.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dedicated-hsm delete

Exclui o HSM Dedicado do Azure especificado.

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

Exemplos

Excluir um HSM dedicado

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name

O nome do HSM dedicado a ser excluído.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dedicated-hsm list

A operação List obtém informações sobre os hsms dedicados associados à assinatura e dentro do grupo de recursos especificado. E a operação List obtém informações sobre os HSMs dedicados associados à assinatura.

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

Exemplos

Listar dispositivos HSM dedicados em um grupo de recursos

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

Listar dispositivos HSM dedicados em um grupo de recursos, incluindo HSM de pagamento

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

Listar dispositivos HSM dedicados em uma assinatura

az dedicated-hsm list

Listar dispositivos HSM dedicados em uma assinatura, incluindo HSM de pagamento

az dedicated-hsm list

Parâmetros Opcionais

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--top

Número máximo de resultados a serem retornados.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

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

Obtém uma lista de pontos de extremidade de saída (pontos de extremidade de rede de todas as dependências de saída) no recurso hsm dedicado especificado. A operação retorna propriedades de cada ponto de extremidade de saída.

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

Exemplos

Listar OutboundNetworkDependenciesEndpoints por cluster gerenciado

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

Parâmetros Exigidos

--name

O nome do HSM dedicado.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dedicated-hsm show

Obtém o HSM dedicado do Azure especificado.

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

Exemplos

Obter um HSM dedicado

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

Obter um HSM de pagamento

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

Obter um HSM de pagamento com a versão 2018-10-31Preview api

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name

O nome do HSM dedicado.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dedicated-hsm update

Atualize um HSM dedicado na assinatura especificada.

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

Exemplos

Atualizar um HSM dedicado existente

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

Atualizar um HSM de pagamento existente

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name

Nome do HSM dedicado.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valor padrão: False
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az dedicated-hsm wait

Coloque a CLI em um estado de espera até que uma condição do hsm dedicado seja atendida.

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

Exemplos

Pause a execução da próxima linha do script da CLI até que o hsm dedicado seja criado com êxito.

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

Pause a execução da próxima linha do script da CLI até que o hsm dedicado seja atualizado com êxito.

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

Pause a execução da próxima linha do script da CLI até que o hsm dedicado seja excluído com êxito.

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

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

Valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Valor padrão: False
--exists

Aguarde até que o recurso exista.

Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'Resource Id'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--name

O nome do HSM dedicado.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.