共用方式為

az iot ops asset

  • 參考

注意

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

資產管理。

如需資產管理的詳細資訊，請參閱 aka.ms/asset-overview。

命令

名稱 Description 類型 狀態
az iot ops asset create

建立資產。

 副檔名 加語
az iot ops asset dataset

管理資產中的數據集。

 副檔名 加語
az iot ops asset dataset list

列出資產內的數據集。

 副檔名 加語
az iot ops asset dataset point

管理資產數據集中的數據點。

 副檔名 加語
az iot ops asset dataset point add

將數據點新增至資產數據集。

 副檔名 加語
az iot ops asset dataset point export

匯出資產數據集中的數據點。

 副檔名 加語
az iot ops asset dataset point import

在資產數據集中匯入數據點。

 副檔名 加語
az iot ops asset dataset point list

列出資產數據集中的數據點。

 副檔名 加語
az iot ops asset dataset point remove

拿掉資產數據集中的數據點。

 副檔名 加語
az iot ops asset dataset show

在資產內顯示數據集。

 副檔名 加語
az iot ops asset delete

刪除資產。

 副檔名 加語
az iot ops asset endpoint

管理資產端點配置檔。

 副檔名 加語
az iot ops asset endpoint create

建立資產端點配置檔。

 副檔名 加語
az iot ops asset endpoint create opcua

使用 OPCUA 連接器建立資產端點配置檔。

 副檔名 加語
az iot ops asset endpoint delete

刪除資產端點配置檔。

 副檔名 加語
az iot ops asset endpoint query

查詢 Resource Graph 以取得資產端點配置檔。

 副檔名 加語
az iot ops asset endpoint show

顯示資產端點配置檔。

 副檔名 加語
az iot ops asset endpoint update

更新資產端點配置檔。

 副檔名 加語
az iot ops asset event

管理資產中的事件。

 副檔名 加語
az iot ops asset event add

將事件新增至資產。

 副檔名 加語
az iot ops asset event export

匯出資產中的事件。

 副檔名 加語
az iot ops asset event import

匯入資產中的事件。

 副檔名 加語
az iot ops asset event list

列出資產中的事件。

 副檔名 加語
az iot ops asset event remove

拿掉資產中的事件。

 副檔名 加語
az iot ops asset query

查詢 Resource Graph 中的資產。

 副檔名 加語
az iot ops asset show

顯示資產。

 副檔名 加語
az iot ops asset update

更新資產。

 副檔名 加語

az iot ops asset create

建立資產。

如需檔格式的範例，請參閱 aka.ms/aziotops-assets。

az iot ops asset create --endpoint-profile
                        --instance
                        --name
                        --resource-group
                        [--attr]
                        [--dataset-publish-int]
                        [--dataset-queue-size]
                        [--dataset-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--eai]
                        [--ef]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--event]
                        [--hardware-revision]
                        [--ig]
                        [--instance-subscription]
                        [--location]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]
                        [--topic-path]
                        [--topic-retain {Keep, Never}]

範例

使用相同資源群組中的指定實例建立資產。

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance

在不同的資源群組中，使用指定的實例來建立資產，但相同的訂用帳戶。 請注意，如果資產位於實例的不同訂用帳戶中，數位作業體驗可能不會顯示資產。

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance --instance-resource-group myinstanceresourcegroup

使用包含事件的檔案建立已停用的資產。

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance --event-file /path/to/myasset_events.csv --disable

使用指定的預先填入值建立資產。

az iot ops asset create --name myasset -g myresourcegroup --endpoint-profile myassetendpoint --instance myinstance --event event_notifier=EventNotifier1 name=myEvent1 observability_mode=log sampling_interval=10 queue_size=2 --event event_notifier=EventNotifier2 name=myEvent2 --dataset-publish-int 1250 --dataset-queue-size 2 --dataset-sample-int 30 --event-publish-int 750 --event-queue-size 3 --event-sample-int 50 --description 'Description for a test asset.' --documentation-uri www.contoso.com --external-asset-id 000-000-1234 --hardware-revision 10.0 --product-code XXX100 --software-revision 0.1 --manufacturer Contoso --manufacturer-uri constoso.com --model AssetModel --serial-number 000-000-ABC10 --custom-attribute work_location=factory

