Update-AzApiManagementGateway

Reference

Module:: Az.ApiManagement

Configures an API management Gateway.

Syntax

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>]

Description

The Update-AzApiManagementGateway cmdlet configures an API management Gateway.

Examples

Example 1: Configure a management group

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

This command configures a gateway.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-Context

Instance of PsApiManagementContext. This parameter is required.

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

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-Description

Gateway description. This parameter is optional.

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

-GatewayId

Identifier of existing gateway. This parameter is required.

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

-InputObject

Instance of PsApiManagementGateway. This parameter is required.

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

-LocationData

Gateway location. This parameter is optional.

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

-PassThru

If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway type representing the modified gateway.

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

-ResourceId

Arm ResourceId of the Gateway. This parameter is required.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

PsApiManagementContext

String

PsApiManagementResourceLocation

SwitchParameter

Outputs

PsApiManagementGateway