Remove-AzApiManagementApiFromGateway

Referens

Modul:: Az.ApiManagement

Kopplar ett API till en gateway.

Syntax

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

Description

Cmdleten Remove-AzApiManagementApiFromGateway kopplar ett API till en gateway.

Exempel

Exempel 1: Ta bort ett API från en gateway

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

Det här kommandot tar bort det angivna API:et från en gateway.

Exempel 2: Ta bort ett API från en hanterad gateway

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

Det här kommandot tar bort det angivna API:et från den hanterade gatewayen.

Parametrar

-ApiId

Identifierare för befintliga API:er som ska ta bort från gatewayen. Den här parametern krävs.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:	SwitchParameter
Alias:	cf
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Context

Instans av PsApiManagementContext. Den här parametern krävs.

Typ:	PsApiManagementContext
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-GatewayId

Identifierare för befintlig gateway som API:et ska ta borts från. Den här parametern krävs.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-PassThru

Om det anges skrivs true om åtgärden lyckas. Den här parametern är valfri. Standardvärdet är falskt.

Typ:	SwitchParameter
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-WhatIf

Visar vad som skulle hända om cmdleten körs. Cmdleten körs inte.

Typ:	SwitchParameter
Alias:	wi
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

Indata

PsApiManagementContext

String

SwitchParameter

Utdata

Boolean

Dela via