Set-AzApiManagementPolicy

參考

模組:: Az.ApiManagement

設定 API 管理的指定範圍原則。

Syntax

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>]

Description

Set-AzApiManagementPolicy Cmdlet 會設定 API 管理的指定範圍原則。

範例

範例 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 管理的產品範圍原則。

範例 3：設定 API 範圍原則

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -Policy $PolicyString

此命令會設定 API 管理的 API 範圍原則。

範例 4：設定作業範圍原則

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" -Policy $PolicyString

此命令會設定 API 管理的作業範圍原則。

參數

-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

-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

指定現有產品的識別碼。如果指定此參數，Cmdlet 會設定產品範圍原則。

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

輸入

PsApiManagementContext

String

SwitchParameter

輸出

Boolean