Condividi tramite


Get-AzApiManagementPolicy

Ottiene i criteri di ambito specificati.

Sintassi

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

Descrizione

Il cmdlet Get-AzApiManagementPolicy ottiene i criteri di ambito specificati.

Esempio

Esempio 1: Ottenere i criteri a livello di tenant

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

Questo comando ottiene i criteri a livello di tenant e lo salva in un file denominato tenantpolicy.xml.

Esempio 2: Ottenere i criteri di ambito prodotto

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

Questo comando ottiene i criteri di ambito prodotto

Esempio 3: Ottenere i criteri dell'ambito API

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

Questo comando ottiene i criteri dell'ambito API.

Esempio 4: Ottenere i criteri di ambito dell'operazione

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

Questo comando ottiene i criteri dell'ambito dell'operazione.

Esempio 5: Ottenere i criteri di ambito tenant in formato 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>

Questo comando ottiene i criteri dell'ambito tenant in formato di escape non XML.

Parametri

-ApiId

Specifica l'identificatore dell'API esistente. Se si specifica questo parametro, il cmdlet restituisce i criteri dell'ambito API.

Tipo:String
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiRevision

Identificatore della revisione API. Il parametro è facoltativo. Se non specificato, il criterio verrà recuperato dalla revisione api attualmente attiva.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Specifica un'istanza di PsApiManagementContext.

Tipo:PsApiManagementContext
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

ps_force

Tipo:SwitchParameter
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-Format

Specifica il formato dei criteri di gestione API. Il valore predefinito per questo parametro è "xml".

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-OperationId

Specifica l'identificatore dell'operazione API esistente. Se si specifica questo parametro con ApiId , il cmdlet restituisce criteri di ambito operazione.

Tipo:String
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-ProductId

Specifica l'identificatore di un prodotto esistente. Se si specifica questo parametro, il cmdlet restituisce i criteri di ambito prodotto.

Tipo:String
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-SaveAs

Specifica il percorso del file in cui salvare il risultato. Se non si specifica questo parametro, il risultato viene inviato tramite pipeline come sting.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

Tipo:SwitchParameter
Aliases:wi
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:False
Accept wildcard characters:False

Input

PsApiManagementContext

String

SwitchParameter

Output

String