Set-AzApiManagementPolicy

  • Referenz
Modul:
Az.ApiManagement

Legt die angegebene Bereichsrichtlinie für die API-Verwaltung fest.

Syntax

Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   -ProductId <String>
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   -OperationId <String>
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Beschreibung

Das Cmdlet Set-AzApiManagementPolicy legt die angegebene Bereichsrichtlinie für die API-Verwaltung fest.

Beispiele

Beispiel 1: Festlegen der Richtlinie auf Mandantenebene

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -PolicyFilePath "C:\contoso\policies\tenantpolicy.xml"

Mit diesem Befehl wird die Richtlinie auf Mandantenebene aus einer Datei namens tenantpolicy.xml festgelegt.

Beispiel 2: Festlegen einer Produktbereichsrichtlinie

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

Mit diesem Befehl wird die Produktbereichsrichtlinie für die API-Verwaltung festgelegt.

Beispiel 3: Festlegen einer API-Bereichsrichtlinie

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

Dieser Befehl legt die API-Bereichsrichtlinie für die API-Verwaltung fest.

Beispiel 4: Festlegen der Richtlinie für den Vorgangsbereich

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

Mit diesem Befehl wird die Vorgangsbereichsrichtlinie für die API-Verwaltung festgelegt.

Parameter

-ApiId

Gibt den Bezeichner der vorhandenen API an. Wenn Sie diesen Parameter angeben, legt das Cmdlet die API-Bereichsrichtlinie fest.

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

-ApiRevision

Bezeichner der API-Revision. Dieser Parameter ist optional. Wenn nicht angegeben, wird die Richtlinie in der derzeit aktiven API-Revision aktualisiert.

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

-Context

Gibt die Instanz von PsApiManagementContext 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

-Format

Gibt das Format der Richtlinie an. Bei Verwendung application/vnd.ms-azure-apim.policy+xmlvon Ausdrücken, die in der Richtlinie enthalten sind, muss xml-escaped sein. Bei Verwendung application/vnd.ms-azure-apim.policy.raw+xml ist es nicht erforderlich, dass die Richtlinie XML-Escapezeichen enthält. Der Standardwert ist application/vnd.ms-azure-apim.policy+xml. Dieser Parameter ist optional.

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

-OperationId

Gibt den Bezeichner des vorhandenen Vorgangs an. Wenn mit ApiId angegeben, wird die Richtlinie für den Vorgangsbereich festgelegt. Diese Parameter sind erforderlich.

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

-PassThru

passthru

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

-Policy

Gibt das Richtliniendokument als Zeichenfolge an. Dieser Parameter ist erforderlich, wenn der -PolicyFilePath nicht angegeben ist.

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

-PolicyFilePath

Gibt den Pfad der Richtliniendokumentdatei an. Dieser Parameter ist erforderlich, wenn der Policy-Parameter nicht angegeben ist.

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

-PolicyUrl

Die URL, unter der das Richtliniendokument gehostet wird. Dieser Parameter ist erforderlich, wenn -Policy oder -PolicyFilePath nicht angegeben ist.

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

-ProductId

Gibt den Bezeichner des vorhandenen Produkts an. Wenn dieser Parameter angegeben ist, legt das Cmdlet die Produktbereichsrichtlinie fest.

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

Eingaben

PsApiManagementContext

String

SwitchParameter

Ausgaben

Boolean