Get-AzurePublishSettingsFile

  • リファレンス
モジュール:
Azure

Azure サブスクリプションの発行設定ファイルをダウンロードします。

Note

このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。

Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される PowerShell モジュールです。

構文

Get-AzurePublishSettingsFile
   [-Environment <String>]
   [-Realm <String>]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

説明

Get-AzurePublishSettingsFile コマンドレットは、アカウント内のサブスクリプションの発行設定ファイルをダウンロードします。 コマンドが完了したら、Import-PublishSettingsFile コマンドレットを使用して、ファイル内の設定を Windows PowerShell で使用できるようにします。

Windows PowerShell で Azure アカウントを使用できるようにするには、発行設定ファイルまたは Add-AzureAccount コマンドレットを使用します。 設定ファイルを発行すると、スクリプトとバックグラウンド ジョブを無人で実行できるように、セッションを事前に準備できます。 ただし、すべてのサービスが設定ファイルの発行をサポートしているわけではありません。 たとえば、 AzureResourceManager モジュールでは、設定ファイルの発行はサポートされていません。

Get-AzurePublishSettingsFile を実行すると、既定のブラウザーが開き、Azure アカウントへのサインイン、サブスクリプションの選択、発行設定ファイルのファイル システムの場所の選択を求められます。 次に、サブスクリプションの発行設定ファイルを選択したファイルにダウンロードします。

"発行設定ファイル" は、.publishsettings ファイル名拡張子を持つ XML ファイルです。 このファイルには、Azure サブスクリプションの管理資格情報を提供するエンコードされた証明書が含まれています。

セキュリティに関する注意: 発行設定ファイルには、Azure サブスクリプションとサービスの管理に使用される資格情報が含まれています。 悪意のあるユーザーが発行設定ファイルにアクセスすると、Azure サービスを編集、作成、削除できます。 セキュリティのベスト プラクティスとして、ファイルをダウンロードフォルダーまたはドキュメント フォルダー内の場所に保存し、Import-AzurePublishSettingsFile コマンドレットを使用して設定をインポートした後で削除します。

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

例

例 1: 発行設定ファイルをダウンロードする

PS C:\> Get-AzurePublishSettingsFile

このコマンドを実行すると、既定のブラウザーが開き、Windows Azure アカウントに接続し、アカウントの .publishsettings ファイルがダウンロードされます。

例 2: 領域を指定する

PS C:\> Get-AzurePublishSettingsFile -Realm contoso.com -Passthru

このコマンドは、contoso.com ドメイン内のアカウントの発行設定ファイルをダウンロードします。 Microsoft アカウントではなく、組織アカウントを 使用して Azure にサインインするときに、Realm パラメーターを指定してコマンドを使用します。

パラメーター

-Environment

Azure 環境を指定します。

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-PassThru

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Profile

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

型:AzureSMProfile
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Realm

組織 ID で組織を指定します。 たとえば、Azure admin@contoso.comにサインインする場合、Realm パラメーターの値は contoso.com。 組織 ID を使用して Azure portal にサインインする場合は、このパラメーターを使用します。 outlook.com や live.com アカウントなど、Microsoft アカウントを使用する場合、このパラメーターは必要ありません。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

入力

None

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

出力

None or System.Boolean

PassThru パラメーターを使用すると、このコマンドレットはブール値を返します。 それ以外の場合、このコマンドレットは出力を返しません