共用方式為

az apim api versionset

管理 Azure API 管理 API 版本集。

命令

名稱 Description 類型 狀態
az apim api versionset create

建立 Api 版本集。

 Core GA
az apim api versionset delete

刪除特定的 Api 版本集。

 Core GA
az apim api versionset list

列出指定服務實例中的 API 版本集合。

 Core GA
az apim api versionset show

取得其標識碼所指定的 Api 版本集合詳細數據。

 Core GA
az apim api versionset update

更新其標識碼所指定的 Api VersionSet 詳細數據。

 Core GA

az apim api versionset create

編輯

建立 Api 版本集。

az apim api versionset create --display-name
                              --resource-group
                              --service-name
                              --versioning-scheme
                              [--description]
                              [--if-match]
                              [--version-header-name]
                              [--version-query-name]
                              [--version-set-id]

範例

建立具有版本架構作為標頭的 Api 版本集。

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Header" --description MyDescription --version-header-name MyHeaderName

建立具有版本架構作為查詢的 Api 版本集。

az apim api versionset create --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyDisplayName --versioning-scheme "Query" --description MyDescription --version-query-name MyQueryName

必要參數

--display-name

Required. API 版本集的名稱。

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

--versioning-scheme

Required. 值，決定 API 版本識別碼在 HTTP 要求中的位置。 可能的值包括：『Segment』、『Query』、『Header』。

選擇性參數

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

--description

API 版本集的描述。

--if-match

實體的 ETag。

--version-header-name

如果 versioningScheme 設定為 header，則為 HTTP 標頭參數的名稱，指出 API 版本。

--version-query-name

如果 versioningScheme 設定為 query，則表示 API 版本的查詢參數名稱。

--version-set-id

相關 ApiVersionSet 的資源標識碼。

全域參數
--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 apim api versionset delete

編輯

刪除特定的 Api 版本集。

az apim api versionset delete --resource-group
                              --service-name
                              --version-set-id
                              [--if-match]

範例

刪除特定的 Api 版本集。

az apim api versionset delete --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

必要參數

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

--version-set-id

相關 ApiVersionSet 的資源標識碼。

選擇性參數

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

--if-match

實體的 ETag。

全域參數
--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 apim api versionset list

編輯

列出指定服務實例中的 API 版本集合。

az apim api versionset list --resource-group
                            --service-name

範例

列出指定服務實例中的 API 版本集合。

az apim api versionset list --resource-group MyResourceGroup --service-name MyServiceName

必要參數

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

全域參數
--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 apim api versionset show

編輯

取得其標識碼所指定的 Api 版本集合詳細數據。

az apim api versionset show --resource-group
                            --service-name
                            --version-set-id

範例

取得其標識碼所指定的 Api 版本集合詳細數據。

az apim api versionset show --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId

必要參數

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

--version-set-id

相關 ApiVersionSet 的資源標識碼。

全域參數
--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 apim api versionset update

編輯

更新其標識碼所指定的 Api VersionSet 詳細數據。

az apim api versionset update --resource-group
                              --service-name
                              --version-set-id
                              [--add]
                              [--description]
                              [--display-name]
                              [--force-string]
                              [--if-match]
                              [--remove]
                              [--set]
                              [--version-header-name]
                              [--version-query-name]
                              [--versioning-scheme]

範例

更新其識別碼所指定 Api VersionSet 的描述、顯示名稱。

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --display-name MyNewDisplayName --description MyNewDescription

更新其標識碼所指定之 Api VersionSet 的版本架構。

az apim api versionset update --resource-group MyResourceGroup --service-name MyServiceName --version-set-id MyVersionSetId --versioning-scheme "Query" --version-query-name MyNewQueryName

必要參數

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

--version-set-id

相關 ApiVersionSet 的資源標識碼。

選擇性參數

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

--add

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

屬性 值
參數群組: Generic Update Arguments
預設值: []
--description

API 版本集的描述。

--display-name

Required. API 版本集的名稱。

--force-string

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

屬性 值
參數群組: Generic Update Arguments
預設值: False
--if-match

實體的 ETag。

--remove

從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性 值
參數群組: Generic Update Arguments
預設值: []
--set

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

屬性 值
參數群組: Generic Update Arguments
預設值: []
--version-header-name

如果 versioningScheme 設定為 header，則為 HTTP 標頭參數的名稱，指出 API 版本。

--version-query-name

如果 versioningScheme 設定為 query，則表示 API 版本的查詢參數名稱。

--versioning-scheme

Required. 值，決定 API 版本識別碼在 HTTP 要求中的位置。 可能的值包括：『Segment』、『Query』、『Header』。

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