Get-AzureRmApiManagementPolicy
指定したスコープ ポリシーを取得します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Get-AzureRmApiManagementPolicy
-Context <PsApiManagementContext>
[-Format <String>]
[-SaveAs <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-AzureRmApiManagementPolicy
-Context <PsApiManagementContext>
[-Format <String>]
[-SaveAs <String>]
-ProductId <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-AzureRmApiManagementPolicy
-Context <PsApiManagementContext>
[-Format <String>]
[-SaveAs <String>]
-ApiId <String>
[-ApiRevision <String>]
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Get-AzureRmApiManagementPolicy
-Context <PsApiManagementContext>
[-Format <String>]
[-SaveAs <String>]
-ApiId <String>
[-ApiRevision <String>]
-OperationId <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Get-AzureRmApiManagementPolicy コマンドレットは、指定されたスコープ ポリシーを取得します。
例
例 1: テナント レベルのポリシーを取得する
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -SaveAs "C:\contoso\policies\tenantpolicy.xml"このコマンドは、テナント レベルのポリシーを取得し、tenantpolicy.xmlという名前のファイルに保存します。
例 2: 製品スコープ ポリシーを取得する
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ProductId "0123456789"このコマンドは、製品スコープ ポリシーを取得します
例 3: API スコープ ポリシーを取得する
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210"このコマンドは、API スコープ ポリシーを取得します。
例 4: 操作スコープ ポリシーを取得する
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777"このコマンドは、操作スコープ ポリシーを取得します。
パラメーター
-ApiId
既存の API の識別子を指定します。 このパラメーターを指定すると、コマンドレットは API スコープ ポリシーを返します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ApiRevision
API リビジョンの識別子。 このパラメーターは省略可能です。 指定しない場合、ポリシーは現在アクティブな API リビジョンから取得されます。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Context
PsApiManagementContext の インスタンスを指定します。
| 型: | PsApiManagementContext |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
ps_force
| 型: | SwitchParameter |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Format
API 管理ポリシーの形式を指定します。 このパラメーターの既定値は "application/vnd.ms-azure-apim.policy+xml" です。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OperationId
既存の API 操作の識別子を指定します。 ApiId でこのパラメーターを指定すると、コマンドレットは操作スコープ ポリシーを返します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ProductId
既存の製品の識別子を指定します。 このパラメーターを指定すると、コマンドレットは製品スコープ ポリシーを返します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SaveAs
結果を保存するファイル パスを指定します。 このパラメーターを指定しない場合、結果はスティングとしてパイプライン化されます。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |