共用方式為

az apic metadata

  • 參考

注意

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

在 API 中心管理元數據架構的命令。

命令

名稱 Description 類型 狀態
az apic metadata create

建立新的元數據架構或更新現有的元數據架構。

 副檔名 GA
az apic metadata delete

刪除指定的元數據架構。

 副檔名 GA
az apic metadata export

匯出元數據架構。

 副檔名 GA
az apic metadata list

列出元數據架構的集合。

 副檔名 GA
az apic metadata show

取得元數據架構的詳細數據。

 副檔名 GA
az apic metadata update

更新現有的元數據架構。

 副檔名 GA

az apic metadata create

建立新的元數據架構或更新現有的元數據架構。

az apic metadata create --assignments
                        --metadata-name
                        --resource-group
                        --schema
                        --service-name

範例

建立元數據範例 1

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

建立元數據範例 2

az apic metadata create --resource-group api-center-test --service-name contoso  --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

必要參數

--assignments

定義自定義元數據的指派範圍，例如 “[{entity：api，required：true，deprecated：false}]”。 可用的實體值包括：api、部署、環境。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--metadata-name

元數據架構的名稱。

--resource-group -g

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

--schema

定義類型的 JSON 架構。

--service-name -n

Azure API 中心服務的名稱。

全域參數
--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 apic metadata delete

刪除指定的元數據架構。

az apic metadata delete [--ids]
                        [--metadata-name]
                        [--resource-group]
                        [--service-name]
                        [--subscription]
                        [--yes]

範例

刪除元數據架構

az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"

刪除架構

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--metadata-name

元數據架構的名稱。

--resource-group -g

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

--service-name -n

Azure API 中心服務的名稱。

--subscription

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

--yes -y

不提示確認。

預設值: False
全域參數
--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 apic metadata export

匯出元數據架構。

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--ids]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--service-name]
                        [--subscription]

範例

匯出指派給 API 的元數據架構

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json

匯出指派給部署的元數據架構

az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json

匯出指派給環境的元數據架構

az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json

必要參數

--assignments

要求元數據架構的實體。

接受的值: api, deployment, environment
--file-name

要匯出元數據架構的檔名。

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--no-wait

請勿等候長時間執行的作業完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--service-name -n

API 中心服務的名稱。

--subscription

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

全域參數
--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 apic metadata list

列出元數據架構的集合。

az apic metadata list --resource-group
                      --service-name
                      [--filter]
                      [--max-items]
                      [--next-token]

範例

列出架構

az apic metadata list -g api-center-test -n contosoeuap

必要參數

--resource-group -g

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

--service-name -n

Azure API 中心服務的名稱。

選擇性參數

--filter

OData 篩選參數。

--max-items

命令輸出中要傳回的項目總數。 如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。 若要繼續分頁，請在後續命令的自變數中 --next-token 提供令牌值。

--next-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 apic metadata show

取得元數據架構的詳細數據。

az apic metadata show [--ids]
                      [--metadata-name]
                      [--resource-group]
                      [--service-name]
                      [--subscription]

範例

顯示架構詳細數據 1

az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver

顯示架構詳細數據 2

az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--metadata-name

元數據架構的名稱。

--resource-group -g

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

--service-name -n

Azure API 中心服務的名稱。

--subscription

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

全域參數
--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 apic metadata update

更新現有的元數據架構。

az apic metadata update [--add]
                        [--assignments]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--metadata-name]
                        [--remove]
                        [--resource-group]
                        [--schema]
                        [--service-name]
                        [--set]
                        [--subscription]

範例

更新架構

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

選擇性參數

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value、string 或 JSON 字串>。

--assignments

定義自定義元數據的指派範圍，例如 “[{entity：api，required：true，deprecated：false}]”。 可用的實體值包括：api、部署、環境。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

接受的值: 0, 1, f, false, n, no, t, true, y, yes
--ids

一或多個資源識別碼 (以空格分隔)。 它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。 您應該提供 --ids 或其他「資源識別碼」引數。

--metadata-name

元數據架構的名稱。

--remove

從清單中移除屬性或專案。 範例：--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

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

--schema

定義型別的 YAML 架構。

--service-name -n

Azure API 中心服務的名稱。

--set

指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=。

--subscription

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

全域參數
--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 來取得完整偵錯記錄。