az iot central export destination

  • Förhandsgranskning
  • Referens

Kommentar

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

Kommandogruppen "iot central export" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hantera och konfigurera exportmål för IoT Central.

Kommandon

Name Description Typ Status
az iot central export destination create

Skapa ett exportmål för ett IoT Central-program.

 Anknytning Förhandsgranska
az iot central export destination delete

Ta bort ett exportmål för ett IoT Central-program.

 Anknytning Förhandsgranska
az iot central export destination list

Hämta den fullständiga listan över exportmål för ett IoT Central-program.

 Anknytning Förhandsgranska
az iot central export destination show

Hämta information om exportmål.

 Anknytning Förhandsgranska
az iot central export destination update

Uppdatera ett exportmål för ett IoT Central-program.

 Anknytning Förhandsgranska

az iot central export destination create

Förhandsgranskning

Kommandogruppen "iot central export destination" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Skapa ett exportmål för ett IoT Central-program.

az iot central export destination create --app-id
                                         --dest-id
                                         --display-name
                                         --type {blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1}
                                         [--api-version {2022-06-30-preview}]
                                         [--au]
                                         [--central-api-uri]
                                         [--cluster-url]
                                         [--database]
                                         [--header]
                                         [--table]
                                         [--token]
                                         [--url]

Exempel

Skapa ett webhook-exportmål med json-nyttolast

az iot central export destination create --app-id {appid} --dest-id {destinationid} --name {displayname} --url {url} --type webhook@v1 --header '{"x-custom-region":{"value":"westus", "secret": false}}'

Skapa ett exportmål för bloblagring med json-nyttolast

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type blobstorage@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString":"DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=[key];EndpointSuffix=core.windows.net",
  "containerName": "test"
}'

Skapa ett Exportmål för Azure Data Explorer med json-nyttolast

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type dataexplorer@v1 --name {displayname} --cluster-url {clusterurl} --database {database} --table {table} --authorization '{
  "type": "servicePrincipal",
  "clientId": "3b420743-2020-44c6-9b70-cc42f945db0x",
  "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
  "clientSecret": "[Secret]"
}'

Skapa ett händelsehubbexportmål med json-nyttolast

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type eventhubs@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=entityPath1"
}'

Skapa ett Service Bus-kömål med json-nyttolast

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebusqueue@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespance].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
}'

Skapa ett Service Bus Topic-mål med json-nyttolast

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebustopic@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
}'

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.

--dest-id

Unik identifierare för exportmålet.

--display-name --name

Målvisningsnamnet.

--type -t

Måltypen.

accepterade värden: blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1

Valfria parametrar

--api-version --av
Inaktuell

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

API-versionen för den begärda åtgärden.

accepterade värden: 2022-06-30-preview
standardvärde: 2022-06-30-preview
--au --authorization

Auktoriseringskonfigurationen i json.

--central-api-uri --central-dns-suffix

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

standardvärde: azureiotcentral.com
--cluster-url --cu

Azure Data Explorer-kluster-URL:en.

--database

Azure Data Explorer-databasen.

--header

Webhook-måls custimized header-samlingen i json.

--table

Azure Data Explorer-tabellen.

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

--url

Webhookens URL.

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.

accepterade 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 export destination delete

Förhandsgranskning

Kommandogruppen "iot central export destination" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Ta bort ett exportmål för ett IoT Central-program.

az iot central export destination delete --app-id
                                         --dest-id
                                         [--api-version {2022-06-30-preview}]
                                         [--central-api-uri]
                                         [--token]

Exempel

Ta bort ett exportmål

az iot central export destination delete --app-id {appid} --dest-id {destinationid}

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.

--dest-id

Unik identifierare för exportmålet.

Valfria parametrar

--api-version --av
Inaktuell

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

API-versionen för den begärda åtgärden.

accepterade värden: 2022-06-30-preview
standardvärde: 2022-06-30-preview
--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.

accepterade 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 export destination list

Förhandsgranskning

Kommandogruppen "iot central export destination" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hämta den fullständiga listan över exportmål för ett IoT Central-program.

az iot central export destination list --app-id
                                       [--api-version {2022-06-30-preview}]
                                       [--central-api-uri]
                                       [--token]

Exempel

Visa en lista över alla exportmål i ett program

az iot central export destination 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.

API-versionen för den begärda åtgärden.

accepterade värden: 2022-06-30-preview
standardvärde: 2022-06-30-preview
--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.

accepterade 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 export destination show

Förhandsgranskning

Kommandogruppen "iot central export destination" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hämta information om exportmål.

az iot central export destination show --app-id
                                       --dest-id
                                       [--api-version {2022-06-30-preview}]
                                       [--central-api-uri]
                                       [--token]

Exempel

Hämta information om exportmål

az iot central export destination show --app-id {appid} --dest-id {destinationid}

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.

--dest-id

Unik identifierare för exportmålet.

Valfria parametrar

--api-version --av
Inaktuell

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

API-versionen för den begärda åtgärden.

accepterade värden: 2022-06-30-preview
standardvärde: 2022-06-30-preview
--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.

accepterade 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 export destination update

Förhandsgranskning

Kommandogruppen "iot central export destination" är i förhandsversion och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera ett exportmål för ett IoT Central-program.

Måltypen kan inte ändras när den har skapats. Ett nytt mål måste skapas med den nya typen.

az iot central export destination update --app-id
                                         --content
                                         --dest-id
                                         [--api-version {2022-06-30-preview}]
                                         [--central-api-uri]
                                         [--token]

Exempel

Uppdatera ett exportmål från filen

az iot central export destination update --app-id {appid} --dest-id {destinationid} --content './filepath/payload.json'

Uppdatera ett exportmål med json-patch-nyttolast

az iot central export destination update --app-id {appid} --dest-id {destinationid} --content '{"displayName": "Web Hook Updated"}'

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

Den partiella måldefinitionen. 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 delvis innehåll i Målet.

--dest-id

Unik identifierare för exportmålet.

Valfria parametrar

--api-version --av
Inaktuell

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

API-versionen för den begärda åtgärden.

accepterade värden: 2022-06-30-preview
standardvärde: 2022-06-30-preview
--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.

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