az iot central export destination
Note
This reference is part of the azure-iot extension for the Azure CLI (version 2.37.0 or higher). The extension will automatically install the first time you run an az iot central export destination command. Learn more about extensions.
Command group 'iot central export' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage and configure IoT Central export destinations.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az iot central export destination create |
Create an export destination for an IoT Central application. |
Extension | Preview |
| az iot central export destination delete |
Delete an export destination for an IoT Central application. |
Extension | Preview |
| az iot central export destination list |
Get the full list of export destinations for an IoT Central application. |
Extension | Preview |
| az iot central export destination show |
Get an export destination details. |
Extension | Preview |
| az iot central export destination update |
Update an export destination for an IoT Central application. |
Extension | Preview |
az iot central export destination create
Command group 'iot central export destination' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create an export destination for an IoT Central application.
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]Examples
Create a webhook export destination with json payload
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}}'Create a blob storage export destination with json payload
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"
}'Create an Azure Data Explorer export destination with json payload
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]"
}'Create an Event Hub export destination with json payload
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"
}'Create a Service Bus Queue destination with json payload
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]"
}'Create a Service Bus Topic destination with json payload
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]"
}'Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
Unique identifier for the export destination.
The destination display name.
The destination type.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The authorization config in json.
The IoT Central DNS suffix associated with your application.
The azure data explorer cluster url.
The azure data explorer database.
The webhook destination custimized header collection in json.
The azure data explorer table.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
The webhook url.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central export destination delete
Command group 'iot central export destination' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Delete an export destination for an IoT Central application.
az iot central export destination delete --app-id
--dest-id
[--api-version {2022-06-30-preview}]
[--central-api-uri]
[--token]Examples
Delete an export destination
az iot central export destination delete --app-id {appid} --dest-id {destinationid}Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
Unique identifier for the export destination.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The IoT Central DNS suffix associated with your application.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central export destination list
Command group 'iot central export destination' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get the full list of export destinations for an IoT Central application.
az iot central export destination list --app-id
[--api-version {2022-06-30-preview}]
[--central-api-uri]
[--token]Examples
List all export destinations in an application
az iot central export destination list --app-id {appid}Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The IoT Central DNS suffix associated with your application.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central export destination show
Command group 'iot central export destination' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get an export destination details.
az iot central export destination show --app-id
--dest-id
[--api-version {2022-06-30-preview}]
[--central-api-uri]
[--token]Examples
Get an export destination details
az iot central export destination show --app-id {appid} --dest-id {destinationid}Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
Unique identifier for the export destination.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The IoT Central DNS suffix associated with your application.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az iot central export destination update
Command group 'iot central export destination' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update an export destination for an IoT Central application.
The destination type is immutable once it is created. A new destination must be created with the new type.
az iot central export destination update --app-id
--content
--dest-id
[--api-version {2022-06-30-preview}]
[--central-api-uri]
[--token]Examples
Update an export destination from file
az iot central export destination update --app-id {appid} --dest-id {destinationid} --content './filepath/payload.json'Update an export destination with json-patch payload
az iot central export destination update --app-id {appid} --dest-id {destinationid} --content '{"displayName": "Web Hook Updated"}'Required Parameters
The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.
The partial destination definition. Provide path to JSON file or raw stringified JSON. [File Path Example:./path/to/file.json] [Example of stringified JSON:{}]. The request body must contain partial content of Destination.
Unique identifier for the export destination.
Optional Parameters
Argument 'api_version' has been deprecated and will be removed in a future release.
The API version for the requested operation.
The IoT Central DNS suffix associated with your application.
If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for