Dela via


az iot central device-template

Kommentar

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

Hantera och konfigurera enhetsmallar för IoT Central.

Kommandon

Name Description Typ Status
az iot central device-template create

Skapa en enhetsmall i IoT Central.

Anknytning Allmän tillgänglighet
az iot central device-template delete

Ta bort en enhetsmall från IoT Central.

Anknytning Allmän tillgänglighet
az iot central device-template list

Hämta listan över enhetsmallar för ett IoT Central-program.

Anknytning Allmän tillgänglighet
az iot central device-template show

Hämta en enhetsmall från IoT Central.

Anknytning Allmän tillgänglighet
az iot central device-template update

Uppdatera en enhetsmall i IoT Central.

Anknytning Allmän tillgänglighet

az iot central device-template create

Skapa en enhetsmall i IoT Central.

az iot central device-template create --app-id
                                      --content
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Exempel

Skapa en enhetsmall med nyttolastläsning från en fil

az iot central device-template create --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Skapa en enhetsmall med nyttolastläsning från rå json

az iot central device-template create --app-id {appid} --content {json} --device-template-id {devicetemplateid}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--content -k

Enhetsmalldefinitionen. Ange sökväg till JSON-fil eller råsträngad JSON. [Exempel på filsökväg: ./path/to/file.json] [Exempel på strängifierad JSON: {}]. Begärandetexten måste innehålla CapabilityModel.

--device-template-id --dtid

Digital Twin Model Identifier för enhetsmallen. Läs mer på https://aka.ms/iotcentraldtmi.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

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

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot central device-template delete

Ta bort en enhetsmall från IoT Central.

Obs! Detta förväntas misslyckas om några enheter fortfarande är associerade med den här mallen.

az iot central device-template delete --app-id
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Exempel

Ta bort en enhetsmall från IoT Central

az iot central device-template delete --app-id {appid} --device-template-id {devicetemplateid}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--device-template-id --dtid

ID för målenhetsmallen. Exempel: somedevicetemplate.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

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

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot central device-template list

Hämta listan över enhetsmallar för ett IoT Central-program.

az iot central device-template list --app-id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--compact]
                                    [--token]

Exempel

Visa en lista över alla enhetsmallar i ett program, sorterade efter mall-ID (standard)

az iot central device-template list --app-id {appid}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--compact -c

Visa mallar i kompakt läge. För varje mall visas endast ID, namn och modelltyper.

Standardvärde: False
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

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

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot central device-template show

Hämta en enhetsmall från IoT Central.

az iot central device-template show --app-id
                                    --device-template-id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--token]

Exempel

Hämta en enhetsmall

az iot central device-template show --app-id {appid} --device-template-id {devicetemplateid}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--device-template-id --dtid

ID för målenhetsmallen. Exempel: somedevicetemplate.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

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

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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

az iot central device-template update

Uppdatera en enhetsmall i IoT Central.

az iot central device-template update --app-id
                                      --content
                                      --device-template-id
                                      [--api-version {2022-06-30-preview, 2022-07-31}]
                                      [--central-api-uri]
                                      [--token]

Exempel

Uppdatera en enhetsmall med nyttolastläsning från en fil

az iot central device-template update --app-id {appid} --content {pathtofile} --device-template-id {devicetemplateid}

Uppdatera en enhetsmall med nyttolastläsning från rå json

az iot central device-template update --app-id {appid} --content {json} --device-template-id {devicetemplateid}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--content -k

Enhetsmalldefinitionen. Ange sökväg till JSON-fil eller råsträngad JSON. [Exempel på filsökväg: ./path/to/file.json] [Exempel på strängifierad JSON: {}]. Begärandetexten måste innehålla CapabilityModel.

--device-template-id --dtid

ID för målenhetsmallen. Exempel: somedevicetemplate.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

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

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

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

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

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

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