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

Api Version Set - List By Service

列出指定服务实例中的 API 版本集集合。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-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

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

要用于客户端请求的 API 的版本。

$filter
query
  • string

|字段|使用情况|支持的运算符|支持的函数|
|-------------|-------------|-------------|-------------|

$skip
query
  • integer
int32

要跳过的记录数。

$top
query
  • integer
int32

要返回的记录数。

响应

Name Type Description
200 OK

列出 Api 版本集实体的集合。

Other Status Codes

描述操作失败原因的错误响应。

安全性

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 模拟用户帐户

示例

ApiManagementListApiVersionSets

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "vs1",
      "properties": {
        "displayName": "api set 1",
        "versioningScheme": "Segment",
        "description": "Version configuration"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs2",
      "type": "Microsoft.ApiManagement/service/api-version-sets",
      "name": "vs2",
      "properties": {
        "displayName": "api set 2",
        "versioningScheme": "Query",
        "description": "Version configuration 2"
      }
    }
  ],
  "count": 2,
  "nextLink": ""
}

定义

ApiVersionSetCollection

分页 API 版本集列表表示形式。

ApiVersionSetContract

API 版本集协定详细信息。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

versioningScheme

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

ApiVersionSetCollection

分页 API 版本集列表表示形式。

Name Type Description
count
  • integer

所有页面的总记录计数数。

nextLink
  • string

下一页链接(如果有)。

value

页面值。

ApiVersionSetContract

API 版本集协定详细信息。

Name Type Description
id
  • string

资源的完全限定的资源 ID。 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

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

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

ErrorFieldContract

错误字段协定。

Name Type Description
code
  • string

属性级错误代码。

message
  • string

属性级错误的人类可读表示形式。

target
  • string

属性名称。

ErrorResponse

错误响应。

Name Type Description
error.code
  • string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

请求中发送的无效字段列表(如果出现验证错误)。

error.message
  • string

错误的用户可读表示形式。

versioningScheme

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

Name Type Description
Header
  • string

API 版本在 HTTP 标头中传递。

Query
  • string

API 版本在查询参数中传递。

Segment
  • string

API 版本在路径段中传递。