az iot ops secretsync secret

Annotazioni

Questo riferimento fa parte dell'estensione azure-iot-ops per l'interfaccia della riga di comando di Azure (versione 2.70.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az iot ops secretsync. Altre informazioni sulle estensioni.

Gestire i singoli segreti all'interno delle risorse SecretSync.

Comandi

Nome Descrizione Tipo Status
az iot ops secretsync secret list

Elencare i segreti all'interno di una risorsa SecretSync.

Estensione GA
az iot ops secretsync secret remove

Rimuovere un segreto specifico da una risorsa SecretSync. Se tutti i segreti vengono rimossi, la risorsa SecretSync viene eliminata automaticamente.

Estensione GA
az iot ops secretsync secret set

Impostare i mapping dei segreti AKV in una risorsa SecretSync.

Estensione GA

az iot ops secretsync secret list

Elencare i segreti all'interno di una risorsa SecretSync.

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

Esempio

Elencare i segreti in una risorsa SecretSync specifica.

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

Parametri necessari

--instance -i -n

Nome dell'istanza di IoT Operations.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--secret-sync-name

Nome della risorsa SecretSync.

Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az iot ops secretsync secret remove

Rimuovere un segreto specifico da una risorsa SecretSync. Se tutti i segreti vengono rimossi, la risorsa SecretSync viene eliminata automaticamente.

Rimuove la voce del segreto dall'oggetto SecretSyncSecretMapping. Se si tratta dell'ultimo segreto in SecretSync, l'intera risorsa SecretSync verrà eliminata perché l'API ARM non consente un SecretSync con mapping di segreti zero.

Prima di rimuovere il segreto dal provider di servizi condivisi, viene eseguito un controllo del conteggio dei riferimenti in tutti i SecretSyncs nella posizione personalizzata. La voce SPC viene rimossa solo se nessun altro SecretSync fa ancora riferimento allo stesso segreto AKV. Ciò impedisce l'interruzione di altri consumer del provider di servizi condivisi.

Questo comando non elimina il segreto da 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}]

Esempio

Rimuovere un segreto da SecretSync.

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

Rimuovere un segreto senza richiesta di conferma.

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

Parametri necessari

--instance -i -n

Nome dell'istanza di IoT Operations.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--secret-name

Nome del segreto AKV (valore sourcePath) da rimuovere da SecretSync.

--secret-sync-name

Nome della risorsa SecretSync.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--yes -y

Confermare [y]es senza una richiesta. Utile per scenari di integrazione continua e automazione.

Proprietà Valore
Valori accettati: false, true
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False

az iot ops secretsync secret set

Impostare i mapping dei segreti AKV in una risorsa SecretSync.

Risolve la classe del provider di segreti (SPC) predefinita dell'istanza, verifica che ogni segreto AKV esista, aggiunga ogni segreto all'elenco di oggetti SPC e crea o unisce le voci nella risorsa SecretSync denominata.

Se SecretSync esiste già, le nuove voci dei segreti vengono unite. Le voci esistenti con lo stesso nome del segreto AKV avranno la chiave di destinazione aggiornata.

Il valore --secret-sync-name diventa il nome del segreto K8s. I consumer lo fanno riferimento tramite <secret-sync-name>/<target-key> per gli endpoint del dispositivo o solo <secret-sync-name> per gli endpoint del flusso di dati.

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

Esempio

Creare un secretSync per l'autenticazione del certificato x509 dell'endpoint del dispositivo.

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

Aggiungere un altro segreto a un secretSync esistente (merge idempotente).

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

Creare un secretSync per l'endpoint del flusso di dati basato su 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

Parametri necessari

--instance -i -n

Nome dell'istanza di IoT Operations.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--secret-map

Mapping dei segreti AKV nel formato <akv-secret-name>=<target-key>. Ripetibile. Il segreto AKV deve esistere.

--secret-sync-name

Nome della risorsa ARM SecretSync e del segreto K8s risultante.

Parametri facoltativi

I seguenti parametri sono facoltativi, ma a seconda del contesto, uno o più di questi potrebbero diventare necessari per l'esecuzione corretta del comando.

--acquire-policy-token

Acquisizione automatica di un token Criteri di Azure per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
--change-reference

ID riferimento di modifica correlato per questa operazione di risorsa.

Proprietà Valore
Gruppo di parametri: Global Policy Arguments
Parametri globali
--debug

Aumentare la verbosità dei log per visualizzare tutti i log di debug.

Proprietà Valore
Valore predefinito: False
--help -h

Mostra questo messaggio Guida, esci.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

Proprietà Valore
Valore predefinito: False
--output -o

Formato dell'output.

Proprietà Valore
Valore predefinito: json
Valori accettati: json, jsonc, none, table, tsv, yaml, yamlc
--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumentare il livello di dettaglio della registrazione. Usare --debug per log di debug completi.

Proprietà Valore
Valore predefinito: False