az apim api release

管理 Azure API 管理 API 版本。

命令

名稱	Description	類型	狀態
az apim api release create	建立 API 的新版本。	Core	GA
az apim api release delete	刪除 API 中指定的版本。	Core	GA
az apim api release list	列出 API 的所有版本。	Core	GA
az apim api release show	傳回 API 版本的詳細數據。	Core	GA
az apim api release update	更新其識別碼所指定 API 版本的詳細數據。	Core	GA

az apim api release create

編輯

建立 API 的新版本。

az apim api release create --api-id
                           --api-revision
                           --resource-group
                           --service-name
                           [--if-match]
                           [--notes]
                           [--release-id]

範例

建立 API 的新版本。

az apim api release create --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --api-revision 2 --notes MyNotes

必要參數

--api-id

API 識別碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

屬性	值
參數群組:	API Arguments

--api-revision

API 修訂編號。

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

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

--if-match

實體的 ETag。

--notes

版本資訊。

--release-id

API 內的發行標識碼。目前 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 release delete

編輯

刪除 API 中指定的版本。

az apim api release delete --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--if-match]

範例

刪除 API 中指定的版本。

az apim api release delete --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

必要參數

--api-id

API 識別碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

屬性	值
參數群組:	API Arguments

--release-id

API 內的發行標識碼。目前 API 管理服務實例中必須是唯一的。

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

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

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

編輯

列出 API 的所有版本。

az apim api release list --api-id
                         --resource-group
                         --service-name

範例

列出 API 的所有版本。

az apim api release list --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId

必要參數

--api-id

API 識別碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

屬性	值
參數群組:	API Arguments

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

編輯

傳回 API 版本的詳細數據。

az apim api release show --api-id
                         --release-id
                         --resource-group
                         --service-name

範例

傳回 API 版本的詳細數據。

az apim api release show --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId

必要參數

--api-id

API 識別碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

屬性	值
參數群組:	API Arguments

--release-id

API 內的發行標識碼。目前 API 管理服務實例中必須是唯一的。

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

編輯

更新其識別碼所指定 API 版本的詳細數據。

az apim api release update --api-id
                           --release-id
                           --resource-group
                           --service-name
                           [--add]
                           [--force-string]
                           [--if-match]
                           [--notes]
                           [--remove]
                           [--set]

範例

更新其識別碼所指定 API 版本的附註。

az apim api release update --resource-group MyResourceGroup --service-name MyServiceName --api-id MyApiId --release-id MyReleaseId --notes MyNewNotes

必要參數

--api-id

API 識別碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

屬性	值
參數群組:	API Arguments

--release-id

API 內的發行標識碼。目前 API 管理服務實例中必須是唯一的。

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

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

--add

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

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

--force-string

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

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

--if-match

實體的 ETag。

--notes

版本資訊。

--remove

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

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

--set

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

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

全域參數

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

意見反應

此頁面對您有幫助嗎？