New-AzureRmApiManagementSubscription
サブスクリプションを作成します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
New-AzureRmApiManagementSubscription
-Context <PsApiManagementContext>
[-SubscriptionId <String>]
-Name <String>
-UserId <String>
-ProductId <String>
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-State <PsApiManagementSubscriptionState>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] 説明
New-AzureRmApiManagementSubscription コマンドレットによってサブスクリプションが作成されます。
例
例 1: ユーザーを製品にサブスクライブする
PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>New-AzureRmApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999"このコマンドは、既存のユーザーを製品にサブスクライブします。
パラメーター
-Context
PsApiManagementContext オブジェクトを指定します。
| 型: | PsApiManagementContext |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Name
サブスクリプション名を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PrimaryKey
サブスクリプションの主キーを指定します。 このパラメーターが指定されていない場合、キーは自動的に生成されます。 このパラメーターの長さは 1 ~ 300 文字にする必要があります。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ProductId
サブスクライブする製品の ID を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SecondaryKey
サブスクリプションのセカンダリ キーを指定します。 このパラメーターは、指定されていない場合に自動的に生成されます。 このパラメーターの長さは 1 ~ 300 文字にする必要があります。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-State
サブスクリプションの状態を指定します。 既定値は $Null です。
| 型: | Nullable<T>[PsApiManagementSubscriptionState] |
| 指定可能な値: | Suspended, Active, Expired, Submitted, Rejected, Cancelled |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SubscriptionId
サブスクリプション ID を指定します。 このパラメーターは、指定されていない場合に生成されます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-UserId
サブスクライバー ID を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
入力
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]]