Dela via


az iot ops schema

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-schemakommando . Läs mer om tillägg.

Schemaregister- och schemahantering.

Scheman är dokument som beskriver data för att möjliggöra bearbetning och kontextualisering. Meddelandescheman beskriver formatet på ett meddelande och dess innehåll. Ett schemaregister krävs för att skapa och hantera scheman.

Kommandon

Name Description Typ Status
az iot ops schema create

Skapa ett schema i ett schemaregister.

Extension GA
az iot ops schema delete

Ta bort ett målschema i ett schemaregister.

Extension GA
az iot ops schema list

Lista scheman i ett schemaregister.

Extension GA
az iot ops schema registry

Schemaregisterhantering.

Extension GA
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 show

Visa information om ett schema i ett schemaregister.

Extension GA
az iot ops schema show-dataflow-refs

Visa de schemareferenser som används för dataflöden.

Extension Experimental
az iot ops schema version

Schemaversionshantering.

Extension GA
az iot ops schema version add

Lägg till en schemaversion i ett schema.

Extension GA
az iot ops schema version list

Lista schemaversioner för ett visst schema.

Extension GA
az iot ops schema version remove

Ta bort en målschemaversion.

Extension GA
az iot ops schema version show

Visa information om en schemaversion.

Extension GA

az iot ops schema create

Skapa ett schema i ett schemaregister.

Den här åtgärden kräver ett fördefinierad schemaregister och lägger till en schemaversion. För att kunna skapa schemat och lägga till en version måste det associerade lagringskontot ha åtkomst till det offentliga nätverket aktiverat. Mer information om deltafilformatet finns i aka.ms/lakehouse-delta-sample.

az iot ops schema create --format {delta, json}
                         --name
                         --registry
                         --resource-group
                         --type {message}
                         --vc --version-content
                         [--desc]
                         [--display-name]
                         [--vd --version-desc]
                         [--ver --version]

Exempel

Skapa ett schema med namnet "myschema" i registret "myregistry" med minsta antal indata. Schemaversion 1 skapas för det här schemat med filinnehållet.

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content myschema.json

Skapa ett schema med namnet "myschema" med ytterligare anpassning. Schemaversion 14 skapas för det här schemat. Det infogade innehållet är ett exempel på bash-syntax. Fler exempel finns i https://aka.ms/inline-json-examples

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format delta --type message --desc "Schema for Assets" --display-name myassetschema --version-content '{"hello": "world"}' --ver 14 --vd "14th version"

Obligatoriska parametrar

--format

Schemaformat.

Egenskap Värde
Godkända värden: delta, json
--name -n

Schemanamn.

--registry

Schemaregisternamn.

--resource-group -g

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

--type

Schematyp.

Egenskap Värde
Godkända värden: message
--vc --version-content

Filsökväg som innehåller eller infogat innehåll för versionen.

Egenskap Värde
Parameter group: Version Arguments

Valfria parametrar

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

--desc

Beskrivning av schemat.

--display-name

Visningsnamn för schemat.

--vd --version-desc

Beskrivning av versionen.

Egenskap Värde
Parameter group: Version Arguments
--ver --version

Schemaversionsnamn.

Egenskap Värde
Parameter group: Version Arguments
Standardvärde: 1
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 delete

Ta bort ett målschema i ett schemaregister.

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

Exempel

Ta bort ett målschema "myschema" i ett schemaregister "myregistry".

az iot ops schema delete --name myschema --registry myregistry -g myresourcegroup

Obligatoriska parametrar

--name -n

Schemanamn.

--registry

Schemaregisternamn.

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

Lista scheman i ett schemaregister.

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

Exempel

Lista schemaregister i schemaregistret "myregistry".

az iot ops schema list -g myresourcegroup --registry myregistry

Obligatoriska parametrar

--registry

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

az iot ops schema show

Visa information om ett schema i ett schemaregister.

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

Exempel

Visa information om målschemat "myschema" i ett schemaregister "myregistry".

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

Obligatoriska parametrar

--name -n

Schemanamn.

--registry

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

az iot ops schema show-dataflow-refs

Experimentell

Det här kommandot är experimentellt och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Visa de schemareferenser som används för dataflöden.

az iot ops schema show-dataflow-refs --registry
                                     --resource-group
                                     [--latest {false, true}]
                                     [--schema]
                                     [--ver --version]

Exempel

Visa schemareferens för schemat "myschema" och version 1.

az iot ops schema show-dataflow-refs --version 1 --schema myschema --registry myregistry -g myresourcegroup

Visa schemareferens för alla versioner i schemat "myschema".

az iot ops schema show-dataflow-refs --schema myschema --registry myregistry -g myresourcegroup

Visa schemareferens för alla versioner och scheman i schemaregistret "myregistry".

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup

Visa schemareferens för alla scheman men bara de senaste versionerna i schemaregistret "myregistry".

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup --latest

Obligatoriska parametrar

--registry

Schemaregisternamn.

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

--latest

Flagga för att endast visa de senaste versionerna.

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

Schemanamn. Krävs om du använder --version.

--ver --version

Schemaversionsnamn. Om det används ignoreras --latest.

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