az iot ops schema

Note

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

結構描述登錄和結構描述管理。

架構是描述數據以啟用處理和內容化的檔。訊息架構描述訊息的格式及其內容。需要架構登錄才能建立和管理架構。

命令

名稱	Description	類型	狀態
az iot ops schema create	在架構登錄內建立架構。	Extension	GA
az iot ops schema delete	刪除架構登錄內的目標架構。	Extension	GA
az iot ops schema list	列出架構登錄內的架構。	Extension	GA
az iot ops schema registry	架構登錄管理。	Extension	GA
az iot ops schema registry create	建立架構登錄。	Extension	GA
az iot ops schema registry delete	刪除目標架構登錄。	Extension	GA
az iot ops schema registry list	列出資源群組或訂用帳戶中的架構登錄。	Extension	GA
az iot ops schema registry show	顯示架構登錄的詳細數據。	Extension	GA
az iot ops schema show	顯示架構登錄內架構的詳細數據。	Extension	GA
az iot ops schema show-dataflow-refs	顯示用於數據流的架構參考。	Extension	Experimental
az iot ops schema version	架構版本管理。	Extension	GA
az iot ops schema version add	將架構版本新增至架構。	Extension	GA
az iot ops schema version list	列出特定架構的架構版本。	Extension	GA
az iot ops schema version remove	拿掉目標架構版本。	Extension	GA
az iot ops schema version show	顯示架構版本的詳細數據。	Extension	GA

az iot ops schema create

在架構登錄內建立架構。

此作業需要預先建立的架構登錄，且將會新增架構版本。若要建立架構並新增版本，相關聯的記憶體帳戶必須啟用公用網路存取。如需差異檔格式的詳細資訊，請參閱 aka.ms/lakehouse-delta-sample。

az iot ops schema create --format {delta, json}
                         --name
                         --registry
                         --resource-group
                         --type {message}
                         --vc --version-content
                         [--desc]
                         [--display-name]
                         [--vd --version-desc]
                         [--ver --version]

範例

在登錄 'myregistry' 中建立名為 'myschema' 且輸入最少的架構。架構第 1 版將會針對此架構建立檔案內容。

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format json --type message --version-content myschema.json

建立名為『myschema』且具有其他自定義的架構。將會為此架構建立架構版本 14。內嵌內容是bash語法範例。如需更多範例，請參閱 https://aka.ms/inline-json-examples

az iot ops schema create -n myschema -g myresourcegroup --registry myregistry --format delta --type message --desc "Schema for Assets" --display-name myassetschema --version-content '{"hello": "world"}' --ver 14 --vd "14th version"

必要參數

--format

架構格式。

屬性	值
接受的值:	delta, json

--name -n

架構名稱。

--registry

架構登錄名稱。

--resource-group -g

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

--type

架構類型。

屬性	值
接受的值:	message

--vc --version-content

包含或內嵌版本的檔案路徑。

屬性	值
參數群組:	Version Arguments

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--desc

架構的描述。

--display-name

架構的顯示名稱。

--vd --version-desc

版本的描述。

屬性	值
參數群組:	Version Arguments

--ver --version

架構版本名稱。

屬性	值
參數群組:	Version Arguments
預設值:	1

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot ops schema delete

刪除架構登錄內的目標架構。

az iot ops schema delete --name
                         --registry
                         --resource-group
                         [--yes {false, true}]

範例

刪除架構登錄『myregistry』內的目標架構『myschema』。

az iot ops schema delete --name myschema --registry myregistry -g myresourcegroup

必要參數

--name -n

架構名稱。

--registry

架構登錄名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--yes -y

在沒有提示的情況下確認 [y]es。適用於 CI 和自動化案例。

屬性	值
接受的值:	false, true

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot ops schema list

列出架構登錄內的架構。

az iot ops schema list --registry
                       --resource-group

範例

列出架構登錄『myregistry』中的架構註冊。

az iot ops schema list -g myresourcegroup --registry myregistry

必要參數

--registry

架構登錄名稱。

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot ops schema show

顯示架構登錄內架構的詳細數據。

az iot ops schema show --name
                       --registry
                       --resource-group

範例

在架構登錄 'myregistry' 內顯示目標架構 'myschema' 的詳細數據。

az iot ops schema show --name myschema --registry myregistry -g myresourcegroup

必要參數

--name -n

架構名稱。

--registry

架構登錄名稱。

--resource-group -g

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

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az iot ops schema show-dataflow-refs

實驗

此命令是實驗性且正在開發中。參考和支援層級： https://aka.ms/CLI_refstatus

顯示用於數據流的架構參考。

az iot ops schema show-dataflow-refs --registry
                                     --resource-group
                                     [--latest {false, true}]
                                     [--schema]
                                     [--ver --version]

範例

顯示架構「myschema」和第 1 版的架構參考。

az iot ops schema show-dataflow-refs --version 1 --schema myschema --registry myregistry -g myresourcegroup

顯示架構「myschema」中所有版本的架構參考。

az iot ops schema show-dataflow-refs --schema myschema --registry myregistry -g myresourcegroup

顯示架構登錄「myregistry」中所有版本和架構的架構參考。

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup

顯示所有架構的架構參考，但只有架構登錄「myregistry」中的最新版本。

az iot ops schema show-dataflow-refs --registry myregistry -g myresourcegroup --latest

必要參數

--registry

架構登錄名稱。

--resource-group -g

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

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--latest

僅顯示最新版本的旗標。

屬性	值
接受的值:	false, true

--schema

架構名稱。如果使用 --version，則為必要專案。

--ver --version

架構版本名稱。如果使用，則會忽略 --latest。

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

意見反應

此頁面對您有幫助嗎？

共用方式為

az iot ops schema

命令

az iot ops schema create

範例

必要參數

選擇性參數

az iot ops schema delete

範例

必要參數

選擇性參數

az iot ops schema list

範例

必要參數

az iot ops schema show

範例

必要參數

az iot ops schema show-dataflow-refs

範例

必要參數

選擇性參數

意見反應