Partilhar 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 secreta de instância.

Comandos

Name Description Tipo Status
az iot ops secretsync disable

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

 Extension disponibilidade geral
az iot ops secretsync enable

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

 Extension disponibilidade geral
az iot ops secretsync list

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

 Extension disponibilidade geral

az iot ops secretsync disable

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

Todas as classes de provedor secreto associadas à instância e todas as sincronizações secretas associadas às classes de 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 Obrigatórios

--instance -i -n

Nome da instância de Operações 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 tornar-se necessários para que o comando seja executado com êxito.

--yes -y

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

Propriedade Valor
Valores aceites: false, true
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 iot ops secretsync enable

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

A operação lida com a federação de identidades, a criação de uma classe de provedor secreto padrão e atribuições de função (Key Vault Reader, Key Vault Secrets User) da identidade gerenciada em relação ao Key Vault de destino.

O fluxo começa com a garantia de atribuições de função do Cofre de Chaves, aplicando-as se 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 via --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 a sincronização de segredos do Cofre de Chaves.

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 tags ao criar a classe de provedor secreto 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 o ID da função personalizada no Cofre da Chave.

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 de sinalizador para ignorar atribuições de função do Cofre de Chaves.

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

--instance -i -n

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

--kv-resource-id

ID do recurso ARM do Cofre da Chave.

--mi-user-assigned

O 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 tornar-se necessários para que o comando seja executado com êxito.

--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 aceites: 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 aceites: false, true
--spc

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

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

--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 iot ops secretsync list

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

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

Exemplos

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

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

Parâmetros Obrigatórios

--instance -i -n

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

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