Freigeben über

Remove-AzApiManagementProduct

  • Referenz
Modul:
Az.ApiManagement

Entfernt ein vorhandenes API-Verwaltungsprodukt.

Syntax

Remove-AzApiManagementProduct
      -Context <PsApiManagementContext>
      -ProductId <String>
      [-DeleteSubscriptions]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Beschreibung

Das Cmdlet Remove-AzApiManagementProduct entfernt ein vorhandenes API-Verwaltungsprodukt.

Beispiele

Beispiel 1: Entfernen eines vorhandenen Produkts und aller Abonnements

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -DeleteSubscriptions

Mit diesem Befehl wird ein vorhandenes Produkt und alle Abonnements entfernt.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

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

-Context

Gibt eine Instanz des PsApiManagementContext -Objekts an.

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

-DeleteSubscriptions

Gibt an, ob Abonnements für das Produkt gelöscht werden sollen. Wenn Sie diesen Parameter nicht festlegen und Abonnements vorhanden sind, wird eine Ausnahme ausgelöst.

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

-PassThru

Gibt an, dass dieses Cmdlet einen Wert von $True zurückgibt, wenn es erfolgreich ist, oder einen Wert von $False, wenn es fehlschlägt.

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

-ProductId

Gibt den Bezeichner des vorhandenen Produkts an.

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

-WhatIf

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

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

Eingaben

PsApiManagementContext

String

SwitchParameter

Ausgaben

Boolean