必要參數

--endpoint-profile --ep

資產端點配置檔名稱。

--instance

要與所建立資產建立關聯的實例名稱。

--name -n

資產名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--attr --custom-attribute

與資產其他自定義屬性對應的空格分隔索引鍵=值組。 這個參數可以多次使用。

--dataset-publish-int --dpi

數據集的預設發佈間隔。

預設值: 1000
--dataset-queue-size --dqs

數據集的預設佇列大小。

預設值: 1
--dataset-sample-int --dsi

數據集的預設取樣間隔（以毫秒為單位）。

預設值: 500
--description -d

描述。

--disable

停用資產。

接受的值: false, true
預設值: False
--display-name --dn

顯示名稱。

--documentation-uri --du

檔 URI。

--eai --external-asset-id

外部資產標識碼。

--ef --event-file

包含事件的檔案檔案路徑。 支援下列檔類型：json、csv、yaml。

--epi --event-publish-int

事件的預設發佈間隔。

預設值: 1000
--eqs --event-queue-size

事件的預設佇列大小。

預設值: 1
--esi --event-sample-int

事件的預設取樣間隔（以毫秒為單位）。

預設值: 500
--event

與要建立之事件屬性對應的空格分隔索引鍵=值組。 支援下列索引鍵值： event_notifier （必要）、 name （必要）、 observability_mode （無或記錄）、（int）、 sampling_intervalqueue_size （int）。 --event 可以使用 1 或多次。 檢閱完整參數使用方式的說明範例。

--hardware-revision --hr

硬體修訂。

--ig --instance-resource-group

實例資源群組。 如果未提供，則會使用資產資源群組。

--instance-subscription --is
已被取代

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

實例訂用帳戶標識碼。如果未提供，則會使用資產訂用帳戶標識碼。

--location -l

位置。​​ 值的來源：az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--manufacturer

製造者。

--manufacturer-uri --mu

製造商 URI。

--model

模型。

--pc --product-code

產品代碼。

--serial-number --sn

序號。

--software-revision --sr

軟體修訂。

--tags

資產資源標籤。 索引鍵/值組中的屬性包，格式如下：a=b c=d。

--topic-path --tp

默認主題路徑。

--topic-retain --tr

默認主題會保留原則。

接受的值: Keep, Never
全域參數
--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 ops asset delete

刪除資產。

az iot ops asset delete --name
                        --resource-group

範例

刪除資產。

az iot ops asset delete --name myasset -g myresourcegroup

必要參數

--name -n

資產名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數
--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 ops asset query

查詢 Resource Graph 中的資產。

az iot ops asset query [--cq]
                       [--description]
                       [--disabled {false, true}]
                       [--display-name]
                       [--documentation-uri]
                       [--eai]
                       [--endpoint-profile]
                       [--hardware-revision]
                       [--ig]
                       [--instance]
                       [--location]
                       [--manufacturer]
                       [--manufacturer-uri]
                       [--model]
                       [--name]
                       [--pc]
                       [--resource-group]
                       [--serial-number]
                       [--software-revision]
                       [--topic-path]
                       [--topic-retain {Keep, Never}]

範例

查詢指定資源群組內已停用的資產。

az iot ops asset query -g myresourcegroup --disabled

查詢具有指定型號、製造商和序號的資產。

az iot ops asset query --model model1 --manufacturer contoso --serial-number 000-000-ABC10

選擇性參數

--cq --custom-query

要使用的自訂查詢。 所有其他查詢自變數都會被忽略。

--description -d

描述。

--disabled

資產狀態。

接受的值: false, true
--display-name --dn

顯示名稱。

--documentation-uri --du

檔 URI。

--eai --external-asset-id

外部資產標識碼。

--endpoint-profile --ep

資產端點配置檔名稱。

--hardware-revision --hr

硬體修訂。

--ig --instance-resource-group

實例資源群組。 如果未提供，則會使用資產資源群組。

