az iot ops secretsync
Note
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 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 secret |
Hantera enskilda hemligheter i SecretSync-resurser. |
Extension | GA |
| 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 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
[--acquire-policy-token]
[--change-reference]
[--yes {false, true}]
Exempel
Inaktivera hemlig synkronisering för en instans.
az iot ops secretsync disable --instance myinstance -g myresourcegroup
Obligatoriska parametrar
IoT Operations-instansens namn.
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
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.
Hämtar en Azure Policy token automatiskt för den här resursåtgärden.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Global Policy Arguments |
Det relaterade ändringsreferens-ID:t för den här resursåtgärden.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Global Policy Arguments |
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
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Ö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 Läsare, Key Vault Secrets User) för den hanterade identiteten mot målet 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
[--acquire-policy-token]
[--change-reference]
[--custom-role-id]
[--self-hosted-issuer {false, true}]
[--skip-ra {false, true}]
[--spc]
[--tags]
Exempel
Aktivera målinstansen för Key Vault hemlig synkronisering.
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
IoT Operations-instansens namn.
Key Vault ARM-resurs-ID.
Resurs-ID för önskad användartilldelad hanterad identitet som ska användas med instansen.
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
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.
Hämtar en Azure Policy token automatiskt för den här resursåtgärden.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Global Policy Arguments |
Det relaterade ändringsreferens-ID:t för den här resursåtgärden.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Global Policy Arguments |
Fullständigt kvalificerat rolldefinitions-ID i följande format: /subscriptions/{subscriptionId}/providers/Microsoft. Authorization/roleDefinitions/{roleId}.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Role Assignment Arguments |
Använd den lokalt installerade oidc-utfärdaren för federation.
| Egenskap | Värde |
|---|---|
| Godkända värden: | false, true |
När den används hoppas åtgärdens rolltilldelningssteg över.
| Egenskap | Värde |
|---|---|
| Parametergrupp: | Role Assignment Arguments |
| Godkända värden: | false, true |
Standardnamnet för hemlighetsproviderns klass för aktivering av hemlig synkronisering. Standardmönstret är "spc-ops-{hash}".
Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Ö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
IoT Operations-instansens namn.
Namn på resursgrupp. Du kan konfigurera standardgruppen med hjälp av az configure --defaults group=<name>.
Globala parametrar
Öka loggningsverositeten för att visa alla felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Visa det här hjälpmeddelandet och avsluta.
Visa bara fel och ignorera varningar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |
Utdataformat.
| Egenskap | Värde |
|---|---|
| Standardvärde: | json |
| Godkända värden: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.
Namn eller ID för prenumeration. Du kan konfigurera standardprenumerationen med hjälp av az account set -s NAME_OR_ID.
Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.
| Egenskap | Värde |
|---|---|
| Standardvärde: | False |