Dela via

az iot ops schema registry

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 az iot ops-schemaregisterkommando . Läs mer om tillägg.

Schemaregisterhantering.

Ett schemaregister är en centraliserad lagringsplats för att hantera scheman. Schemaregistret möjliggör schemagenerering och hämtning både vid gränsen och i molnet. Det säkerställer konsekvens och kompatibilitet mellan system genom att tillhandahålla en enda sanningskälla för schemadefinitioner.

Kommandon

Name Description Typ Status
az iot ops schema registry create

Skapa ett schemaregister.

 Extension GA
az iot ops schema registry delete

Ta bort ett målschemaregister.

 Extension GA
az iot ops schema registry list

Lista schemaregister i en resursgrupp eller prenumeration.

 Extension GA
az iot ops schema registry show

Visa information om ett schemaregister.

 Extension GA

az iot ops schema registry create

Skapa ett schemaregister.

Den här åtgärden skapar ett schemaregister med systemhanterad identitet aktiverad.

Den tilldelar sedan systemidentiteten den inbyggda rollen "Storage Blob Data Contributor" mot containeromfånget för lagringskontot som standard. Om det behövs kan du ange en anpassad roll via --custom-role-id att använda i stället.

Om den angivna lagringskontocontainern inte finns skapas den med standardinställningarna.

Den här åtgärden registrerar även resursprovidern Microsoft.DeviceRegistry om den inte är registrerad.

az iot ops schema registry create --name
                                  --registry-namespace --rn
                                  --resource-group
                                  --sa-resource-id
                                  [--custom-role-id]
                                  [--desc]
                                  [--display-name]
                                  [--location]
                                  [--sa-container]
                                  [--skip-ra {false, true}]
                                  [--tags]

Exempel

Skapa ett schemaregister med namnet "myregistry" med minsta antal indata.

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID

Skapa ett schemaregister med namnet "myregistry" i regionen westus2 med ytterligare anpassning.

az iot ops schema registry create -n myregistry -g myresourcegroup --registry-namespace myschemas --sa-resource-id $STORAGE_ACCOUNT_RESOURCE_ID --sa-container myschemacontainer -l westus2 --desc 'Contoso factory X1 schemas' --display-name 'Contoso X1' --tags env=prod

Obligatoriska parametrar

--name -n

Schemaregisternamn.

--registry-namespace --rn

Schemaregisternamnområde. Identifierar unikt ett schemaregister i en klientorganisation.

--resource-group -g

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

--sa-resource-id

Resurs-ID för lagringskonto som ska användas med schemaregistret.

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

Beskrivning av schemaregistret.

--display-name

Visningsnamn för schemaregistret.

--location -l

Region för att skapa schemaregistret. Om ingen plats anges används resursgruppens plats.

--sa-container

Lagringskontots containernamn där scheman ska lagras.

Egenskap Värde
Standardvärde: schemas
--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
--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 schema registry delete

Ta bort ett målschemaregister.

az iot ops schema registry delete --name
                                  [--resource-group]
                                  [--yes {false, true}]

Exempel

Ta bort schemaregistret "myregistry".

az iot ops schema registry delete -n myregistry -g myresourcegroup

Obligatoriska parametrar

--name -n

Schemaregisternamn.

Valfria parametrar

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

--resource-group -g

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

--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 schema registry list

Lista schemaregister i en resursgrupp eller prenumeration.

az iot ops schema registry list [--resource-group]

Exempel

Lista schemaregister i resursgruppen "myresourcegroup".

az iot ops schema registry list -g myresourcegroup

Lista schemaregister i standardprenumerationsfiltreringen på en viss tagg.

az iot ops schema registry list --query "[?tags.env == 'prod']"

Valfria parametrar

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

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

az iot ops schema registry show

Visa information om ett schemaregister.

az iot ops schema registry show --name
                                --resource-group

Exempel

Visa information om målschemaregistret "myregistry".

az iot ops schema registry show --name myregistry -g myresourcegroup

Obligatoriska parametrar

--name -n

Schemaregisternamn.

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