Dela via

az iot ops secretsync

Note

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

Hantering av instanshemlighetssynkronisering.

Kommandon

Name Description Typ Status
az iot ops secretsync disable

Inaktivera hemlig synkronisering för en instans.

 Extension GA
az iot ops secretsync enable

Aktivera hemlig synkronisering för en instans.

 Extension GA
az iot ops secretsync list

Visa en lista över de hemliga synkroniseringskonfigurationer som är associerade med en instans.

 Extension GA

az iot ops secretsync disable

Inaktivera hemlig synkronisering för en instans.

Alla hemliga providerklasser som är associerade med instansen och alla hemliga synkroniseringar som är associerade med de hemliga providerklasserna tas bort.

az iot ops secretsync disable --instance
                              --resource-group
                              [--yes {false, true}]

Exempel

Inaktivera hemlig synkronisering för en instans.

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

Obligatoriska parametrar

--instance -i -n

IoT Operations-instansens namn.

--resource-group -g

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

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Aktivera hemlig synkronisering för en instans.

Åtgärden hanterar identitetsfederation, skapande av en standardhemlighetsproviderklass och rolltilldelningar (Key Vault Reader, Key Vault Secrets User) för den hanterade identiteten mot målets Key Vault.

Flödet börjar med att säkerställa Key Vault-rolltilldelningar och tillämpa dem om de inte finns. Ett fel utlöses om rolltilldelningarna inte kan göras. Vid behov kan en anpassad roll via --custom-role-id användas i stället för de inbyggda rollerna. Eller så kan flaggan --skip-ra användas för att hoppa över rolltilldelningar.

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]

Exempel

Aktivera målinstansen för nyckelvalvshemlighetssynkronisering.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID

Aktivera hemlighetssynkronisering och tillämpa taggar när du skapar standardklassen för hemlig provider.

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

Aktivera hemlig synkronisering med anpassat roll-ID mot Key Vault.

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

Användning av flagga för att hoppa över Key Vault-rolltilldelningar.

az iot ops secretsync enable --instance myinstance -g myresourcegroup --mi-user-assigned $UA_MI_RESOURCE_ID --kv-resource-id $KEYVAULT_RESOURCE_ID --skip-ra

Obligatoriska parametrar

--instance -i -n

IoT Operations-instansens namn.

--kv-resource-id

Key Vault ARM-resurs-ID.

--mi-user-assigned

Resurs-ID för önskad användartilldelad hanterad identitet som ska användas med instansen.

--resource-group -g

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

Valfria parametrar

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--custom-role-id

Fullständigt kvalificerat rolldefinitions-ID i följande format: /subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleDefinitions/{roleId}.

Egenskap Värde
Parameter group: Role Assignment Arguments
--self-hosted-issuer

Använd den lokalt installerade oidc-utfärdaren för federation.

Egenskap Värde
Godkända värden: false, true
--skip-ra

När den används hoppas åtgärdens rolltilldelningssteg över.

Egenskap Värde
Parameter group: Role Assignment Arguments
Godkända värden: false, true
--spc

Standardnamnet för hemlighetsproviderns klass för aktivering av hemlig synkronisering. Standardmönstret är "spc-ops-{hash}".

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

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 list

Visa en lista över de hemliga synkroniseringskonfigurationer som är associerade med en instans.

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

Exempel

Visa en lista över de hemliga synkroniseringskonfigurationer som är associerade med en instans.

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

Obligatoriska parametrar

--instance -i -n

IoT Operations-instansens namn.

--resource-group -g

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

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