Get-​Azure​Rm​Api​Management​Policy

Gets the specified scope policy.

Syntax

Get-AzureRmApiManagementPolicy
   -ApiId <String>
   -Context <PsApiManagementContext>
   [-Force]
   [-Format <String>]
   [-SaveAs <String>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
Get-AzureRmApiManagementPolicy
   -ApiId <String>
   -Context <PsApiManagementContext>
   [-Force]
   [-Format <String>]
   -OperationId <String>
   [-SaveAs <String>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
Get-AzureRmApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Force]
   [-Format <String>]
   -ProductId <String>
   [-SaveAs <String>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The Get-AzureRmApiManagementPolicy cmdlet gets the specified scope policy.

Examples

Example 1: Get the tenant level policy

PS C:\>Get-AzureRmApiManagementPolicy -Context $APImContext -SaveAs "C:\contoso\policies\tenantpolicy.xml"

This command gets tenant level policy and saves it to a file named tenantpolicy.xml.

Example 2: Get the product-scope policy

PS C:\>Get-AzureRmApiManagementPolicy -Context $APImContext -ProductId "0123456789"

This command gets product-scope policy

Example 3: Get the API-scope policy

PS C:\>Get-AzureRmApiManagementPolicy -Context $APImContext -ApiId "9876543210"

This command gets API-scope policy.

Example 4: Get the operation-scope policy

PS C:\>Get-AzureRmApiManagementPolicy -Context $APImContext -ApiId "9876543210" -OperationId "777"

This command gets the operation-scope policy.

Required Parameters

-ApiId

Specifies the identifier of the existing API. If you specify this parameter the cmdlet returns the API-scope policy.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Context

Specifies an instance of PsApiManagementContext.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-OperationId

Specifies the identifier of the existing API operation. If you specify this parameter with ApiId the cmdlet returns operation-scope policy.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ProductId

Specifies the identifier of an existing product. If you specify this parameter the cmdlet returns the product-scope policy.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

ps_force

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Format

Specifies the format of the API management policy. The default value for this parameter is "application/vnd.ms-azure-apim.policy+xml".

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SaveAs

Specifies the file path to save the result to. If you do not specify this parameter the result is pipelined as a sting.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Outputs

String