通过

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

Set-AzApiManagementProduct

  • 参考
模块:
Az.ApiManagement

设置API 管理产品详细信息。

语法

Set-AzApiManagementProduct
   -Context <PsApiManagementContext>
   -ProductId <String>
   [-Title <String>]
   [-Description <String>]
   [-LegalTerms <String>]
   [-SubscriptionRequired <Boolean>]
   [-ApprovalRequired <Boolean>]
   [-SubscriptionsLimit <Int32>]
   [-State <PsApiManagementProductState>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Set-AzApiManagementProduct cmdlet 设置API 管理产品详细信息。

示例

示例 1：更新产品详细信息

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $True -State "NotPublished"

此命令更新API 管理产品详细信息，需要订阅，然后取消发布。

参数

-ApprovalRequired

指示产品订阅是否需要批准。 默认值为 $False。

类型:Nullable<T>[Boolean]
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型: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:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

指定产品说明。

类型:String
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-LegalTerms

指定产品的法律使用条款。

类型:String
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

passthru

类型:SwitchParameter
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-ProductId

指定现有产品的标识符。

类型:String
Position:Named
默认值:None
必需:True
Accept pipeline input:True
Accept wildcard characters:False

-State

指定产品状态。 psdx_paramvalues

  • NotPublished
  • 已发行
类型:Nullable<T>[PsApiManagementProductState]
接受的值:NotPublished, Published
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionRequired

指示产品是否需要订阅。 此参数的默认值为 $True。

类型:Nullable<T>[Boolean]
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionsLimit

指定同时订阅的最大数目。 此参数的默认值为 None。

类型:Nullable<T>[Int32]
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-Title

指定此 cmdlet 集的产品标题。

类型:String
Position:Named
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
Aliases:wi
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PsApiManagementContext

String

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

SwitchParameter

输出

PsApiManagementProduct