Partilhar via

az dedicated-hsm

Note

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

Name Description Tipo Status
az dedicated-hsm create

Crie um HSM dedicado na assinatura especificada.

 Extension disponibilidade geral
az dedicated-hsm delete

Exclui o HSM Dedicado do Azure especificado.

 Extension disponibilidade geral
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.

 Extension disponibilidade geral
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.

 Extension disponibilidade geral
az dedicated-hsm show

Obtém o HSM dedicado do Azure especificado.

 Extension disponibilidade geral
az dedicated-hsm update

Atualize um HSM dedicado na assinatura especificada.

 Extension disponibilidade geral
az dedicated-hsm wait

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

 Extension disponibilidade geral

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 atualizar um existente

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 atualizar um existente

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 atualizar um HSM de pagamento existente 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 Obrigatórios

--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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--location -l

Location. 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 recursos 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.

Propriedade Valor
Grupo de parâmetros: Management Network Profile Arguments
--mgmt-network-subnet

Especifica o identificador da sub-rede.

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

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

Propriedade Valor
Grupo de parâmetros: Management Network Profile Arguments
--network-interfaces -i

Especifica a lista de IDs de recursos 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.

Propriedade Valor
Grupo de parâmetros: Network Profile Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--sku

SKU do HSM dedicado.

Propriedade Valor
Grupo de parâmetros: Sku Arguments
Valores aceites: 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

Este campo será usado quando o RP não suportar zonas de disponibilidade.

--subnet

Especifica o identificador da sub-rede.

Uso: --subnet id=XX

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

Propriedade Valor
Grupo de parâmetros: Network Profile Arguments
--tags

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

--zones

As zonas Hsm dedicadas.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name

O nome do HSM dedicado a ser excluído.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

Propriedade Valor
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--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 devolver.

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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 Obrigatórios

--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 de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az dedicated-hsm show

Obtém o HSM dedicado do Azure especificado.

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

Exemplos

Obtenha um HSM dedicado

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

Obter um pagamento HSM

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

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

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name

O nome do HSM dedicado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name

Nome do HSM dedicado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--no-wait

Não espere que a operação de longa duração termine.

Propriedade Valor
Default value: False
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--tags

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

Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

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 CLI até que o dedicated-hsm 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 CLI até que o dedicated-hsm 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 CLI até que o dedicated-hsm seja excluído com êxito.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--custom

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 30
--name

O nome do HSM dedicado.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Default value: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False