--instance

要與所建立資產建立關聯的實例名稱。

--location -l

位置。​​ 值的來源：az account list-locations。 您可以使用 az configure --defaults location=<location> 設定預設位置。

--manufacturer

製造者。

--manufacturer-uri --mu

製造商 URI。

--model

模型。

--name -n

資產名稱。

--pc --product-code

產品代碼。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

--serial-number --sn

序號。

--software-revision --sr

軟體修訂。

--topic-path --tp

默認主題路徑。

--topic-retain --tr

默認主題會保留原則。

接受的值: Keep, Never
全域參數
--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 ops asset show

顯示資產。

az iot ops asset show --name
                      --resource-group

範例

顯示資產的詳細數據。

az iot ops asset show --name myasset -g myresourcegroup

必要參數

--name -n

資產名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數
--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 ops asset update

更新資產。

若要更新資料集和事件，請分別使用命令群組 az iot ops asset dataset 和 az iot ops asset event 。

az iot ops asset update --name
                        --resource-group
                        [--attr]
                        [--dataset-publish-int]
                        [--dataset-queue-size]
                        [--dataset-sample-int]
                        [--description]
                        [--disable {false, true}]
                        [--display-name]
                        [--documentation-uri]
                        [--epi]
                        [--eqs]
                        [--esi]
                        [--hardware-revision]
                        [--manufacturer]
                        [--manufacturer-uri]
                        [--model]
                        [--pc]
                        [--serial-number]
                        [--software-revision]
                        [--tags]
                        [--topic-path]
                        [--topic-retain {Keep, Never}]

範例

更新資產的數據集和事件預設值。

az iot ops asset update --name myasset -g myresourcegroup --dataset-publish-int 1250 --dataset-queue-size 2 --dataset-sample-int 30 --event-publish-int 750 --event-queue-size 3 --event-sample-int 50

更新資產的描述、檔 URI、硬體修訂、產品代碼和軟體修訂。

az iot ops asset update --name myasset -g myresourcegroup --description "Updated test asset description." --documentation-uri www.contoso.com --hardware-revision 11.0 --product-code XXX102 --software-revision 0.2

更新資產的製造商、製造商 URI、型號、序號和自定義屬性。

az iot ops asset update --name myasset -g myresourcegroup --manufacturer Contoso --manufacturer-uri constoso2.com --model NewAssetModel --serial-number 000-000-ABC11 --custom-attribute work_location=new_factory --custom-attribute secondary_work_location=factory

停用資產，並移除名為 「work_site」 的自定義屬性。

az iot ops asset update --name myasset -g myresourcegroup --disable --custom-attribute work_site=""

必要參數

--name -n

資產名稱。

--resource-group -g

資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--attr --custom-attribute

與資產其他自定義屬性對應的空格分隔索引鍵=值組。 這個參數可以多次使用。若要移除自定義屬性，請將屬性的值設定為 “ ” 。

--dataset-publish-int --dpi

數據集的預設發佈間隔。

--dataset-queue-size --dqs

數據集的預設佇列大小。

--dataset-sample-int --dsi

數據集的預設取樣間隔（以毫秒為單位）。

--description -d

描述。

--disable

停用資產。

接受的值: false, true
--display-name --dn

顯示名稱。

--documentation-uri --du

檔 URI。

--epi --event-publish-int

事件的預設發佈間隔。

--eqs --event-queue-size

事件的預設佇列大小。

--esi --event-sample-int

事件的預設取樣間隔（以毫秒為單位）。

--hardware-revision --hr

硬體修訂。

--manufacturer

製造者。

--manufacturer-uri --mu

製造商 URI。

--model

模型。

--pc --product-code

產品代碼。

--serial-number --sn

序號。

--software-revision --sr

軟體修訂。

--tags

資產資源標籤。 索引鍵/值組中的屬性包，格式如下：a=b c=d。

--topic-path --tp

默認主題路徑。

--topic-retain --tr

默認主題會保留原則。

接受的值: Keep, Never
全域參數
--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 來取得完整偵錯記錄。