Share via

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Get-AzApiManagementPolicy

  • 参考
模块:
Az.ApiManagement

获取指定的范围策略。

语法

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>]

说明

Get-AzApiManagementPolicy cmdlet 获取指定的范围策略。

示例

示例 1：获取租户级别策略

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

此命令获取租户级别策略并将其保存到名为tenantpolicy.xml的文件。

示例 2：获取产品范围策略

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

此命令获取产品范围策略

示例 3：获取 API 范围策略

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

此命令获取 API 范围策略。

示例 4：获取操作范围策略

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

此命令获取操作范围策略。

示例 5：获取 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>

此命令获取非 Xml 转义格式的租户范围策略。

参数

-ApiId

指定现有 API 的标识符。 如果指定此参数，cmdlet 将返回 API 范围策略。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiRevision

API 修订的标识符。 此参数是可选的。 如果未指定，将从当前活动 API 修订中检索策略。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

指定 PsApiManagementContext 的实例。

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

ps_force

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Format

指定 API 管理策略的格式。 此参数的默认值为“xml”。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OperationId

指定现有 API 操作的标识符。 如果使用 ApiId 指定此参数，cmdlet 将返回操作范围策略。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProductId

指定现有产品的标识符。 如果指定此参数，cmdlet 将返回产品范围策略。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SaveAs

指定要将结果保存到的文件路径。 如果未指定此参数，则结果将作为刺痛进行管道处理。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PsApiManagementContext

String

SwitchParameter

输出

String