az iot central export

注意

此參考是 Azure CLI 的 azure-iot 延伸模組的一部分 （2.37.0 版或更高版本）。 擴充功能會在您第一次執行 az iot central export 命令時自動安裝。 深入了解擴充功能。

此命令群組處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

管理和設定 IoT Central 資料匯出。

命令

名稱	Description	類型	狀態
az iot central export create	建立 IoT Central 應用程式的匯出。	擴充	預覽版
az iot central export delete	刪除 IoT Central 應用程式的匯出。	擴充	預覽版
az iot central export destination	管理和設定 IoT Central 匯出目的地。	擴充	預覽版
az iot central export destination create	建立 IoT Central 應用程式的匯出目的地。	擴充	預覽版
az iot central export destination delete	刪除 IoT Central 應用程式的匯出目的地。	擴充	預覽版
az iot central export destination list	取得 IoT Central 應用程式匯出目的地的完整清單。	擴充	預覽版
az iot central export destination show	取得匯出目的地詳細資料。	擴充	預覽版
az iot central export destination update	更新 IoT Central 應用程式的匯出目的地。	擴充	預覽版
az iot central export list	取得 IoT Central 應用程式的完整匯出清單。	擴充	預覽版
az iot central export show	取得匯出詳細資料。	擴充	預覽版
az iot central export update	更新 IoT Central 應用程式的匯出。	擴充	預覽版

az iot central export create

預覽

命令群組 'iot central export' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

建立 IoT Central 應用程式的匯出。

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]

範例

使用篩選、擴充、目的地建立匯出

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--destinations --dests

具有轉換的目的地清單。

--display-name --name

資料匯出顯示名稱。

--export-id --id

匯出的唯一識別碼。

--source -s

資料匯出來源。

接受的值: deviceConnectivity, deviceLifecycle, deviceTemplateLifecycle, properties, telemetry

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

所要求作業的 API 版本。

接受的值: 2022-06-30-preview

預設值: 2022-06-30-preview

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

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com

--en --enrichments

資料匯出擴充。

--enabled -e

資料匯出的啟用狀態、True 或 False。

接受的值: false, true

預設值: True

--filter -f

IoT Central 查詢語言型篩選，更多來自：aka.ms/iotcquery 的詳細資料。

--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot central export delete

預覽

命令群組 'iot central export' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

刪除 IoT Central 應用程式的匯出。

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

範例

刪除匯出

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--export-id --id

匯出的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

所要求作業的 API 版本。

接受的值: 2022-06-30-preview

預設值: 2022-06-30-preview

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

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com

--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot central export list

預覽

命令群組 'iot central export' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得 IoT Central 應用程式的完整匯出清單。

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

範例

列出應用程式中的所有匯出

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

所要求作業的 API 版本。

接受的值: 2022-06-30-preview

預設值: 2022-06-30-preview

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

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com

--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot central export show

預覽

命令群組 'iot central export' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

取得匯出詳細資料。

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

範例

取得匯出詳細資料

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--export-id --id

匯出的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

所要求作業的 API 版本。

接受的值: 2022-06-30-preview

預設值: 2022-06-30-preview

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

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com

--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az iot central export update

預覽

命令群組 'iot central export' 處於預覽狀態，且正在開發中。 參考和支援層級： https://aka.ms/CLI_refstatus

更新 IoT Central 應用程式的匯出。

建立匯出之後，來源是不可變的。

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

範例

從檔案更新匯出

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

更新匯出的顯示名稱，並從 json 承載啟用匯出

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。

--content -k

部分匯出定義。 提供 JSON 檔案或原始字串化 JSON 的路徑。 [檔案路徑範例：./path/to/file.json][字串化 JSON： {} ] 的範例。 要求本文必須包含 Export 的部分內容。

--export-id --id

匯出的唯一識別碼。

選擇性參數

--api-version --av

已被取代

引數 'api_version' 已被取代，並將在未來版本中移除。

所要求作業的 API 版本。

接受的值: 2022-06-30-preview

預設值: 2022-06-30-preview

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

與您的應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com

--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi，即可深入瞭解。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID 帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。