Share via

Remove-AzApiManagementApiFromGateway

  • Referentie
Module:
Az.ApiManagement

Koppelt een API aan een gateway.

Syntax

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

Description

De cmdlet Remove-AzApiManagementApiFromGateway koppelt een API aan een gateway.

Voorbeelden

Voorbeeld 1: Een API verwijderen uit een gateway

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

Met deze opdracht verwijdert u de opgegeven API uit een gateway.

Voorbeeld 2: Een API verwijderen uit een beheerde gateway

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

Met deze opdracht verwijdert u de opgegeven API uit de beheerde gateway.

Parameters

-ApiId

Id van bestaande API's die moeten worden verwijderd uit de gateway. Deze parameter is vereist.

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

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-Context

Exemplaar van PsApiManagementContext. Deze parameter is vereist.

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

-DefaultProfile

De referenties, accounts, tenants en abonnementen die worden gebruikt voor communicatie met Azure.

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

-GatewayId

Id van bestaande gateway waaruit DE API moet worden verwijderd. Deze parameter is vereist.

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

-PassThru

Als de opgegeven waarde waar schrijft voor het geval de bewerking slaagt. Deze parameter is optioneel. De standaardwaarde is false.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

PsApiManagementContext

String

SwitchParameter

Uitvoerwaarden

Boolean