Set-AzApiManagementPolicy
API Management の指定されたスコープ ポリシーを設定します。
構文
Set-AzApiManagementPolicy
-Context <PsApiManagementContext>
[-Format <String>]
[-Policy <String>]
[-PolicyFilePath <String>]
[-PolicyUrl <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzApiManagementPolicy
-Context <PsApiManagementContext>
[-Format <String>]
-ProductId <String>
[-Policy <String>]
[-PolicyFilePath <String>]
[-PolicyUrl <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzApiManagementPolicy
-Context <PsApiManagementContext>
[-Format <String>]
-ApiId <String>
[-ApiRevision <String>]
[-Policy <String>]
[-PolicyFilePath <String>]
[-PolicyUrl <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Set-AzApiManagementPolicy
-Context <PsApiManagementContext>
[-Format <String>]
-ApiId <String>
[-ApiRevision <String>]
-OperationId <String>
[-Policy <String>]
[-PolicyFilePath <String>]
[-PolicyUrl <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Set-AzApiManagementPolicy コマンドレットは、API Management の指定されたスコープ ポリシーを設定します。
例
例 1: テナント レベル ポリシーを設定する
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -PolicyFilePath "C:\contoso\policies\tenantpolicy.xml"このコマンドは、tenantpolicy.xmlという名前のファイルからテナント レベル ポリシーを設定します。
例 2: 製品スコープ ポリシーを設定する
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ProductId "0123456789" -Policy $PolicyStringこのコマンドは、API Management の製品スコープ ポリシーを設定します。
例 3: API スコープ ポリシーを設定する
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -Policy $PolicyStringこのコマンドは、API Management の API スコープ ポリシーを設定します。
例 4: 操作スコープ ポリシーを設定する
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" -Policy $PolicyStringこのコマンドは、API Management の操作スコープ ポリシーを設定します。
パラメーター
-ApiId
既存の API の識別子を指定します。 このパラメーターを指定すると、コマンドレットによって API スコープ ポリシーが設定されます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ApiRevision
API リビジョンの識別子。 このパラメーターは省略可能です。 指定しない場合、ポリシーは現在アクティブな API リビジョンで更新されます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Context
PsApiManagementContextのインスタンスを指定します。
| 型: | PsApiManagementContext |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Format
ポリシーの形式を指定します。 application/vnd.ms-azure-apim.policy+xmlを使用する場合は、ポリシーに含まれる式を XML エスケープする必要があります。 application/vnd.ms-azure-apim.policy.raw+xmlを使用する場合、ポリシーを XML エスケープ必要。
既定値は application/vnd.ms-azure-apim.policy+xml です。
このパラメーターは省略可能です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-OperationId
既存の操作の識別子を指定します。 ApiId で指定すると、操作スコープ ポリシーが設定されます。 このパラメーターは必須です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PassThru
passthru
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Policy
ポリシー ドキュメントを文字列として指定します。 -PolicyFilePath が指定されていない場合は、このパラメーターが必要です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PolicyFilePath
ポリシー ドキュメント ファイルのパスを指定します。 このパラメーターは、 Policy パラメーターが指定されていない場合に必要です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PolicyUrl
ポリシー ドキュメントがホストされている URL。 -Policy または -PolicyFilePath が指定されていない場合は、このパラメーターが必要です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ProductId
既存の製品の識別子を指定します。 このパラメーターを指定すると、コマンドレットによって製品スコープ ポリシーが設定されます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |