Remove-AzApiManagementApiFromGateway

Referenz

Modul:: Az.ApiManagement

Fügt eine API an ein Gateway an.

Syntax

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

Beschreibung

Das Remove-AzApiManagementApiFromGateway Cmdlet fügt eine API an ein Gateway an.

Beispiele

Beispiel 1: Entfernen einer API aus einem Gateway

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

Mit diesem Befehl wird die angegebene API von einem Gateway entfernt.

Beispiel 2: Entfernen einer API aus einem verwalteten Gateway

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

Mit diesem Befehl wird die angegebene API vom verwalteten Gateway entfernt.

Parameter

-ApiId

Bezeichner vorhandener APIs, die aus dem Gateway entfernt werden sollen. Dieser Parameter ist erforderlich.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Confirm

Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.

Typ:	SwitchParameter
Aliase:	cf
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Context

Instanz von PsApiManagementContext. Dieser Parameter ist erforderlich.

Typ:	PsApiManagementContext
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Typ:	IAzureContextContainer
Aliase:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-GatewayId

Bezeichner des vorhandenen Gateways, aus dem die API entfernt werden soll. Dieser Parameter ist erforderlich.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-PassThru

Wenn angegeben wird, wird true geschrieben, falls der Vorgang erfolgreich ist. Dieser Parameter ist optional. Der Standardwert ist "false".

Typ:	SwitchParameter
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:	SwitchParameter
Aliase:	wi
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

Eingaben

PsApiManagementContext

String

SwitchParameter

Ausgaben

Boolean

Freigeben über