Set-AzApiManagementSubscription
既存のサブスクリプションの詳細を設定します。
構文
Set-AzApiManagementSubscription
-InputObject <PsApiManagementSubscription>
[-Scope <String>]
[-UserId <String>]
[-Name <String>]
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-State <PsApiManagementSubscriptionState>]
[-ExpiresOn <DateTime>]
[-StateComment <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzApiManagementSubscription
-Context <PsApiManagementContext>
-SubscriptionId <String>
[-Scope <String>]
[-UserId <String>]
[-Name <String>]
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-State <PsApiManagementSubscriptionState>]
[-ExpiresOn <DateTime>]
[-StateComment <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Set-AzApiManagementSubscription コマンドレットは、既存のサブスクリプションの詳細を設定します。
例
例 1: サブスクリプションの状態キーとプライマリ キーとセカンダリ キーを設定する
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active"このコマンドは、サブスクリプションのプライマリ キーとセカンダリ キーを設定し、アクティブ化します。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Context
PsApiManagementContext オブジェクトを指定します。
| 型: | PsApiManagementContext |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ExpiresOn
サブスクリプションの有効期限を指定します。 このパラメーターの既定値は $Null です。
| 型: | Nullable<T>[DateTime] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-InputObject
PsApiManagementSubscription のインスタンス。 このパラメーターは必須です。
| 型: | PsApiManagementSubscription |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
サブスクリプション名を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PassThru
passthru
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PrimaryKey
サブスクリプションの主キーを指定します。 このパラメーターは、指定されていない場合は自動的に生成されます。 このパラメーターの長さは 1 ~ 300 文字にする必要があります。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Scope
サブスクリプションのスコープ (Api Scope /apis/{apiId} または Product Scope /products/{productId} または Global API Scope /apis または Global scope /)。 このパラメーターは必須です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | 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 |
-StateComment
サブスクリプションの状態コメントを指定します。 このパラメーターの既定値は $Null です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SubscriptionId
サブスクリプション ID を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-UserId
サブスクリプションの所有者 このパラメーターは省略可能です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]