az cloudhsm

Observação

Esta referência faz parte da extensão cloudhsm para o CLI do Azure (versão 2.70.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az cloudhsm . Saiba mais sobre extensões.

Gerencie o Cloud Hsm Cluster.

Comandos

Nome Descrição Tipo Estado
az cloudhsm backup

Gerencie o backup do Cloud HSM.

 Extensão Preview
az cloudhsm backup show

Obtenha o estado da operação de backup do Cloud HSM Cluster especificado.

 Extensão Preview
az cloudhsm backup start

Inicie um backup do Cloud HSM.

 Extensão Preview
az cloudhsm create

Crie um HSM na nuvem.

 Extensão Preview
az cloudhsm delete

Exclua um HSM na nuvem.

 Extensão Preview
az cloudhsm list

Liste HSMs na nuvem.

 Extensão Preview
az cloudhsm restore

Restaure um backup de um HSM na nuvem.

 Extensão Preview
az cloudhsm restore show

Obtenha o estado da operação de restauro do Cloud HSM Cluster especificado.

 Extensão Preview
az cloudhsm restore start

Restaure um backup de um HSM na nuvem.

 Extensão Preview
az cloudhsm show

Mostrar detalhes de um HSM na nuvem.

 Extensão Preview
az cloudhsm update

Atualize as propriedades de um HSM na nuvem.

 Extensão Preview

az cloudhsm create

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Crie um HSM na nuvem.

az cloudhsm create --name
                   --resource-group
                   [--acquire-policy-token]
                   [--change-reference]
                   [--domain-label-scope --domain-name-label-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
                   [--location]
                   [--mi-user-assigned]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--sku {Standard B10, Standard_B1, Standard_B10v2, Standard_B15v2, Standard_B1v2, Standard_B20v2, Standard_B5v2}]
                   [--tags]

Exemplos

Crie o Cloud HSM com identidade gerenciada atribuída ao usuário

az cloudhsm create --resource-group rgcloudhsm --name chsm1 --location eastus2 --sku Standard_B1 --tags Department=Accounting --domain-name-label-scope "TenantReuse" --mi-user-assigned /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm /providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity

Parâmetros Obrigatórios

--name -n

O nome do Cloud HSM Cluster dentro do grupo de recursos especificado. Os nomes do Cloud HSM Cluster devem ter entre 3 e 23 caracteres.

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

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--domain-label-scope --domain-name-label-scope

O escopo de rótulo de nome de domínio gerado automaticamente pelo Cloud HSM Cluster.

Propriedade Valor
Grupo de parâmetros: Properties Arguments
Valores aceites: NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse
--location -l

A localização geográfica onde o recurso reside Quando não especificada, a localização do grupo de recursos será usada.

Propriedade Valor
Grupo de parâmetros: Body Arguments
--mi-user-assigned

Defina as identidades gerenciadas pelo usuário. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

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

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

Propriedade Valor
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--sku

Nome da sku do Cloud HSM Cluster.

Propriedade Valor
Grupo de parâmetros: Sku Arguments
Valor predefinido: Standard_B1
Valores aceites: Standard B10, Standard_B1, Standard_B10v2, Standard_B15v2, Standard_B1v2, Standard_B20v2, Standard_B5v2
--tags

Tags de recursos. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

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

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

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: 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
Valor predefinido: False

az cloudhsm delete

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Exclua um HSM na nuvem.

az cloudhsm delete [--acquire-policy-token]
                   [--change-reference]
                   [--ids]
                   [--name]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--resource-group]
                   [--subscription]
                   [--yes]

Exemplos

Excluir um HSM na nuvem

az cloudhsm delete --resource-group rgcloudhsm --name chsm1

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.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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 -n

O nome do Cloud HSM Cluster dentro do grupo de recursos especificado. Os nomes do Cloud HSM Cluster devem ter entre 3 e 23 caracteres.

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
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--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
Valor predefinido: False
Parâmetros de Globais
--debug

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

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: 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
Valor predefinido: False

az cloudhsm list

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Liste HSMs na nuvem.

az cloudhsm list [--max-items]
                 [--next-token]
                 [--resource-group]

Exemplos

Mostrar todos os HSMs na nuvem na assinatura selecionada

az cloudhsm list
az cloudhsm list --subscription subId

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.

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token em --next-token argumento de um comando subsequente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

Propriedade Valor
Grupo de parâmetros: Pagination Arguments
--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
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: 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
Valor predefinido: False

az cloudhsm show

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Mostrar detalhes de um HSM na nuvem.

az cloudhsm show [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

Exemplos

Mostrar detalhes de um HSM na nuvem.

az cloudhsm show --resource-group rgcloudhsm --name chsm1

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

O nome do Cloud HSM Cluster dentro do grupo de recursos especificado. Os nomes do Cloud HSM Cluster devem ter entre 3 e 23 caracteres.

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
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: 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
Valor predefinido: False

az cloudhsm update

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Atualize as propriedades de um HSM na nuvem.

az cloudhsm update [--acquire-policy-token]
                   [--change-reference]
                   [--ids]
                   [--mi-user-assigned]
                   [--name]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--resource-group]
                   [--subscription]
                   [--tags]

Exemplos

Atualizar as propriedades de um HSM na nuvem

az cloudhsm update --name chsm1 --resource-group myrg --tags Department=Accounting

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.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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
--mi-user-assigned

Defina as identidades gerenciadas pelo usuário. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Propriedade Valor
Grupo de parâmetros: Identity Arguments
--name -n

O nome do Cloud HSM Cluster dentro do grupo de recursos especificado. Os nomes do Cloud HSM Cluster devem ter entre 3 e 23 caracteres.

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
Valores aceites: 0, 1, f, false, n, no, t, true, y, yes
--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

As tags do Cloud HSM Cluster suportam sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

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

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

Propriedade Valor
Valor predefinido: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor predefinido: False
--output -o

Formato de saída.

Propriedade Valor
Valor predefinido: 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
Valor predefinido: False