Get-AzApiManagementPolicy

  • 參考
模組:
Az.ApiManagement

取得指定的範圍原則。

Syntax

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

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

指定要儲存結果的檔案路徑。 如果您未指定此參數，則結果會管線為 sting。

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