Add-AzureEnvironment
Azure 環境を作成します。
Note
このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az PowerShell モジュールを参照してください。
構文
Add-AzureEnvironment
-Name <String>
[-PublishSettingsFileUrl <String>]
[-ServiceEndpoint <String>]
[-ManagementPortalUrl <String>]
[-StorageEndpoint <String>]
[-ActiveDirectoryEndpoint <String>]
[-ResourceManagerEndpoint <String>]
[-GalleryEndpoint <String>]
[-ActiveDirectoryServiceEndpointResourceId <String>]
[-GraphEndpoint <String>]
[-AzureKeyVaultDnsSuffix <String>]
[-AzureKeyVaultServiceEndpointResourceId <String>]
[-TrafficManagerDnsSuffix <String>]
[-SqlDatabaseDnsSuffix <String>]
[-EnableAdfsAuthentication]
[-AdTenant <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>] 説明
Add-AzureEnvironment コマンドレットは、新しいカスタム Azure アカウント環境を作成し、ローミング ユーザー プロファイルに保存します。 コマンドレットは、新しい環境を表すオブジェクトを返します。 コマンドが完了したら、Windows PowerShell で環境を使用できます。
Azure 環境は、グローバル Azure 用の AzureCloud や、中国の 21Vianet によって運用される AzureChinaCloud for Azure など、Microsoft Azure の独立したデプロイです。 また、Azure Pack と WAPack コマンドレットを使用して、オンプレミスの Azure 環境を作成することもできます。 詳細については、「Azure Pack」を参照してください。
このコマンドレットの Name パラメーターのみが必須です。 パラメーターを省略すると、その値は null ($Null) になり、そのエンドポイントを使用するサービスが正しく機能しない可能性があります。 環境プロパティの値を追加または変更するには、Set-AzureEnvironment コマンドレットを使用します。
注: 環境を変更すると、アカウントが失敗する可能性があります。 通常、環境はテストまたはトラブルシューティングのためにのみ追加されます。
このトピックでは、Microsoft Azure PowerShell モジュールの 0.8.10 バージョンのコマンドレットについて説明します。
使用しているモジュールのバージョンを取得するには、Azure PowerShell コンソールで「.」と入力します (Get-Module -Name Azure).Version。
例
例 1: Azure 環境を追加する
PS C:\> Add-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl https://contoso.com/fwlink/?LinkID=101 -ServiceEndpoint https://contoso.com/fwlink/?LinkID=102
Name : ContosoEnv
PublishSettingsFileUrl : https://contoso.com/fwlink/?LinkID=101
ServiceEndpoint : https://contoso.com/fwlink/?LinkID=102
ResourceManagerEndpoint :
ManagementPortalUrl :
ActiveDirectoryEndpoint :
ActiveDirectoryCommonTenantId :
StorageEndpointSuffix :
StorageBlobEndpointFormat :
StorageQueueEndpointFormat :
StorageTableEndpointFormat :
GalleryEndpoint :このコマンドにより、ContosoEnv Azure 環境が作成されます。
パラメーター
-ActiveDirectoryEndpoint
新しい環境での Microsoft Entra 認証のエンドポイントを指定します。
| Type: | String |
| Aliases: | AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ActiveDirectoryServiceEndpointResourceId
アクセスが Microsoft Entra ID によって管理される管理 API のリソース ID を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AdTenant
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AzureKeyVaultDnsSuffix
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AzureKeyVaultServiceEndpointResourceId
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-EnableAdfsAuthentication
| Type: | SwitchParameter |
| Aliases: | OnPremise |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-GalleryEndpoint
リソース グループ ギャラリー テンプレートを格納する Azure Resource Manager ギャラリーのエンドポイントを指定します。 Azure リソース グループとギャラリー テンプレートの詳細については、Get-AzureResourceGroupGalleryTemplate のヘルプ トピックを参照してください。https://go.microsoft.com/fwlink/?LinkID=393052.
| Type: | String |
| Aliases: | Gallery, GalleryUrl |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-GraphEndpoint
| Type: | String |
| Aliases: | Graph, GraphUrl |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ManagementPortalUrl
新しい環境の Azure 管理ポータルの URL を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
環境の名前を指定します。 このパラメーターは必須です。 既定の環境である AzureCloud と AzureChinaCloud の名前は使用しないでください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Profile
このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。
| Type: | AzureSMProfile |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublishSettingsFileUrl
アカウントの発行設定ファイルの URL を指定します。 Azure 発行設定ファイルは、アカウントに関する情報と、Windows PowerShell がユーザーの代わりに Azure アカウントにサインインできるようにする管理証明書を含む XML ファイルです。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| 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 |
| Aliases: | ResourceManager, ResourceManagerUrl |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServiceEndpoint
Azure サービス エンドポイントの URL を指定します。 Azure サービス エンドポイントは、アプリケーションがグローバル Azure プラットフォーム、中国の 21Vianet によって運用される Azure、またはプライベート Azure インストールのいずれによって管理されているかを決定します。
| Type: | String |
| Aliases: | ServiceManagement, ServiceManagementUrl |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SqlDatabaseDnsSuffix
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StorageEndpoint
新しい環境でのストレージ サービスの既定のエンドポイントを指定します。
| Type: | String |
| Aliases: | StorageEndpointSuffix |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TrafficManagerDnsSuffix
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
入力
None
このコマンドレットへの入力はプロパティ名でパイプできますが、値によるパイプ処理は行いません。
出力
Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment