Remove-AzApiManagementPolicy

  • Referenz
Modul:
Az.ApiManagement

Entfernt die API-Verwaltungsrichtlinie aus einem angegebenen Bereich.

Syntax

Remove-AzApiManagementPolicy
      -Context <PsApiManagementContext>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzApiManagementPolicy
      -Context <PsApiManagementContext>
      -ProductId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzApiManagementPolicy
      -Context <PsApiManagementContext>
      -ApiId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzApiManagementPolicy
      -Context <PsApiManagementContext>
      -ApiId <String>
      -OperationId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Beschreibung

Mit dem Cmdlet Remove-AzApiManagementPolicy wird die API-Verwaltungsrichtlinie aus dem angegebenen Bereich entfernt.

Beispiele

Beispiel 1: Entfernen der Richtlinie auf Mandantenebene

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementPolicy -Context $apimContext

Mit diesem Befehl wird die Richtlinie auf Mandantenebene aus der API-Verwaltung entfernt.

Beispiel 2: Entfernen der Produktbereichsrichtlinie

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

Mit diesem Befehl wird die Produktbereichsrichtlinie aus der API-Verwaltung entfernt.

Beispiel 3: Entfernen der API-Bereichsrichtlinie

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210"

Mit diesem Befehl wird die API-Bereichsrichtlinie aus der API-Verwaltung entfernt.

Beispiel 4: Entfernen der Vorgangsbereichsrichtlinie

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777"

Mit diesem Befehl wird die Vorgangsbereichsrichtlinie aus der API-Verwaltung entfernt.

Parameter

-ApiId

Gibt den Bezeichner einer vorhandenen API an. Wenn Sie diesen Parameter angeben, entfernt das Cmdlet die API-Bereichsrichtlinie.

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

-Confirm

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

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

-Context

Gibt die Instanz des PsApiManagementContext -Objekts an.

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

-DefaultProfile

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

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

-OperationId

Gibt den Bezeichner eines vorhandenen Vorgangs an. Wenn Sie diesen Parameter mit dem Parameter "ApiId" angeben, entfernt dieses Cmdlet die Richtlinie für den Vorgangsbereich.

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

-PassThru

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

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

-ProductId

Gibt den Bezeichner des vorhandenen Produkts an. Wenn Sie diesen Parameter angeben, entfernt das Cmdlet die Produktbereichsrichtlinie.

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

-WhatIf

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

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

Eingaben

PsApiManagementContext

String

SwitchParameter

Ausgaben

Boolean