Sdílet prostřednictvím

Set-AzApiManagementPolicy

  • Reference
Modul:
Az.ApiManagement

Nastaví zadanou zásadu oboru pro 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

Rutina Set-AzApiManagementPolicy nastaví zadanou zásadu oboru pro API Management.

Příklady

Příklad 1: Nastavení zásad na úrovni tenanta

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

Tento příkaz nastaví zásadu na úrovni tenanta ze souboru s názvem tenantpolicy.xml.

Příklad 2: Nastavení zásad oboru produktů

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

Tento příkaz nastaví zásady oboru produktů pro SLUŽBU API Management.

Příklad 3: Nastavení zásad oboru rozhraní API

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

Tento příkaz nastaví zásady oboru rozhraní API pro službu API Management.

Příklad 4: Nastavení zásad oboru operací

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

Tento příkaz nastaví zásady oboru operací pro SLUŽBU API Management.

Parametry

-ApiId

Určuje identifikátor existujícího rozhraní API. Pokud zadáte tento parametr, rutina nastaví zásadu oboru rozhraní API.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiRevision

Identifikátor revize rozhraní API. Tento parametr je volitelný. Pokud není zadáno, zásady se aktualizují v aktuálně aktivní revizi rozhraní API.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-Context

Určuje instanci PsApiManagementContext.

Typ:PsApiManagementContext
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Typ:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:False
Accept wildcard characters:False

-Format

Určuje formát zásady. Při použití application/vnd.ms-azure-apim.policy+xmlvýrazů obsažených v zásadách musí být uchycené xml. Při použití application/vnd.ms-azure-apim.policy.raw+xml není nutné, aby zásada byla uchycená xml. Výchozí hodnota je application/vnd.ms-azure-apim.policy+xml. Tento parametr je volitelný.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-OperationId

Určuje identifikátor existující operace. Pokud je zadáno pomocí ApiId, nastaví zásady oboru operací. Tyto parametry jsou povinné.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-Policy

Určuje dokument zásad jako řetězec. Tento parametr je povinný, pokud není zadán parametr -PolicyFilePath .

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-PolicyFilePath

Určuje cestu k souboru dokumentu zásad. Tento parametr je povinný, pokud není zadán parametr Policy .

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-PolicyUrl

Adresa URL, kde je dokument zásad hostovaný. Tento parametr je povinný, pokud není zadán parametr -Policy nebo -PolicyFilePath.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:True
Accept wildcard characters:False

-ProductId

Určuje identifikátor existujícího produktu. Pokud je tento parametr zadaný, rutina nastaví zásadu oboru produktu.

Typ:String
Position:Named
výchozí hodnota:None
Vyžadováno:True
Accept pipeline input:True
Accept wildcard characters:False

Vstupy

PsApiManagementContext

String

SwitchParameter

Výstupy

Boolean