Freigeben über


az iot central export destination

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.46.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot-zentralen Exportzielbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

Die Befehlsgruppe "iot central export" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Verwalten und Konfigurieren von IoT Central-Exportzielen.

Befehle

Name Beschreibung Typ Status
az iot central export destination create

Erstellen Sie ein Exportziel für eine IoT Central-Anwendung.

Erweiterung Vorschau
az iot central export destination delete

Löschen eines Exportziels für eine IoT Central-Anwendung.

Erweiterung Vorschau
az iot central export destination list

Rufen Sie die vollständige Liste der Exportziele für eine IoT Central-Anwendung ab.

Erweiterung Vorschau
az iot central export destination show

Rufen Sie eine Exportzieldetails ab.

Erweiterung Vorschau
az iot central export destination update

Aktualisieren eines Exportziels für eine IoT Central-Anwendung.

Erweiterung Vorschau

az iot central export destination create

Vorschau

Die Befehlsgruppe "iot zentrales Exportziel" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Erstellen Sie ein Exportziel für eine IoT Central-Anwendung.

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]

Beispiele

Erstellen eines Webhook-Exportziels mit json-Nutzlast

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

Erstellen eines BLOB-Speicherexportziels mit json-Nutzlast

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"
}'

Erstellen eines Azure Data Explorer-Exportziels mit json-Nutzlast

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]"
}'

Erstellen eines Event Hub-Exportziels mit json-Nutzlast

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"
}'

Erstellen eines ServiceBus-Warteschlangenziels mit json-Nutzlast

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]"
}'

Erstellen eines ServiceBus-Themenziels mit json-Nutzlast

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]"
}'

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--dest-id

Eindeutiger Bezeichner für das Exportziel.

--display-name --name

Der Anzeigename des Ziels.

--type -t

Der Zieltyp.

Zulässige Werte: blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1

Optionale Parameter

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 2022-06-30-preview
Standardwert: 2022-06-30-preview
--au --authorization

Die Autorisierungskonfiguration in json.

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

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--cluster-url --cu

Die Azure Data Explorer-Cluster-URL.

--database

Die Azure-Daten-Explorer-Datenbank.

--header

Die webhook-Zielkopfzeilensammlung in json.

--table

Die Azure-Daten-Explorer-Tabelle.

--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

--url

Die Webhook-URL.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central export destination delete

Vorschau

Die Befehlsgruppe "iot zentrales Exportziel" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Löschen eines Exportziels für eine IoT Central-Anwendung.

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

Beispiele

Löschen eines Exportziels

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--dest-id

Eindeutiger Bezeichner für das Exportziel.

Optionale Parameter

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 2022-06-30-preview
Standardwert: 2022-06-30-preview
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central export destination list

Vorschau

Die Befehlsgruppe "iot zentrales Exportziel" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Rufen Sie die vollständige Liste der Exportziele für eine IoT Central-Anwendung ab.

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

Beispiele

Alle Exportziele in einer Anwendung auflisten

az iot central export destination list --app-id {appid}

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

Optionale Parameter

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 2022-06-30-preview
Standardwert: 2022-06-30-preview
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central export destination show

Vorschau

Die Befehlsgruppe "iot zentrales Exportziel" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Rufen Sie eine Exportzieldetails ab.

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

Beispiele

Abrufen von Exportzieldetails

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--dest-id

Eindeutiger Bezeichner für das Exportziel.

Optionale Parameter

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 2022-06-30-preview
Standardwert: 2022-06-30-preview
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central export destination update

Vorschau

Die Befehlsgruppe "iot zentrales Exportziel" befindet sich in der Vorschau und in der Entwicklung. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus

Aktualisieren eines Exportziels für eine IoT Central-Anwendung.

Der Zieltyp ist unveränderlich, sobald er erstellt wurde. Ein neues Ziel muss mit dem neuen Typ erstellt werden.

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

Beispiele

Aktualisieren eines Exportziels aus datei

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

Aktualisieren eines Exportziels mit json-Patch-Nutzlast

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--content -k

Die Teilzieldefinition. Geben Sie Pfad zu JSON-Datei oder unformatierter JSON-Datei an. [Dateipfadbeispiel:./path/to/file.json] [Beispiel für Zeichenfolgen-JSON:{}]. Der Anforderungstext muss teilinhalt des Ziels enthalten.

--dest-id

Eindeutiger Bezeichner für das Exportziel.

Optionale Parameter

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Zulässige Werte: 2022-06-30-preview
Standardwert: 2022-06-30-preview
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
Standardwert: json
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.