Set-AzureEnvironment
Azure 環境のプロパティを変更します。
Note
このドキュメントで参照されているコマンドレットは、Service Management API を使用するレガシ Azure リソースを管理するためのものです。 Azure Resource Manager リソースを管理するためのコマンドレットについては、Az PowerShell モジュールを参照してください。
構文
Set-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>]
説明
Set-AzureEnvironment コマンドレットは、Azure 環境のプロパティを変更します。 新しいプロパティ値を持つ環境を表すオブジェクトを返します。 Name パラメーターを使用して、環境を識別し、他のパラメーターを使用してプロパティ値を変更します。 Set-AzureEnvironment を使用して Azure 環境の名前を変更することはできません。
Azure 環境は、グローバル Azure 用の AzureCloud や、中国の 21Vianet によって運用される AzureChinaCloud for Azure など、Microsoft Azure の独立したデプロイです。 また、Azure Pack と WAPack コマンドレットを使用して、オンプレミスの Azure 環境を作成することもできます。 詳細については、「Azure Pack」を参照してください。
注: AzureCloud または AzureChinaCloud 環境のプロパティは変更しないでください。 このコマンドレットを使用して、作成するプライベート環境の値を変更します。
例
例 1: 環境のプロパティを変更する
PS C:\> Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com"
このコマンドは、ContosoEnv 環境の Publish設定FileUrl プロパティと StorageEndpoint プロパティの値を変更します。
パラメーター
-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 のヘルプ トピックを参照してください。
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
変更される環境を識別します。 このパラメーターは必須です。 パラメーター値では大文字と小文字が区別されます。 ワイルドカード文字は使用できません。
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