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

Update-AzApiManagementGateway

参考

模块:: Az.ApiManagement

配置 API 管理网关。

语法

Update-AzApiManagementGateway
      -Context <PsApiManagementContext>
      -GatewayId <String>
      [-Description <String>]
      [-LocationData <PsApiManagementResourceLocation>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzApiManagementGateway
      -InputObject <PsApiManagementGateway>
      [-Description <String>]
      [-LocationData <PsApiManagementResourceLocation>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzApiManagementGateway
      -ResourceId <String>
      [-Description <String>]
      [-LocationData <PsApiManagementResourceLocation>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

Update-AzApiManagementGateway cmdlet 配置 API 管理网关。

示例

示例 1：配置管理组

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Update-AzApiManagementGateway -Context $apimContext -GatewayId "0001" -Description "Updated Gateway"

此命令配置网关。

参数

-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

网关说明。此参数是可选的。

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

-GatewayId

现有网关的标识符。此参数是必需的。

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

-InputObject

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

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

-LocationData

网关位置。此参数是可选的。

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

-PassThru

如果指定，则指定 Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway 类型的实例，表示修改后的网关。

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

-ResourceId

网关的 Arm ResourceId。此参数是必需的。

Type:	String
Position:	Named
Default value:	None
Required:	True
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

String

PsApiManagementResourceLocation

SwitchParameter

输出

PsApiManagementGateway