az iot central export destination

預覽
參考

備註

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

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

管理和設定IoT Central 匯出目的地。

命令

名稱	Description	類型	狀態
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 destination create

預覽

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

建立IoT Central應用程式的導出目的地。

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]

範例

使用 json 承載建立 Webhook 導出目的地

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

使用 json 承載建立 Blob 記憶體導出目的地

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

建立具有 json 承載的 Azure 數據總管導出目的地

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

使用 json 承載建立事件中樞導出目的地

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

使用 json 承載建立服務總線佇列目的地

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

使用 json 承載建立服務總線主題目的地

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

必要參數

--app-id -n

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

--dest-id

匯出目的地的唯一標識符。

--display-name --name

目的地顯示名稱。

--type -t

目的地類型。

接受的值: blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1

選擇性參數

--api-version --av

已被取代

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

所要求作業的 API 版本。

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

預設值: 2022-06-30-preview

--au --authorization

json 中的授權設定。

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

與您的應用程式相關聯的IoT Central DNS後綴。

預設值: azureiotcentral.com

--cluster-url --cu

Azure 數據總管叢集 URL。

--database

Azure 數據總管資料庫。

--header

json 中的 Webhook 目的地 custimized 標頭集合。

--table

azure 數據總管數據表。

--token

如果您想要提交要求而不向 Azure CLI 進行驗證，您可以指定有效的使用者令牌來驗證您的要求。您必須將金鑰類型指定為要求的一部分。了解更多資訊，請至 https://aka.ms/iotcentraldocsapi。

--url

Webhook URL。

全域參數

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

預覽

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

刪除 IoT Central 應用程式的導出目的地。

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

範例

刪除匯出目的地

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

必要參數

--app-id -n

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

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

全域參數

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

預覽

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

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

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

範例

列出應用程式中的所有導出目的地

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

全域參數

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

預覽

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

取得匯出目的地詳細數據。

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

範例

取得匯出目的地詳細數據

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

必要參數

--app-id -n

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

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

全域參數

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

預覽

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

更新IoT Central應用程式的導出目的地。

建立目的地類型后是不可變的。必須使用新的類型建立新的目的地。

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

範例

從檔案更新匯出目的地

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

使用 json-patch 承載更新導出目的地

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

必要參數

--app-id -n

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

--content -k

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

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

全域參數

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

命令

az iot central export destination create

範例

必要參數

選擇性參數

az iot central export destination delete

範例

必要參數

選擇性參數

az iot central export destination list

範例

必要參數

選擇性參數

az iot central export destination show

範例

必要參數

選擇性參數

az iot central export destination update

範例

必要參數

選擇性參數

其他資源