Compartir a través de

Set-AzApiManagementPolicy

  • Referencia
Módulo:
Az.ApiManagement

Establece la directiva de ámbito especificada para API Management.

Sintaxis

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

El cmdlet Set-AzApiManagementPolicy establece la directiva de ámbito especificada para API Management.

Ejemplos

Ejemplo 1: Establecimiento de la directiva de nivel de inquilino

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

Este comando establece la directiva de nivel de inquilino de un archivo denominado tenantpolicy.xml.

Ejemplo 2: Establecimiento de una directiva de ámbito de producto

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

Este comando establece la directiva de ámbito de producto para API Management.

Ejemplo 3: Establecimiento de la directiva de ámbito de API

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

Este comando establece la directiva de ámbito de API para API Management.

Ejemplo 4: Establecimiento de la directiva de ámbito de operación

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

Este comando establece la directiva de ámbito de operación para API Management.

Parámetros

-ApiId

Especifica el identificador de la API existente. Si especifica este parámetro, el cmdlet establece la directiva de ámbito de API.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ApiRevision

Identificador de revisión de API. Este parámetro es opcional. Si no se especifica, la directiva se actualizará en la revisión de api activa actualmente.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Context

Especifica la instancia de PsApiManagementContext.

Tipo:PsApiManagementContext
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Format

Especifica el formato de la directiva. Cuando se usa application/vnd.ms-azure-apim.policy+xml, las expresiones contenidas en la directiva deben tener escape XML. Cuando se usaapplication/vnd.ms-azure-apim.policy.raw+xml, no es necesario que la directiva sea de escape XML. El valor predeterminado es application/vnd.ms-azure-apim.policy+xml. Este parámetro es opcional.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-OperationId

Especifica el identificador de la operación existente. Si se especifica con ApiId, se establecerá la directiva de ámbito de operación. Estos parámetros son necesarios.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-PassThru

passthru

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-Policy

Especifica el documento de directiva como una cadena. Este parámetro es necesario si no se especifica -PolicyFilePath .

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-PolicyFilePath

Especifica la ruta de acceso del archivo del documento de directiva. Este parámetro es necesario si no se especifica el parámetro Policy .

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-PolicyUrl

Dirección URL donde se hospeda el documento de directiva. Este parámetro es necesario si no se especifica -Policy o -PolicyFilePath.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

-ProductId

Especifica el identificador del producto existente. Si se especifica este parámetro, el cmdlet establece la directiva de ámbito de producto.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:True
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False

Entradas

PsApiManagementContext

String

SwitchParameter

Salidas

Boolean