Set-AzureEnvironment
Azure 環境のプロパティを変更します。
Note
このドキュメントで参照されているコマンドレットは、Azure Service Manager (ASM) API を使用する従来の Azure リソースを管理するためのものです。 ASM の提供終了が予定されているため、新しいリソースを作成する場合、このレガシ PowerShell モジュールは推奨されません。 詳細については、Azure Service Manager の提供終了に関するページを参照してください。
Az PowerShell モジュールは、PowerShell を使用して Azure Resource Manager (ARM) リソースを管理するために推奨される 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 環境の PublishSettingsFileUrl プロパティと StorageEndpoint プロパティの値を変更します。
パラメーター
-ActiveDirectoryEndpoint
Microsoft Entra 認証のエンドポイントを指定した値に変更します。
| 型: | String |
| Aliases: | AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ActiveDirectoryServiceEndpointResourceId
アクセスが Microsoft Entra ID によって管理される管理 API のリソース ID を指定します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AdTenant
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureKeyVaultDnsSuffix
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureKeyVaultServiceEndpointResourceId
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-EnableAdfsAuthentication
| 型: | SwitchParameter |
| Aliases: | OnPremise |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-GalleryEndpoint
Azure Resource Manager ギャラリーのエンドポイントを指定した値に変更します。 ギャラリー エンドポイントは、リソース グループ ギャラリー テンプレートの場所です。 Azure リソース グループとギャラリー テンプレートの詳細については、Get-AzureResourceGroupGalleryTemplate のヘルプ トピックを参照してください。
| 型: | String |
| Aliases: | Gallery, GalleryUrl |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-GraphEndpoint
| 型: | String |
| Aliases: | Graph, GraphUrl |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ManagementPortalUrl
Azure 管理ポータルの URL を指定した値に変更します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
変更される環境を識別します。 このパラメーターは必須です。 パラメーター値では大文字と小文字が区別されます。 ワイルドカード文字は使用できません。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Profile
このコマンドレットが読み取る Azure プロファイルを指定します。 プロファイルを指定しない場合、このコマンドレットはローカルの既定のプロファイルから読み取ります。
| 型: | AzureSMProfile |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PublishSettingsFileUrl
指定した環境の発行設定ファイルの URL を変更します。 Azure 発行設定ファイルは、アカウントに関する情報と、Windows PowerShell がユーザーの代わりに Azure アカウントにサインインできるようにする管理証明書を含む XML ファイルです。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | 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) に関するページを参照してください。
| 型: | String |
| Aliases: | ResourceManager, ResourceManagerUrl |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ServiceEndpoint
指定した環境の Azure サービス エンドポイントの URL を変更します。 Azure サービス エンドポイントは、アプリケーションがグローバル Azure プラットフォーム、中国の 21Vianet によって運用される Azure、またはプライベート Azure インストールのいずれによって管理されているかを決定します。
| 型: | String |
| Aliases: | ServiceManagement, ServiceManagementUrl |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SqlDatabaseDnsSuffix
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-StorageEndpoint
指定した環境のストレージ サービスの既定のエンドポイントを変更します。
| 型: | String |
| Aliases: | StorageEndpointSuffix |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TrafficManagerDnsSuffix
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
入力
None
このコマンドレットへの入力はプロパティ名でパイプできますが、値によるパイプ処理は行いません。
出力
Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment