次の方法で共有


Set-AzureRmApiManagementSubscription

既存のサブスクリプションの詳細を設定します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Set-AzureRmApiManagementSubscription
   -Context <PsApiManagementContext>
   -SubscriptionId <String>
   [-Name <String>]
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-State <PsApiManagementSubscriptionState>]
   [-ExpiresOn <DateTime>]
   [-StateComment <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

Set-AzureRmApiManagementSubscription コマンドレットは、既存のサブスクリプションの詳細を設定します。

例 1: サブスクリプションの状態キーとプライマリ キーとセカンダリ キーを設定する

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Set-AzureRmApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active"

このコマンドは、サブスクリプションのプライマリ キーとセカンダリ キーを設定し、アクティブ化します。

パラメーター

-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

-ExpiresOn

サブスクリプションの有効期限を指定します。 このパラメーターの既定値は $Null です。

型:Nullable<T>[DateTime]
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

サブスクリプション名を指定します。

型: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

-PrimaryKey

サブスクリプションの主キーを指定します。 このパラメーターは、指定されていない場合は自動的に生成されます。 このパラメーターの長さは 1 ~ 300 文字にする必要があります。

型:String
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

-SecondaryKey

サブスクリプションのセカンダリ キーを指定します。 このパラメーターは、指定されていない場合は自動的に生成されます。 このパラメーターの長さは 1 ~ 300 文字にする必要があります。

型:String
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

-State

サブスクリプションの状態を指定します。 このパラメーターの既定値は $Null です。

型:Nullable<T>[PsApiManagementSubscriptionState]
承認された値:Suspended, Active, Expired, Submitted, Rejected, Cancelled
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

-StateComment

サブスクリプションの状態コメントを指定します。 このパラメーターの既定値は $Null です。

型:String
Position:Named
既定値:None
必須:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

サブスクリプション ID を指定します。

型:String
Position:Named
既定値:None
必須:True
Accept pipeline input:True
Accept wildcard characters:False

入力

PsApiManagementContext

String

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.Commands.ApiManagement.ServiceManagement, Version=6.1.0.0, Culture=neutral, PublicKeyToken=null]]

Nullable<T>[[System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

SwitchParameter

出力

PsApiManagementSubscription