Api Version Set - Get

參考

Service:: API Management

API Version:: 2022-08-01

取得其識別碼所指定的 Api 版本集詳細資料。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2022-08-01

URI 參數

Name	In	Required	Type	Description
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
serviceName	path	True	string	API 管理服務的名稱。 Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	目標訂用帳戶的識別碼。
versionSetId	path	True	string	Api 版本設定識別碼。在目前API 管理服務實例中必須是唯一的。 Regex pattern: `^[^*#&+:<>?]+$`
api-version	query	True	string	用於此作業的 API 版本。

回應

Name	Type	Description
200 OK	ApiVersionSetContract	取得指定的 Api 版本集實體。 Headers ETag: string
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

Name

Type

Description

200 OK

ApiVersionSetContract

取得指定的 Api 版本集實體。

Headers

ETag: string

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	模擬您的使用者帳戶

範例

ApiManagementGetApiVersionSet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1?api-version=2022-08-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "vs1",
  "properties": {
    "displayName": "Version Set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

定義

ApiVersionSetContract	API 版本設定合約詳細資料。
ErrorFieldContract	錯誤欄位合約。
ErrorResponse	錯誤回應。
versioningScheme	值，決定 API 版本識別碼在 HTTP 要求中的位置。

ApiVersionSetContract

API 版本設定合約詳細資料。

Name	Type	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.description	string	API 版本集的描述。
properties.displayName	string	API 版本集的名稱
properties.versionHeaderName	string	如果 versioningScheme 設定為 `header` ，則表示 API 版本的 HTTP 標頭參數名稱。
properties.versionQueryName	string	如果 versioningScheme 設定為 `query` ，則表示 API 版本的查詢參數名稱。
properties.versioningScheme	versioningScheme	值，決定 API 版本識別碼在 HTTP 要求中的位置。
type	string	資源類型。例如「Microsoft.Compute/virtualMachines」或「Microsoft.Storage/storageAccounts」

ErrorFieldContract

錯誤欄位合約。

Name	Type	Description
code	string	屬性層級錯誤碼。
message	string	人類可讀取的屬性層級錯誤標記法。
target	string	屬性名稱。

ErrorResponse

錯誤回應。

Name	Type	Description
error.code	string	服務定義的錯誤碼。此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。
error.details	ErrorFieldContract[]	要求中傳送無效欄位的清單，以防發生驗證錯誤。
error.message	string	人類可閱讀的錯誤表示法。

versioningScheme

值，決定 API 版本識別碼在 HTTP 要求中的位置。

Name	Type	Description
Header	string	API 版本會在 HTTP 標頭中傳遞。
Query	string	API 版本會在查詢參數中傳遞。
Segment	string	API 版本會在路徑區段中傳遞。