Set-AzApiManagementPolicy

  • Riferimento
Modulo:
Az.ApiManagement

Imposta i criteri di ambito specificati per Gestione API.

Sintassi

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

Descrizione

Il cmdlet Set-AzApiManagementPolicy imposta i criteri di ambito specificati per Gestione API.

Esempio

Esempio 1: Impostare i criteri a livello di tenant

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

Questo comando imposta i criteri a livello di tenant da un file denominato tenantpolicy.xml.

Esempio 2: Impostare un criterio di ambito prodotto

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

Questo comando imposta i criteri di ambito prodotto per Gestione API.

Esempio 3: Impostare criteri di ambito API

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

Questo comando imposta i criteri dell'ambito API per Gestione API.

Esempio 4: Impostare i criteri di ambito dell'operazione

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

Questo comando imposta i criteri di ambito dell'operazione per Gestione API.

Parametri

-ApiId

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

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ApiRevision

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

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Context

Specifica l'istanza di PsApiManagementContext.

Tipo:PsApiManagementContext
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-DefaultProfile

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

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Format

Specifica il formato dei criteri. Quando si usa application/vnd.ms-azure-apim.policy+xml, le espressioni contenute nei criteri devono essere precedute da un escape XML. Quando si usa application/vnd.ms-azure-apim.policy.raw+xml non è necessario che il criterio venga preceduto da un escape XML. Il valore predefinito è application/vnd.ms-azure-apim.policy+xml. Il parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-OperationId

Specifica l'identificatore dell'operazione esistente. Se specificato con ApiId, i criteri di ambito dell'operazione verranno impostati. Questo parametro è obbligatorio.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-PassThru

passthru

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Policy

Specifica il documento dei criteri come stringa. Questo parametro è obbligatorio se -PolicyFilePath non è specificato.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-PolicyFilePath

Specifica il percorso del file del documento dei criteri. Questo parametro è obbligatorio se il parametro Policy non è specificato.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-PolicyUrl

URL in cui è ospitato il documento Criteri. Questo parametro è obbligatorio se -Policy o -PolicyFilePath non è specificato.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-ProductId

Specifica l'identificatore del prodotto esistente. Se questo parametro viene specificato, il cmdlet imposta i criteri di ambito prodotto.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

Input

PsApiManagementContext

String

SwitchParameter

Output

Boolean