Set-AzApiManagementPolicy

モジュール:

Az.ApiManagement

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 スコープ ポリシーが設定されます。

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

-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

-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 です。 このパラメーターは省略可能です。

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

-OperationId

既存の操作の識別子を指定します。 ApiId で指定すると、操作スコープ ポリシーが設定されます。 このパラメーターは必須です。

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

-PassThru

Passthru

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

-Policy

ポリシー ドキュメントを文字列として指定します。 -PolicyFilePath が指定されていない場合は、このパラメーターが必要です。

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

-PolicyFilePath

ポリシー ドキュメント ファイルのパスを指定します。 Policy パラメーターが指定されていない場合は、このパラメーターが必要です。

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

-PolicyUrl

ポリシー ドキュメントがホストされている URL。 -Policy または -PolicyFilePath が指定されていない場合は、このパラメーターが必要です。

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

-ProductId

既存の製品の識別子を指定します。 このパラメーターを指定すると、コマンドレットによって製品スコープ ポリシーが設定されます。

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

入力

PsApiManagementContext

String

SwitchParameter

出力

Boolean

関連リンク

• Get-AzApiManagementPolicy
• Remove-AzApiManagementPolicy