az iot ops secretsync secret

Note

Esta referência faz parte da extensão azure-iot-ops para o CLI do Azure (versão 2.70.0 ou superior). A extensão instala-se automaticamente na primeira vez que executares um comando secreto secreto do IoT Ops SecretSync. Saiba mais sobre extensões.

Gerir segredos individuais dentro dos recursos do SecretSync.

Comandos

Name Description Tipo Status
az iot ops secretsync secret list

Liste segredos dentro de um recurso SecretSync.

Extension disponibilidade geral
az iot ops secretsync secret remove

Remova um segredo específico de um recurso SecretSync. Se todos os segredos forem removidos, o próprio recurso SecretSync é automaticamente eliminado.

Extension disponibilidade geral
az iot ops secretsync secret set

Defina os mapeamentos secretos do AKV num recurso SecretSync.

Extension disponibilidade geral

az iot ops secretsync secret list

Liste segredos dentro de um recurso SecretSync.

az iot ops secretsync secret list --instance
                                  --resource-group
                                  --secret-sync-name

Exemplos

Liste segredos num recurso específico do SecretSync.

az iot ops secretsync secret list --instance myInstance -g myRG --secret-sync-name my-certs

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

--secret-sync-name

Nome do recurso SecretSync.

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 de assinatura. 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 secret remove

Remova um segredo específico de um recurso SecretSync. Se todos os segredos forem removidos, o próprio recurso SecretSync é automaticamente eliminado.

Remove a entrada secreta do objectSecretMapping do SecretSync. Se este for o último segredo no SecretSync, todo o recurso SecretSync será eliminado, uma vez que a API ARM não permite um SecretSync sem nenhum mapeamento secreto.

Antes de remover o segredo do SPC partilhado, é realizada uma verificação de contagem de referências em todos os SecretSyncs na localização personalizada. A entrada do SPC só é removida se nenhum outro SecretSync fizer referência ao mesmo segredo AKV. Isto impede que outros consumidores do SPC partilhado quebrem a sua existência.

Este comando NÃO apaga o segredo do Azure Key Vault.

az iot ops secretsync secret remove --instance
                                    --resource-group
                                    --secret-name
                                    --secret-sync-name
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--yes {false, true}]

Exemplos

Remove um segredo de um SecretSync.

az iot ops secretsync secret remove --instance myInstance -g myRG --secret-sync-name my-certs --secret-name my-tls-cert

Remover um segredo sem que o pedido de confirmação.

az iot ops secretsync secret remove --instance myInstance -g myRG --secret-sync-name my-certs --secret-name my-tls-cert -y

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

--secret-name

Nome secreto do AKV (valor sourcePath) para remover do SecretSync.

--secret-sync-name

Nome do recurso SecretSync.

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
--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 de assinatura. 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 secret set

Defina os mapeamentos secretos do AKV num recurso SecretSync.

Resolve a classe de fornecedor de segredos (SPC) por defeito da instância, verifica a existência de cada segredo AKV, adiciona cada segredo à lista de objetos do SPC e cria ou funde entradas no recurso SecretSync nomeado.

Se o SecretSync já existir, novas entradas secretas são integradas nele. Entradas existentes com o mesmo nome secreto AKV terão a sua chave alvo atualizada.

O valor --secret-sync-name torna-se o nome secreto K8s. Os consumidores referenciam-no para <secret-sync-name>/<target-key> endpoints de dispositivos, ou apenas <secret-sync-name> para endpoints de fluxo de dados.

az iot ops secretsync secret set --instance
                                 --resource-group
                                 --secret-map
                                 --secret-sync-name
                                 [--acquire-policy-token]
                                 [--change-reference]

Exemplos

Crie um SecretSync para endpoint de dispositivo x509 cert auth.

az iot ops secretsync secret set --instance myInstance -g myRG --secret-sync-name my-certs --secret-map my-tls-cert=certificate --secret-map my-tls-key=privateKey

Adicionar outro segredo a um SecretSync existente (fusão idempotente).

az iot ops secretsync secret set --instance myInstance -g myRG --secret-sync-name my-certs --secret-map my-intermediate-cert=intermediateCerts

Crie um SecretSync para endpoint de fluxo de dados baseado em SASL.

az iot ops secretsync secret set --instance myInstance -g myRG --secret-sync-name eventhub-sasl --secret-map my-eh-user=username --secret-map my-eh-pass=password

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

--secret-map

Mapeamento secreto AKV no formato <akv-secret-name>=<target-key>. Repetível. O segredo do AKV tem de existir.

--secret-sync-name

Nome para o recurso SecretSync ARM e o secreto K8s resultante.

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