Delen via

Set-AzApiManagementPolicy

  • Referentie
Module:
Az.ApiManagement

Hiermee stelt u het opgegeven bereikbeleid voor API Management in.

Syntaxis

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>]

Description

De cmdlet Set-AzApiManagementPolicy stelt het opgegeven bereikbeleid voor API Management in.

Voorbeelden

Voorbeeld 1: Het beleid op tenantniveau instellen

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

Met deze opdracht stelt u het beleid op tenantniveau in van een bestand met de naam tenantpolicy.xml.

Voorbeeld 2: Beleid voor productbereik instellen

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

Met deze opdracht wordt het beleid voor productbereik voor API Management ingesteld.

Voorbeeld 3: Beleid voor API-bereik instellen

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

Met deze opdracht stelt u api-scope-beleid in voor API Management.

Voorbeeld 4: Beleid voor bewerkingsbereik instellen

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

Met deze opdracht stelt u het bewerkingsbereikbeleid voor API Management in.

Parameters

-ApiId

Hiermee geeft u de id van de bestaande API. Als u deze parameter opgeeft, stelt de cmdlet het API-bereikbeleid in.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-ApiRevision

Id van API-revisie. Deze parameter is optioneel. Als dit niet is opgegeven, wordt het beleid bijgewerkt in de huidige actieve API-revisie.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Context

Hiermee geeft u het exemplaar van PsApiManagementContext.

Type:PsApiManagementContext
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-DefaultProfile

De referenties, het account, de tenant en het abonnement die worden gebruikt voor communicatie met Azure.

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Format

Hiermee geeft u de indeling van het beleid. Wanneer u expressies in het beleid gebruikt application/vnd.ms-azure-apim.policy+xml, moeten XML-escaped zijn. Wanneer u het beleid gebruikt application/vnd.ms-azure-apim.policy.raw+xml , is het niet nodig om een XML-escape-bestand te maken. De standaardwaarde is application/vnd.ms-azure-apim.policy+xml. Deze parameter is optioneel.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-OperationId

Hiermee geeft u de id van de bestaande bewerking. Als dit is opgegeven met ApiId, wordt beleid voor bewerkingsbereik ingesteld. Deze parameters zijn vereist.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-PassThru

passthru

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Policy

Hiermee geeft u het beleidsdocument op als een tekenreeks. Deze parameter is vereist als -PolicyFilePath niet is opgegeven.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-PolicyFilePath

Hiermee geeft u het bestandspad voor het beleidsdocument op. Deze parameter is vereist als de beleidsparameter niet is opgegeven.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-PolicyUrl

De URL waar het beleidsdocument wordt gehost. Deze parameter is vereist als -Policy of -PolicyFilePath niet is opgegeven.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-ProductId

Hiermee geeft u de id van het bestaande product. Als deze parameter is opgegeven, stelt de cmdlet het beleid voor productbereik in.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

Invoerwaarden

PsApiManagementContext

String

SwitchParameter

Uitvoerwaarden

Boolean