你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Api Version Set - Get

服务:

API Management

API 版本:

2024-05-01

获取由标识符指定的 Api 版本集的详细信息。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服务的名称。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Api 版本集标识符。 当前 API 管理服务实例中必须是唯一的。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

响应

名称	类型	说明
200 OK	ApiVersionSetContract	获取指定的 Api 版本集实体。 标头 ETag: string
Other Status Codes	ErrorResponse	描述作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ApiManagementGetApiVersionSet

示例请求

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1?api-version=2024-05-01

示例响应

状态代码:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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 版本集协定详细信息。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
versioningScheme	一个值，该值确定 API 版本标识符将位于 HTTP 请求中的位置。

ApiVersionSetContract

Object

API 版本集协定详细信息。

名称	类型	说明
id	string	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties.description	string	API 版本集的说明。
properties.displayName	string minLength: 1 maxLength: 100	API 版本集的名称
properties.versionHeaderName	string minLength: 1 maxLength: 100	如果 versioningScheme 设置为 header，则表示 API 版本的 HTTP 标头参数的名称。
properties.versionQueryName	string minLength: 1 maxLength: 100	如果 versioningScheme 设置为 query，则指示 API 版本的查询参数的名称。
properties.versioningScheme	versioningScheme	一个值，该值确定 API 版本标识符将位于 HTTP 请求中的位置。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

versioningScheme

枚举

一个值，该值确定 API 版本标识符将位于 HTTP 请求中的位置。

值	说明
Header	API 版本在 HTTP 标头中传递。
Query	API 版本在查询参数中传递。
Segment	API 版本在路径段中传递。