New-AzApiManagementProduct
建立 API 管理產品。
語法
New-AzApiManagementProduct
-Context <PsApiManagementContext>
[-ProductId <String>]
-Title <String>
[-Description <String>]
[-LegalTerms <String>]
[-SubscriptionRequired <Boolean>]
[-ApprovalRequired <Boolean>]
[-SubscriptionsLimit <Int32>]
[-State <PsApiManagementProductState>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
New-AzApiManagementProduct Cmdlet 會建立 API 管理 產品。
範例
範例 1：建立不需要訂閱的產品
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $False -State "Published"此命令會建立 API 管理產品。 不需要訂用帳戶。
範例 2：建立需要訂用帳戶和核准的產品
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementProduct -Context $apimContext -ProductId "9876543210" -Title "Unlimited" -Description "Subscribers have completely unlimited access to the API. Administrator approval is required." -LegalTerms "Free for all" -ApprovalRequired $True -State "Published"此命令會建立產品。 需要訂用帳戶和核准。
參數
-ApprovalRequired
指出產品的訂閱是否需要核准。 根據預設，此參數是 $False。
| 類型: | Nullable<T>[Boolean] |
| 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 |
-Description
指定產品描述。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-LegalTerms
指定產品的法律使用規定。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-ProductId
指定新產品的識別碼。 如果您未指定此參數，就會產生新產品。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-State
指定產品狀態。 psdx_paramvalues
- NotPublished
- 已發佈 預設值為 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
指定產品標題。
| 類型: | String |
| Position: | Named |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
輸入
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]]