Udostępnij za pośrednictwem

Set-AzApiManagementPolicy

  • Odwołanie
Moduł:
Az.ApiManagement

Ustawia określone zasady zakresu dla usługi API Management.

Składnia

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

Opis

Polecenie cmdlet Set-AzApiManagementPolicy ustawia określone zasady zakresu dla usługi API Management.

Przykłady

Przykład 1. Ustawianie zasad na poziomie dzierżawy

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

To polecenie ustawia zasady na poziomie dzierżawy z pliku o nazwie tenantpolicy.xml.

Przykład 2. Ustawianie zasad zakresu produktu

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

To polecenie ustawia zasady zakresu produktu dla usługi API Management.

Przykład 3. Ustawianie zasad zakresu interfejsu API

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

To polecenie ustawia zasady zakresu interfejsu API dla usługi API Management.

Przykład 4. Ustawianie zasad zakresu operacji

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

To polecenie ustawia zasady zakresu operacji dla usługi API Management.

Parametry

-ApiId

Określa identyfikator istniejącego interfejsu API. Jeśli określisz ten parametr, polecenie cmdlet ustawi zasady zakresu interfejsu API.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ApiRevision

Identyfikator poprawki interfejsu API. Ten parametr jest opcjonalny. Jeśli nie zostanie określony, zasady zostaną zaktualizowane w aktualnie aktywnej wersji interfejsu API.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Context

Określa wystąpienie PsApiManagementContext.

Typ:PsApiManagementContext
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Format

Określa format zasad. W przypadku używania application/vnd.ms-azure-apim.policy+xmlwyrażenia zawarte w zasadach muszą być uniknięciowe w formacie XML. W przypadku korzystania z application/vnd.ms-azure-apim.policy.raw+xml nie jest konieczne, aby zasady nie korzystały z formatu XML. Wartość domyślna to application/vnd.ms-azure-apim.policy+xml. Ten parametr jest opcjonalny.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-OperationId

Określa identyfikator istniejącej operacji. Jeśli określono parametr ApiId, ustawi zasady zakresu operacji. Te parametry są wymagane.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-PassThru

passthru

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Policy

Określa dokument zasad jako ciąg. Ten parametr jest wymagany, jeśli nie określonoPolicyFilePath.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-PolicyFilePath

Określa ścieżkę pliku dokumentu zasad. Ten parametr jest wymagany, jeśli nie określono parametru zasad.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-PolicyUrl

Adres URL, pod którym jest hostowany dokument zasad. Ten parametr jest wymagany, jeśli nie określono -Policy lub -PolicyFilePath.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-ProductId

Określa identyfikator istniejącego produktu. Jeśli ten parametr zostanie określony, polecenie cmdlet ustawi zasady zakresu produktu.

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

Dane wyjściowe