az iot central export

  • Preview
  • Reference

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 command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage and configure IoT Central data exports.

Commands

Name Description Type Status
az iot central export create

Create an export for an IoT Central application.

 Extension Preview
az iot central export delete

Delete an export for an IoT Central application.

 Extension Preview
az iot central export destination

Manage and configure IoT Central export destinations.

 Extension Preview
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 list

Get the full list of exports for an IoT Central application.

 Extension Preview
az iot central export show

Get an export details.

 Extension Preview
az iot central export update

Update an export for an IoT Central application.

 Extension Preview

az iot central export create

Preview

Command group 'iot central export' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an export for an IoT Central application.

az iot central export create --app-id
                             --destinations
                             --display-name
                             --export-id
                             --source {deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry}
                             [--api-version {2022-06-30-preview}]
                             [--central-api-uri]
                             [--en]
                             [--enabled {false, true}]
                             [--filter]
                             [--token]

Examples

Create an export with filter, enrichments, destinations

az iot central export create --app-id {appid} --export-id {exportid} --enabled {enabled} --display-name {displayname} --source {source} --filter "SELECT * FROM devices WHERE $displayName != "abc" AND $id = "a"" --enrichments '{
  "simulated": {
    "path": "$simulated"
  }
}' --destinations '[
  {
    "id": "{destinationid}",
    "transform": "{ ApplicationId: .applicationId, Component: .component, DeviceName: .device.name }"
  }
]'

Required Parameters

--app-id -n

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.

--destinations --dests

The list of destinations with transform.

--display-name --name

The data export display name.

--export-id --id

Unique identifier for the export.

--source -s

The data export source.

accepted values: deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

The API version for the requested operation.

accepted values: 2022-06-30-preview
default value: 2022-06-30-preview
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

default value: azureiotcentral.com
--en --enrichments

The data export enrichment.

--enabled -e

The enabled status for data export, True or False.

accepted values: false, true
default value: True
--filter -f

IoT Central Query Language based filter, more details from: aka.ms/iotcquery.

--token

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

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central export delete

Preview

Command group 'iot central export' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an export for an IoT Central application.

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

Examples

Delete an export

az iot central export delete --app-id {appid} --export-id {exportid}

Required Parameters

--app-id -n

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.

--export-id --id

Unique identifier for the export.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

The API version for the requested operation.

accepted values: 2022-06-30-preview
default value: 2022-06-30-preview
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

default value: azureiotcentral.com
--token

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

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central export list

Preview

Command group 'iot central export' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the full list of exports for an IoT Central application.

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

Examples

List all exports in an application

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

Required Parameters

--app-id -n

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

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

The API version for the requested operation.

accepted values: 2022-06-30-preview
default value: 2022-06-30-preview
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

default value: azureiotcentral.com
--token

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

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central export show

Preview

Command group 'iot central export' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get an export details.

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

Examples

Get an export details

az iot central export show --app-id {appid} --export-id {exportid}

Required Parameters

--app-id -n

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.

--export-id --id

Unique identifier for the export.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

The API version for the requested operation.

accepted values: 2022-06-30-preview
default value: 2022-06-30-preview
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

default value: azureiotcentral.com
--token

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

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central export update

Preview

Command group 'iot central export' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an export for an IoT Central application.

Source is immutable once an export is created.

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

Examples

Update an export from file

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

Update an export's display name and enable export from json payload

az iot central export update --app-id {appid} --export-id {exportid} --content "{'displayName': 'Updated Export Name', 'enabled': true}"

Required Parameters

--app-id -n

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.

--content -k

The partial export 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 Export.

--export-id --id

Unique identifier for the export.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

The API version for the requested operation.

accepted values: 2022-06-30-preview
default value: 2022-06-30-preview
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

default value: azureiotcentral.com
--token

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

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.