Compartilhar via

az iot ops secretsync

Note

Essa referência faz parte da extensão azure-iot-ops para a CLI do Azure (versão 2.67.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot ops secretsync . Saiba mais sobre extensões.

Gerenciamento de sincronização de segredo de instância.

Comandos

Nome Description Tipo Status
az iot ops secretsync disable

Desative a sincronização secreta para uma instância.

 Extension GA
az iot ops secretsync enable

Ative a sincronização secreta para uma instância.

 Extension GA
az iot ops secretsync list

Liste as configurações de sincronização de segredo associadas a uma instância.

 Extension GA

az iot ops secretsync disable

Desative a sincronização secreta para uma instância.

Todas as classes do provedor secreto associadas à instância e todas as sincronizações secretas associadas às classes do provedor secreto serão excluídas.

az iot ops secretsync disable --instance
                              --resource-group
                              [--yes {false, true}]

Exemplos

Desative a sincronização secreta para uma instância.

az iot ops secretsync disable --instance myinstance -g myresourcegroup

Parâmetros Exigidos

--instance -i -n

Nome da instância de operações de IoT.

--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 se tornar obrigatórios para que o comando seja executado com sucesso.

--yes -y

Confirme [y] es sem um aviso. Útil para cenários de CI e automação.

Propriedade Valor
Valores aceitos: false, true
Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot ops secretsync enable

Ative a sincronização secreta para uma instância.

A operação manipula a federação de identidade, a criação de uma classe de provedor de segredo padrão e atribuições de função (Leitor do Key Vault, Usuário de Segredos do Key Vault) da identidade gerenciada no Key Vault de destino.

O fluxo começa com a garantia de atribuições de função do Key Vault, aplicando-as se elas não existirem. Um erro será gerado se as atribuições de função não puderem ser feitas. Se necessário, uma função personalizada por meio de --custom-role-id pode ser usada no local das funções internas. Ou o sinalizador --skip-ra pode ser usado para ignorar atribuições de função.

az iot ops secretsync enable --instance
                             --kv-resource-id
                             --mi-user-assigned
                             --resource-group
                             [--custom-role-id]
                             [--self-hosted-issuer {false, true}]
                             [--skip-ra {false, true}]
                             [--spc]
                             [--tags]

Exemplos

Habilite a instância de destino para sincronização secreta do Key Vault.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID

Habilite a sincronização secreta e aplique marcas ao criar a classe de provedor de segredo padrão.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --tags a=b c=d

Habilite a sincronização secreta com a ID de função personalizada no Key Vault.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --custom-role-id $CUSTOM_ROLE_ID

Uso do sinalizador para ignorar as atribuições de função do Key Vault.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --skip-ra

Parâmetros Exigidos

--instance -i -n

Nome da instância de operações de IoT.

--kv-resource-id

ID do recurso do ARM do Key Vault.

--mi-user-assigned

A ID do recurso para a identidade gerenciada atribuída pelo usuário desejada a ser usada com a instância.

--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 se tornar obrigatórios para que o comando seja executado com sucesso.

--custom-role-id

ID de definição de função totalmente qualificada no seguinte formato: /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId}.

Propriedade Valor
Grupo de parâmetros: Role Assignment Arguments
--self-hosted-issuer

Use o emissor oidc auto-hospedado para federação.

Propriedade Valor
Valores aceitos: false, true
--skip-ra

Quando usada, a etapa de atribuição de função da operação será ignorada.

Propriedade Valor
Grupo de parâmetros: Role Assignment Arguments
Valores aceitos: false, true
--spc

O nome da classe do provedor de segredo padrão para habilitação de sincronização secreta. O padrão padrão é 'spc-ops-{hash}'.

--tags

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

Parâmetros Globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False

az iot ops secretsync list

Liste as configurações de sincronização de segredo associadas a uma instância.

az iot ops secretsync list --instance
                           --resource-group

Exemplos

Liste as configurações de sincronização de segredo associadas a uma instância.

az iot ops secretsync list --instance myinstance -g myresourcegroup

Parâmetros Exigidos

--instance -i -n

Nome da instância de operações de IoT.

--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 a verbosidade de log para mostrar todos os logs de depuração.

Propriedade Valor
Valor padrão: False
--help -h

Mostre esta mensagem de ajuda e saia.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceitos: 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 assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

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

Propriedade Valor
Valor padrão: False