通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzApiManagementPolicy

  • 参考
模块:
Az.ApiManagement

设置 API 管理的指定范围策略。

语法

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 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 范围策略。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-ApiRevision

API 修订的标识符。 此参数是可选的。 如果未指定，策略将在当前活动 API 修订中更新。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Context

指定 PsApiManagementContext的实例。

类型:PsApiManagementContext
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position: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
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-OperationId

指定现有操作的标识符。 如果使用 ApiId 指定，则会设置操作范围策略。 此参数是必需的。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-PassThru

passthru

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-Policy

将策略文档指定为字符串。 如果未指定 -PolicyFilePath，则此参数是必需的。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-PolicyFilePath

指定策略文档文件路径。 如果未指定 Policy 参数，则此参数是必需的。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-PolicyUrl

托管策略文档的 URL。 如果未指定 -Policy 或 -PolicyFilePath，则此参数是必需的。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-ProductId

指定现有产品的标识符。 如果指定此参数，则 cmdlet 将设置产品范围策略。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

输入

PsApiManagementContext

String

SwitchParameter

输出

Boolean