Share via


Set-AzureSubscription

Azure サブスクリプションを変更します。

注意

このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az PowerShell モジュールを参照してください。

構文

Set-AzureSubscription
   -SubscriptionId <String>
   [-Certificate <X509Certificate2>]
   [-ServiceEndpoint <String>]
   [-ResourceManagerEndpoint <String>]
   [-CurrentStorageAccountName <String>]
   [-Context <AzureStorageContext>]
   [-Environment <String>]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Set-AzureSubscription
   -SubscriptionName <String>
   [-Certificate <X509Certificate2>]
   [-ServiceEndpoint <String>]
   [-ResourceManagerEndpoint <String>]
   [-CurrentStorageAccountName <String>]
   [-Context <AzureStorageContext>]
   [-Environment <String>]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Set-AzureSubscription
   -SubscriptionName <String>
   -SubscriptionId <String>
   -Certificate <X509Certificate2>
   [-ServiceEndpoint <String>]
   [-ResourceManagerEndpoint <String>]
   [-CurrentStorageAccountName <String>]
   [-Context <AzureStorageContext>]
   [-Environment <String>]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

説明

Set-AzureSubscription コマンドレットは、Azure サブスクリプション オブジェクトのプロパティを確立および変更します。 このコマンドレットを使用して、既定のサブスクリプションではない Azure サブスクリプションで作業したり、現在のストレージ アカウントを変更したりできます。 現在のサブスクリプションと既定のサブスクリプションの詳細については、Select-AzureSubscription コマンドレットを参照してください。

このコマンドレットは、実際の Azure サブスクリプションではなく、Azure サブスクリプション オブジェクトで動作します。 Azure サブスクリプションを作成してプロビジョニングするには、Azure Portal (https://azure.microsoft.com/) にアクセスします。

このコマンドレットは、Add-AzureAccount または Import-AzurePublishSettingsFile コマンドレットを使用して Windows PowerShell に Azure アカウントを追加するときに作成するサブスクリプション データ ファイル内のデータを変更します。

このトピックでは、Microsoft Azure PowerShell モジュールの 0.8.10 バージョンのコマンドレットについて説明します。 使用しているモジュールのバージョンを取得するには、Azure PowerShell コンソールで「.」と入力します (Get-Module -Name Azure).Version

例 1: 既存のサブスクリプションを変更する1

C:\PS> $thumbprint = <Thumbprint-2>
C:\PS> $differentCert = Get-Item cert:\\CurrentUser\My\$thumbprint
C:\PS> Set-AzureSubscription -SubscriptionName ContosoEngineering -Certificate $differentCert

次の使用例は、ContosoEngineering という名前のサブスクリプションの証明書を変更します。

例 2: サービス エンドポイントを変更する

C:\PS> Set-AzureSubscription -SubscriptionName ContosoEngineering -ServiceEndpoint "https://management.core.contoso.com"

このコマンドは、ContosoEngineering サブスクリプションのカスタム サービス エンドポイントを追加または変更します。

例 3: プロパティ値をクリアする

C:\PS> Set-AzureSubscription -SubscriptionName ContosoEngineering -Certificate $null -ResourceManagerEndpoint $Null

このコマンドは、Certificate プロパティと ResourceManagerEndpoint プロパティの値を null ($Null) に設定します。 これにより、他の設定を変更することなく、これらのプロパティの値がクリアされます。

例 4: 代替サブスクリプション データ ファイルを使用する

C:\PS> Set-AzureSubscription -SubscriptionName ContosoFinance -SubscriptionDataFile C:\Azure\SubscriptionData.xml -CurrentStorageAccount ContosoStorage01

このコマンドは、ContosoFinance サブスクリプションの現在のストレージ アカウントを ContosoStorage01 に変更します。 このコマンドでは、SubscriptionDataFile パラメーターを使用して、C:\Azure\SubscriptionData.xml サブスクリプション データ ファイル内のデータを変更します。 既定では、 Set-AzureSubscription はローミング ユーザー プロファイルの既定のサブスクリプション データ ファイルを使用します。

パラメーター

-Certificate

Type:X509Certificate2
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Context

Type:AzureStorageContext
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-CurrentStorageAccountName

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Environment

Azure 環境を指定します。

Azure 環境は、グローバル Azure 用の AzureCloud や、中国の 21Vianet によって運用される AzureChinaCloud for Azure など、Microsoft Azure の独立したデプロイです。 また、Azure Pack と WAPack コマンドレットを使用して、オンプレミスの Azure 環境を作成することもできます。 詳細については、「Azure Pack」を参照してください

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

コマンドが成功した場合は$Trueを返し、失敗した場合は$Falseを返します。 既定では、このコマンドレットは出力を返しません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Profile

このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceManagerEndpoint

アカウントに関連付けられているリソース グループに関するデータを含む、Azure Resource Manager データのエンドポイントを指定します。 Azure Resource Manager の詳細については、Azure Resource Manager コマンドレット () と Resource Manager での Windows PowerShell の使用 (https://go.microsoft.com/fwlink/?LinkID=394765https://go.microsoft.com/fwlink/?LinkID=394767) に関するページを参照してください。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ServiceEndpoint

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionId

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionName

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

入力

None

このコマンドレットへの入力はプロパティ名でパイプできますが、値によるパイプ処理は行いません。

出力

None or System.Boolean

PassThru パラメーターを使用すると、このコマンドレットはブール値を返します。 既定では、このコマンドレットは出力を返しません。