Dela via

Set-AzApiManagementPolicy

  • Referens
Modul:
Az.ApiManagement

Anger den angivna omfångsprincipen för API Management.

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

Description

Cmdleten Set-AzApiManagementPolicy anger den angivna omfångsprincipen för API Management.

Exempel

Exempel 1: Ange principen på klientnivå

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

Det här kommandot anger principen på klientnivå från en fil med namnet tenantpolicy.xml.

Exempel 2: Ange en princip för produktomfattning

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

Det här kommandot anger produktomfattningsprincipen för API Management.

Exempel 3: Ange API-omfångsprincip

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

Det här kommandot anger API-omfångsprincip för API Management.

Exempel 4: Ange princip för åtgärdsomfång

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

Det här kommandot anger åtgärdsomfångsprincip för API Management.

Parametrar

-ApiId

Anger identifieraren för det befintliga API:et. Om du anger den här parametern anger cmdleten API-omfångsprincipen.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ApiRevision

Identifierare för API Revision. Den här parametern är valfri. Om den inte anges uppdateras principen i den aktiva API-revisionen.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Context

Anger instansen av PsApiManagementContext.

Typ:PsApiManagementContext
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Format

Anger principens format. När du använder application/vnd.ms-azure-apim.policy+xmlmåste uttryck som ingår i principen vara XML-undantagna. När du använder application/vnd.ms-azure-apim.policy.raw+xml är det inte nödvändigt för att principen ska vara XML-undantagen. Standardvärdet är application/vnd.ms-azure-apim.policy+xml. Den här parametern är valfri.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-OperationId

Anger identifieraren för den befintliga åtgärden. Om det anges med ApiId anges en åtgärdsomfattningsprincip. De här parametrarna krävs.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Policy

Anger principdokumentet som en sträng. Den här parametern krävs omPolicyFilePath- inte har angetts.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-PolicyFilePath

Anger sökvägen till principdokumentfilen. Den här parametern krävs om parametern Policy inte har angetts.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-PolicyUrl

Url:en där principdokumentet finns. Den här parametern krävs om -Policy eller -PolicyFilePath inte har angetts.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ProductId

Anger identifieraren för den befintliga produkten. Om den här parametern anges anger cmdleten principen för produktomfattning.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

Indata

PsApiManagementContext

String

SwitchParameter

Utdata

Boolean