共用方式為

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

Description

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
接受管線輸入:True
接受萬用字元:False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

類型:SwitchParameter
別名:cf
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Context

指定 PsApiManagementContext 物件的實例。

類型:PsApiManagementContext
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶。

類型:IAzureContextContainer
別名:AzContext, AzureRmContext, AzureCredential
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-Description

指定產品描述。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-LegalTerms

指定產品的法律使用規定。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-PassThru

passthru

類型:SwitchParameter
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ProductId

指定現有產品的識別碼。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-State

指定產品狀態。 psdx_paramvalues

  • NotPublished
  • 發表
類型:Nullable<T>[PsApiManagementProductState]
接受的值:NotPublished, Published
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-SubscriptionRequired

指出產品是否需要訂閱。 這個參數預設值為 $True。

類型:Nullable<T>[Boolean]
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-SubscriptionsLimit

指定同時訂閱的最大數目。 此參數的預設值為 None。

類型:Nullable<T>[Int32]
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Title

指定此 Cmdlet 設定的產品標題。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。 Cmdlet 未執行。

類型:SwitchParameter
別名:wi
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元: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