Get-AzApiManagementPolicy
Obtém a política de escopo especificada.
Sintaxe
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
O cmdlet Get-AzApiManagementPolicy obtém a política de escopo especificada.
Exemplos
Exemplo 1: Obter a política de nível de locatário
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -SaveAs "C:\contoso\policies\tenantpolicy.xml"Esse comando obtém a política de nível de locatário e a salva em um arquivo chamado tenantpolicy.xml.
Exemplo 2: Obter a política de escopo do produto
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -ProductId "0123456789"Este comando obtém a política de escopo do produto
Exemplo 3: Obter a política de escopo da API
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210"Esse comando obtém a política de escopo da API.
Exemplo 4: Obter a política de escopo de operação
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777"Esse comando obtém a política de escopo de operação.
Exemplo 5: Obter a política de escopo do locatário no 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>Esse comando obtém a política de escopo do locatário no formato de escape não Xml.
Parâmetros
-ApiId
Especifica o identificador da API existente. Se você especificar esse parâmetro, o cmdlet retornará 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 de revisão da API. Esse parâmetro é opcional. Se não for especificada, a política será recuperada da 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 |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
| Tipo: | SwitchParameter |
| Aliases: | cf |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Context
Especifica uma instância de PsApiManagementContext.
| 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 |
-Force
ps_force
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-Format
Especifica o formato da política de gerenciamento de API. O valor padrão para esse parâmetro é "xml".
| 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 de API existente. Se você especificar esse parâmetro com ApiId , o cmdlet retornará a política de escopo de operação.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-ProductId
Especifica o identificador de um produto existente. Se você especificar esse parâmetro, o cmdlet retornará 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 |
-SaveAs
Especifica o caminho do arquivo no qual salvar o resultado. Se você não especificar esse parâmetro, o resultado será encanado como uma picada.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
| Tipo: | SwitchParameter |
| Aliases: | wi |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |