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

Api Version Set - Update

更新其标识符指定的 Api VersionSet 的详细信息。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2020-12-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 的一部分。

versionSetId
path True
  • string

Api 版本集标识符。 当前API 管理服务实例中必须是唯一的。

Regex pattern: ^[^*#&+:<>?]+$

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。

请求头

Name Required Type Description
If-Match True
  • string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配,或者应为 * 进行无条件更新。

请求正文

Name Type Description
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 请求中的位置。

响应

Name Type Description
200 OK

Api 版本集已成功更新。

Headers

  • ETag: string
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 模拟用户帐户

示例

ApiManagementUpdateApiVersionSet

Sample Request

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


{
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

Sample Response

{
  "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"
  }
}

定义

ApiVersionSetContract

Api 版本集协定详细信息。

ApiVersionSetUpdateParameters

用于更新或创建 API 版本集协定的参数。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

versioningScheme

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

ApiVersionSetContract

Api 版本集协定详细信息。

Name Type Description
id
  • string

资源 ID。

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

API 管理资源的资源类型。

ApiVersionSetUpdateParameters

用于更新或创建 API 版本集协定的参数。

Name Type Description
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 请求中的位置。

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 版本在路径段中传递。