Partilhar via


Update-AzApiManagementGateway

Configura um gateway de gerenciamento de API.

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

O cmdlet Update-AzApiManagementGateway configura um Gateway de gerenciamento de API.

Exemplos

Exemplo 1: Configurar um grupo de gerenciamento

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

Este comando configura um gateway.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Instância de PsApiManagementContext. Este parâmetro é obrigatório.

Tipo:PsApiManagementContext
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Descrição do gateway. Este parâmetro é opcional.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-GatewayId

Identificador do gateway existente. Este parâmetro é obrigatório.

Tipo:String
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Instância de PsApiManagementGateway. Este parâmetro é obrigatório.

Tipo:PsApiManagementGateway
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-LocationData

Localização do gateway. Este parâmetro é opcional.

Tipo:PsApiManagementResourceLocation
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Se especificado, então instância de Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway tipo que representa o gateway modificado.

Tipo:SwitchParameter
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

Arm ResourceId do gateway. Este parâmetro é obrigatório.

Tipo:String
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PsApiManagementContext

String

PsApiManagementResourceLocation

SwitchParameter

Saídas

PsApiManagementGateway