Compartilhar via

Set-AzApiManagementPolicy

  • Referência
Módulo:
Az.ApiManagement

Define a política de escopo especificada para o Gerenciamento de API.

Sintaxe

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

O cmdlet Set-AzApiManagementPolicy define a política de escopo especificada para o Gerenciamento de API.

Exemplos

Exemplo 1: Definir a política de nível de locatário

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

Esse comando define a política de nível de locatário de um arquivo chamado tenantpolicy.xml.

Exemplo 2: Definir uma política de escopo do produto

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

Esse comando define a política de escopo do produto para o Gerenciamento de API.

Exemplo 3: Definir a política de escopo da API

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

Esse comando define a política de escopo da API para o Gerenciamento de API.

Exemplo 4: Definir política de escopo de operação

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

Esse comando define a política de escopo de operação para o Gerenciamento de API.

Parâmetros

-ApiId

Especifica o identificador da API existente. Se você especificar esse parâmetro, o cmdlet definirá a política de escopo da API.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ApiRevision

Identificador da Revisão de API. Esse parâmetro é opcional. Se não for especificado, a política será atualizada na revisão da API ativa no momento.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Context

Especifica a instância doPsApiManagementContext .

Tipo:PsApiManagementContext
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Format

Especifica o formato da política. Ao usar application/vnd.ms-azure-apim.policy+xml, as expressões contidas na política devem ser escapadas por XML. Ao usar application/vnd.ms-azure-apim.policy.raw+xml não é necessário para que a política seja escapada por XML. O valor padrão é application/vnd.ms-azure-apim.policy+xml. Esse parâmetro é opcional.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-OperationId

Especifica o identificador da operação existente. Se especificado com a ApiId definirá a política de escopo de operação. Esses parâmetros são necessários.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PassThru

passthru

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Policy

Especifica o documento de política como uma cadeia de caracteres. Esse parâmetro será necessário se o PolicyFilePathnão for especificado.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PolicyFilePath

Especifica o caminho do arquivo do documento de política. Esse parâmetro será necessário se o parâmetro Policy não for especificado.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PolicyUrl

A URL em que o documento de política está hospedado. Esse parâmetro será necessário se -Policy ou -PolicyFilePath não for especificado.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ProductId

Especifica o identificador do produto existente. Se esse parâmetro for especificado, o cmdlet definirá a política de escopo do produto.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

Entradas

PsApiManagementContext

String

SwitchParameter

Saídas

Boolean