Set-AzureRmApiManagementProduct
API Management 製品の詳細を設定します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Set-AzureRmApiManagementProduct
-Context <PsApiManagementContext>
-ProductId <String>
[-Title <String>]
[-Description <String>]
[-LegalTerms <String>]
[-SubscriptionRequired <Boolean>]
[-ApprovalRequired <Boolean>]
[-SubscriptionsLimit <Int32>]
[-State <PsApiManagementProductState>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
Set-AzureRmApiManagementProduct コマンドレットは、API Management 製品の詳細を設定します。
例
例 1: 製品の詳細を更新する
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Set-AzureRmApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $True -State "NotPublished"このコマンドは、API Management 製品の詳細を更新し、サブスクリプションを必要とし、発行を取り消します。
パラメーター
-ApprovalRequired
製品のサブスクリプションに承認が必要かどうかを示します。 既定値は $False です。
| 型: | Nullable<T>[Boolean] |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Context
PsApiManagementContext オブジェクトのインスタンスを指定します。
| 型: | PsApiManagementContext |
| Position: | Named |
| 既定値: | None |
| 必須: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | 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
- Published
| 型: | 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
同時サブスクリプションの最大数を指定します。 このパラメーターの既定値は 1 です。
| 型: | Nullable<T>[Int32] |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Title
このコマンドレットが設定する製品タイトルを指定します。
| 型: | String |
| Position: | Named |
| 既定値: | None |
| 必須: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
Nullable<T>[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]]