Partilhar via

Remove-AzApiManagementApiFromGateway

  • Referência
Módulo:
Az.ApiManagement

Anexa uma API a um gateway.

Syntax

Remove-AzApiManagementApiFromGateway
      -Context <PsApiManagementContext>
      -GatewayId <String>
      -ApiId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O cmdlet Remove-AzApiManagementApiFromGateway anexa uma API a um gateway.

Exemplos

Exemplo 1: Remover uma API de um gateway

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiFromGateway -Context $ApiMgmtContext -GatewayId "0123456789" -ApiId "0001" -PassThru

Este comando remove a API especificada de um gateway.

Exemplo 2: Remover uma API de um gateway gerenciado

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiFromGateway -Context $ApiMgmtContext -GatewayId "managed" -ApiId "0001" -PassThru

Este comando remove a API especificada do gateway gerenciado.

Parâmetros

-ApiId

Identificador de APIs existentes a serem removidas 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

-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

-GatewayId

Identificador do Gateway existente do qual remover a API. Este parâmetro é obrigatório.

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

-PassThru

Se especificado irá escrever true caso a operação seja bem-sucedida. Este parâmetro é opcional. O valor predefinido é falso.

Tipo:SwitchParameter
Position:Named
valor predefinido:None
Necessário:False
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

SwitchParameter

Saídas

Boolean