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

Set-AzApiManagementApiVersionSet

  • 参考
模块:
Az.ApiManagement

在API 管理上下文中汇报 API 版本集。

语法

Set-AzApiManagementApiVersionSet
   -Context <PsApiManagementContext>
   -ApiVersionSetId <String>
   [-Name <String>]
   [-Scheme <PsApiManagementVersioningScheme>]
   [-HeaderName <String>]
   [-QueryName <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementApiVersionSet
   -InputObject <PsApiManagementApiVersionSet>
   [-Name <String>]
   [-Scheme <PsApiManagementVersioningScheme>]
   [-HeaderName <String>]
   [-QueryName <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Set-AzApiManagementApiVersionSet cmdlet 修改 Azure API 管理 API 版本集。

示例

示例 1

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId "query-verion-set" -Scheme Header -HeaderName "api-version" -Description "Azure version header string"

此命令使用版本控制方案和 Header 标头参数 api-version更新现有的 API 版本集。

参数

-ApiVersionSetId

新 API 版本集的标识符。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

PsApiManagementContext 的实例。 此参数是必需的。

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Api 版本集的说明。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-HeaderName

将包含版本控制信息的标头值。 如果选择了版本控制方案标头，则必须指定此值。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

PsApiManagementApiVersionSet 的实例。 此参数是必需的。

Type:PsApiManagementApiVersionSet
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

ApiVersion 集的名称。 此参数是可选的。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

如果指定，则表示修改后的 apiVersionSet 类型的 Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet 类型的实例将写入输出。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-QueryName

将包含版本控制信息的查询值。 如果选择版本控制方案查询，则必须指定此值。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Scheme

要为 Api 版本控制集选择的版本控制方案。 此参数是可选的。

Type:PsApiManagementVersioningScheme
Accepted values:Segment, Query, Header
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PsApiManagementContext

PsApiManagementApiVersionSet

String

PsApiManagementVersioningScheme

输出

PsApiManagementApiVersionSet