az iot ops secretsync secret

Anmärkning

Den här referensen är en del av tillägget azure-iot-ops för Azure CLI (version 2.70.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az iot ops secretsync-hemligt kommando. Läs mer om tillägg.

Hantera enskilda hemligheter i SecretSync-resurser.

Kommandon

Name Description Typ Status
az iot ops secretsync secret list

Lista hemligheter i en SecretSync-resurs.

Extension GA
az iot ops secretsync secret remove

Ta bort en specifik hemlighet från en SecretSync-resurs. Om alla hemligheter tas bort tas själva SecretSync-resursen bort automatiskt.

Extension GA
az iot ops secretsync secret set

Ange AKV-hemliga mappningar på en SecretSync-resurs.

Extension GA

az iot ops secretsync secret list

Lista hemligheter i en SecretSync-resurs.

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

Exempel

Lista hemligheter i en specifik SecretSync-resurs.

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

Obligatoriska parametrar

--instance -i -n

IoT Operations-instansens namn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--secret-sync-name

Namnet på SecretSync-resursen.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az iot ops secretsync secret remove

Ta bort en specifik hemlighet från en SecretSync-resurs. Om alla hemligheter tas bort tas själva SecretSync-resursen bort automatiskt.

Tar bort den hemliga posten från SecretSyncs objectSecretMapping. Om det här är den sista hemligheten i SecretSync tas hela SecretSync-resursen bort eftersom ARM-API:et inte tillåter en SecretSync utan hemliga mappningar.

Innan du tar bort hemligheten från den delade SPC:n utförs en kontroll av antal referenser över alla SecretSyncs på den anpassade platsen. SPC-posten tas bara bort om ingen annan SecretSync fortfarande refererar till samma AKV-hemlighet. Detta förhindrar att andra användare av den delade SPC:n bryts.

Det här kommandot tar INTE bort hemligheten från 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}]

Exempel

Ta bort en hemlighet från en SecretSync.

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

Ta bort en hemlighet utan bekräftelsefråga.

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

Obligatoriska parametrar

--instance -i -n

IoT Operations-instansens namn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--secret-name

AKV-hemligt namn (sourcePath-värde) för att ta bort från SecretSync.

--secret-sync-name

Namnet på SecretSync-resursen.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--yes -y

Bekräfta [y]es utan att fråga. Användbart för CI- och automationsscenarier.

Egenskap Värde
Godkända värden: false, true
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False

az iot ops secretsync secret set

Ange AKV-hemliga mappningar på en SecretSync-resurs.

Löser instansens standardhemlighetsproviderklass (SPC), verifierar att varje AKV-hemlighet finns, lägger till varje hemlighet i SPC:s objektlista och skapar eller sammanfogar poster till den namngivna SecretSync-resursen.

Om SecretSync redan finns sammanfogas nya hemliga poster i den. Befintliga poster med samma AKV-hemliga namn kommer att få sin målnyckel uppdaterad.

Värdet --secret-sync-name blir K8s hemliga namn. Konsumenter refererar till det via <secret-sync-name>/<target-key> för enhetsslutpunkter eller bara <secret-sync-name> för dataflödesslutpunkter.

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

Exempel

Skapa en SecretSync för enhetsslutpunkten 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

Lägg till ytterligare en hemlighet i en befintlig SecretSync (idempotent sammanslagning).

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

Skapa en SecretSync för SASL-baserad dataflödesslutpunkt.

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

Obligatoriska parametrar

--instance -i -n

IoT Operations-instansens namn.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.

--secret-map

AKV-hemlighetsmappning i formatet <akv-secret-name>=<target-key>. Repeterbar. AKV-hemligheten måste finnas.

--secret-sync-name

Namn på SecretSync ARM-resursen och den resulterande K8-hemligheten.

Valfria parametrar

Följande parametrar är valfria, men beroende på sammanhanget kan en eller flera krävas för att kommandot ska kunna köras.

--acquire-policy-token

Hämtar en Azure Policy token automatiskt för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
--change-reference

Det relaterade ändringsreferens-ID:t för den här resursåtgärden.

Egenskap Värde
Parametergrupp: Global Policy Arguments
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

Egenskap Värde
Standardvärde: False
--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

Egenskap Värde
Standardvärde: False
--output -o

Utdataformat.

Egenskap Värde
Standardvärde: json
Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

Egenskap Värde
Standardvärde: False