Partager via

Set-AzApiManagementPolicy

  • Référence
Module:
Az.ApiManagement

Définit la stratégie d’étendue spécifiée pour Gestion des API.

Syntaxe

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

La cmdlet Set-AzApiManagementPolicy définit la stratégie d’étendue spécifiée pour gestion des API.

Exemples

Exemple 1 : Définir la stratégie au niveau du locataire

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

Cette commande définit la stratégie au niveau du locataire à partir d’un fichier nommé tenantpolicy.xml.

Exemple 2 : Définir une stratégie d’étendue de produit

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

Cette commande définit la stratégie d’étendue du produit pour gestion des API.

Exemple 3 : Définir une stratégie d’étendue d’API

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

Cette commande définit la stratégie d’étendue de l’API pour gestion des API.

Exemple 4 : Définir une stratégie d’étendue d’opération

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

Cette commande définit la stratégie d’étendue des opérations pour gestion des API.

Paramètres

-ApiId

Spécifie l’identificateur de l’API existante. Si vous spécifiez ce paramètre, l’applet de commande définit la stratégie d’étendue de l’API.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ApiRevision

Identificateur de révision de l’API. Ce paramètre est facultatif. Si elle n’est pas spécifiée, la stratégie est mise à jour dans la révision de l’API actuellement active.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Context

Spécifie l’instance de PsApiManagementContext.

Type:PsApiManagementContext
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Format

Spécifie le format de la stratégie. Lorsque vous utilisez application/vnd.ms-azure-apim.policy+xml, les expressions contenues dans la stratégie doivent être placées en échappement XML. Lorsque vous utilisez application/vnd.ms-azure-apim.policy.raw+xml il n’est pas nécessaire que la stratégie soit placée en échappement XML. La valeur par défaut est application/vnd.ms-azure-apim.policy+xml. Ce paramètre est facultatif.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-OperationId

Spécifie l’identificateur de l’opération existante. Si elle est spécifiée avec ApiId, la stratégie d’étendue des opérations est définie. Ces paramètres sont obligatoires.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-PassThru

passthru

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Policy

Spécifie le document de stratégie sous forme de chaîne. Ce paramètre est obligatoire si le PolicyFilePathn’est pas spécifié.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-PolicyFilePath

Spécifie le chemin du fichier de document de stratégie. Ce paramètre est requis si le paramètre Policy n’est pas spécifié.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-PolicyUrl

URL où le document de stratégie est hébergé. Ce paramètre est obligatoire si -Policy ou -PolicyFilePath n’est pas spécifié.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-ProductId

Spécifie l’identificateur du produit existant. Si ce paramètre est spécifié, l’applet de commande définit la stratégie d’étendue du produit.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

Entrées

PsApiManagementContext

String

SwitchParameter

Sorties

Boolean