az iot ops secretsync secret

Note

Essa 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 instalará automaticamente na primeira vez que você executar um comando secreto do az iot ops secretsync . Saiba mais sobre extensões.

Gerenciar segredos individuais em recursos SecretSync.

Comandos

Nome Description Tipo Status
az iot ops secretsync secret list

Listar segredos em um recurso SecretSync.

Extension GA
az iot ops secretsync secret remove

Remova um segredo específico de um recurso SecretSync. Se todos os segredos forem removidos, o recurso SecretSync em si será excluído automaticamente.

Extension GA
az iot ops secretsync secret set

Defina mapeamentos de segredo do AKV em um recurso SecretSync.

Extension GA

az iot ops secretsync secret list

Listar segredos em um recurso SecretSync.

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

Exemplos

Listar segredos em um recurso SecretSync específico.

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

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

--secret-sync-name

Nome do recurso SecretSync.

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

Remova um segredo específico de um recurso SecretSync. Se todos os segredos forem removidos, o recurso SecretSync em si será excluído automaticamente.

Remove a entrada secreta do objectSecretMapping do SecretSync. Se esse for o último segredo no SecretSync, todo o recurso SecretSync será excluído, pois a API do ARM não permite um SecretSync sem mapeamentos secretos.

Antes de remover o segredo do SPC compartilhado, uma verificação de contagem de refs é executada em todos os SecretSyncs no local personalizado. A entrada SPC só será removida se nenhum outro SecretSync ainda fizer referência ao mesmo segredo do AKV. Isso impede a interrupção de outros consumidores do SPC compartilhado.

Esse comando NÃO exclui 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

Remova 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

Remova um segredo sem o prompt 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 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>.

--secret-name

Nome do segredo AKV (valor sourcePath) a ser removido 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 se tornar obrigatórios para que o comando seja executado com sucesso.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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

Defina mapeamentos de segredo do AKV em um recurso SecretSync.

Resolve o SPC (classe de provedor de segredo) padrão da instância, verifica se cada segredo do AKV existe, adiciona cada segredo à lista de objetos do SPC e cria ou mescla entradas no recurso SecretSync nomeado.

Se o SecretSync já existir, novas entradas secretas serão mescladas nela. As entradas existentes com o mesmo nome de segredo do AKV terão sua chave de destino atualizada.

O valor --secret-sync-name torna-se o nome do segredo K8s. Os consumidores fazem referência a ele por meio <secret-sync-name>/<target-key> de pontos de extremidade de dispositivo ou apenas <secret-sync-name> para pontos de extremidade 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 autenticação de certificado do ponto de extremidade do dispositivo x509.

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

Adicione outro segredo a um SecretSync existente (mesclagem 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 o ponto de extremidade 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 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>.

--secret-map

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

--secret-sync-name

Nome para o recurso SECRETSync ARM e o segredo K8s resultante.

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.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

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

A ID de referência de alteração relacionada para esta operação de recurso.

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