New-AzApiManagementProduct
API Management 製品を作成します。
構文
New-AzApiManagementProduct
-Context <PsApiManagementContext>
[-ProductId <String>]
-Title <String>
[-Description <String>]
[-LegalTerms <String>]
[-SubscriptionRequired <Boolean>]
[-ApprovalRequired <Boolean>]
[-SubscriptionsLimit <Int32>]
[-State <PsApiManagementProductState>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
New-AzApiManagementProduct コマンドレットは、API Management 製品を作成します。
例
例 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 Management 製品が作成されます。 サブスクリプションは必要ありません。
例 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です。
Type: | Nullable<T>[Boolean] |
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 |
-Description
製品の説明を指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LegalTerms
製品の法的使用条件を指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProductId
新しい製品の識別子を指定します。 このパラメーターを指定しない場合は、新しい製品が生成されます。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-State
製品の状態を指定します。 psdx_paramvalues
- NotPublished
- Published 既定値は NotPublished です。
Type: | Nullable<T>[PsApiManagementProductState] |
Accepted values: | NotPublished, Published |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionRequired
製品にサブスクリプションが必要かどうかを示します。 既定値は $True です。
Type: | Nullable<T>[Boolean] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionsLimit
同時サブスクリプションの最大数を指定します。 既定値は None です。
Type: | Nullable<T>[Int32] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Title
製品のタイトルを指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | 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]]
出力
関連リンク
Azure PowerShell
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示