Sdílet prostřednictvím

Get-AzApiManagementPolicy

  • Reference
Modul:
Az.ApiManagement

Získá zadanou zásadu oboru.

Syntax

Get-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-SaveAs <String>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-SaveAs <String>]
   -ProductId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-SaveAs <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-SaveAs <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   -OperationId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Rutina Get-AzApiManagementPolicy získá zadanou zásadu oboru.

Příklady

Příklad 1: Získání zásad na úrovni tenanta

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

Tento příkaz získá zásady na úrovni tenanta a uloží je do souboru s názvem tenantpolicy.xml.

Příklad 2: Získání zásad oboru produktů

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

Tento příkaz získá zásady oboru produktů.

Příklad 3: Získání zásad oboru rozhraní API

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

Tento příkaz získá zásady oboru rozhraní API.

Příklad 4: Získání zásad oboru operací

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

Tento příkaz získá zásadu oboru operací.

Příklad 5: Získání zásad oboru tenanta ve formátu RawXml

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -Format rawxml

<policies>
        <inbound>
                <set-header name="correlationid" exists-action="skip">
                        <value>@{
                var guidBinary = new byte[16];
                Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);
                long time = DateTime.Now.Ticks;
                byte[] bytes = new byte[6];
                unchecked
                {
                       bytes[5] = (byte)(time >> 40);
                       bytes[4] = (byte)(time >> 32);
                       bytes[3] = (byte)(time >> 24);
                       bytes[2] = (byte)(time >> 16);
                       bytes[1] = (byte)(time >> 8);
                       bytes[0] = (byte)(time);
                }
                Array.Copy(bytes, 0, guidBinary, 10, 6);
                return new Guid(guidBinary).ToString();
            }
            </value>
                </set-header>
        </inbound>
        <backend>
                <forward-request />
        </backend>
        <outbound />
        <on-error />
</policies>

Tento příkaz získá zásadu oboru tenanta v řídicím formátu bez xml.

Parametry

-ApiId

Určuje identifikátor existujícího rozhraní API. Pokud zadáte tento parametr, rutina vrátí 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ásada se načte z aktuálně aktivní revize rozhraní API.

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

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

Typ:SwitchParameter
Aliases:cf
Position:Named
výchozí hodnota:None
Vyžadováno:False
Accept pipeline input:False
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

-Force

ps_force

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

-Format

Určuje formát zásad služby API Management. Výchozí hodnota pro tento parametr je xml.

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 rozhraní API. Pokud tento parametr zadáte pomocí ApiId , rutina vrátí zásadu oboru operace.

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

-ProductId

Určuje identifikátor existujícího produktu. Pokud tento parametr zadáte, rutina vrátí zásadu oboru produktu.

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

-SaveAs

Určuje cestu k souboru pro uložení výsledku. Pokud tento parametr nezadáte, bude výsledek kanálován jako bodnutí.

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

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

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

Vstupy

PsApiManagementContext

String

SwitchParameter

Výstupy

String