Get-AzApiManagementPolicy
Obtiene la directiva de ámbito especificada.
Sintaxis
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>]
Description
El cmdlet Get-AzApiManagementPolicy obtiene la directiva de ámbito especificada.
Ejemplos
Ejemplo 1: Obtención de la directiva de nivel de inquilino
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -SaveAs "C:\contoso\policies\tenantpolicy.xml"
Este comando obtiene la directiva de nivel de inquilino y la guarda en un archivo denominado tenantpolicy.xml.
Ejemplo 2: Obtención de la directiva de ámbito de producto
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -ProductId "0123456789"
Este comando obtiene la directiva de ámbito de producto.
Ejemplo 3: Obtención de la directiva de ámbito de API
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210"
Este comando obtiene la directiva de ámbito de API.
Ejemplo 4: Obtención de la directiva de ámbito de operación
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777"
Este comando obtiene la directiva de ámbito de operación.
Ejemplo 5: Obtención de la directiva de ámbito de inquilino en 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>
Este comando obtiene la directiva de ámbito de inquilino en formato de escape no xml.
Parámetros
-ApiId
Especifica el identificador de la API existente. Si especifica este parámetro, el cmdlet devuelve 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 recuperará de 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 |
-Confirm
Le solicita su confirmación antes de ejecutar el cmdlet.
Tipo: | SwitchParameter |
Alias: | cf |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |
-Context
Especifica una 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 |
-Force
ps_force
Tipo: | SwitchParameter |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | True |
Aceptar caracteres comodín: | False |
-Format
Especifica el formato de la directiva de API Management. El valor predeterminado de este parámetro es "xml".
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 de API existente. Si especifica este parámetro con ApiId , el cmdlet devuelve la directiva de ámbito de operación.
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | True |
Aceptar entrada de canalización: | True |
Aceptar caracteres comodín: | False |
-ProductId
Especifica el identificador de un producto existente. Si especifica este parámetro, el cmdlet devuelve 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 |
-SaveAs
Especifica la ruta de acceso del archivo en la que guardar el resultado. Si no especifica este parámetro, el resultado se canalizará como un sting.
Tipo: | String |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | True |
Aceptar caracteres comodín: | False |
-WhatIf
Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.
Tipo: | SwitchParameter |
Alias: | wi |
Posición: | Named |
Valor predeterminado: | None |
Requerido: | False |
Aceptar entrada de canalización: | False |
Aceptar caracteres comodín: | False |