Set-AzEnvironment
Azure 環境のプロパティを設定します。
構文
Set-AzEnvironment
[-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>]
[[-AzureDataLakeStoreFileSystemEndpointSuffix] <String>]
[[-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix] <String>]
[-EnableAdfsAuthentication]
[[-AdTenant] <String>]
[[-GraphAudience] <String>]
[[-DataLakeAudience] <String>]
[[-BatchEndpointResourceId] <String>]
[[-AzureOperationalInsightsEndpointResourceId] <String>]
[[-AzureOperationalInsightsEndpoint] <String>]
[-AzureAnalysisServicesEndpointSuffix <String>]
[-AzureAnalysisServicesEndpointResourceId <String>]
[-AzureAttestationServiceEndpointSuffix <String>]
[-AzureAttestationServiceEndpointResourceId <String>]
[-AzureSynapseAnalyticsEndpointSuffix <String>]
[-ContainerRegistryEndpointSuffix <String>]
[-AzureSynapseAnalyticsEndpointResourceId <String>]
[-MicrosoftGraphEndpointResourceId <String>]
[-MicrosoftGraphUrl <String>]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzEnvironment
[-Name] <String>
[[-StorageEndpoint] <String>]
[-ARMEndpoint] <String>
[[-AzureKeyVaultDnsSuffix] <String>]
[[-AzureKeyVaultServiceEndpointResourceId] <String>]
[[-DataLakeAudience] <String>]
[[-BatchEndpointResourceId] <String>]
[[-AzureOperationalInsightsEndpointResourceId] <String>]
[[-AzureOperationalInsightsEndpoint] <String>]
[-AzureAnalysisServicesEndpointSuffix <String>]
[-AzureAnalysisServicesEndpointResourceId <String>]
[-AzureAttestationServiceEndpointSuffix <String>]
[-AzureAttestationServiceEndpointResourceId <String>]
[-AzureSynapseAnalyticsEndpointSuffix <String>]
[-ContainerRegistryEndpointSuffix <String>]
[-AzureSynapseAnalyticsEndpointResourceId <String>]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 説明
Set-AzEnvironment コマンドレットは、Azure のインスタンスに接続するためのエンドポイントとメタデータを設定します。
例
例 1: 新しい環境の作成と変更
Add-AzEnvironment -Name TestEnvironment `
-ActiveDirectoryEndpoint TestADEndpoint `
-ActiveDirectoryServiceEndpointResourceId TestADApplicationId `
-ResourceManagerEndpoint TestRMEndpoint `
-GalleryEndpoint TestGalleryEndpoint `
-GraphEndpoint TestGraphEndpoint
Name Resource Manager Url ActiveDirectory Authority
---- -------------------- -------------------------
TestEnvironment TestRMEndpoint TestADEndpoint/
Set-AzEnvironment -Name TestEnvironment `
-ActiveDirectoryEndpoint NewTestADEndpoint `
-GraphEndpoint NewTestGraphEndpoint | Format-List
Name : TestEnvironment
EnableAdfsAuthentication : False
ActiveDirectoryServiceEndpointResourceId : TestADApplicationId
AdTenant :
GalleryUrl : TestGalleryEndpoint
ManagementPortalUrl :
ServiceManagementUrl :
PublishSettingsFileUrl :
ResourceManagerUrl : TestRMEndpoint
SqlDatabaseDnsSuffix :
StorageEndpointSuffix :
ActiveDirectoryAuthority : NewTestADEndpoint
GraphUrl : NewTestGraphEndpoint
GraphEndpointResourceId :
TrafficManagerDnsSuffix :
AzureKeyVaultDnsSuffix :
AzureDataLakeStoreFileSystemEndpointSuffix :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId :
BatchEndpointResourceId :
AzureOperationalInsightsEndpoint :
AzureOperationalInsightsEndpointResourceId :
AzureAttestationServiceEndpointSuffix :
AzureAttestationServiceEndpointResourceId :
AzureSynapseAnalyticsEndpointSuffix :
AzureSynapseAnalyticsEndpointResourceId :この例では、Add-AzEnvironment を使用してサンプル エンドポイントを使用して新しい Azure 環境を作成し、コマンドレット Set-AzEnvironment を使用して、作成された環境の ActiveDirectoryEndpoint 属性と GraphEndpoint 属性の値を変更します。
パラメーター
-ActiveDirectoryEndpoint
Azure Active Directory 認証の基本機関を指定します。
| 型: | String |
| Aliases: | AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority |
| 配置: | 5 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ActiveDirectoryServiceEndpointResourceId
Azure Resource Manager またはサービス管理 (RDFE) エンドポイントへの要求を認証するトークンの対象ユーザーを指定します。
| 型: | String |
| 配置: | 8 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AdTenant
既定の Active Directory テナントを指定します。
| 型: | String |
| 配置: | 17 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ARMEndpoint
Azure Resource Manager エンドポイント。
| 型: | String |
| Aliases: | ArmUrl |
| 配置: | 1 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureAnalysisServicesEndpointResourceId
Azure Analysis Services リソースのリソース識別子。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-AzureAnalysisServicesEndpointSuffix
Azure Log Analytics API と通信するときに使用するエンドポイント。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-AzureAttestationServiceEndpointResourceId
要求されたトークンの受信者である Azure 構成証明サービスのリソース識別子。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureAttestationServiceEndpointSuffix
Azure Attestation サービスの DNS サフィックス。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix
Azure Data Lake Analytics ジョブおよびカタログ サービスの DNS サフィックス
| 型: | String |
| 配置: | 15 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureDataLakeStoreFileSystemEndpointSuffix
Azure Data Lake Store FileSystem の DNS サフィックス。 例: azuredatalake.net
| 型: | String |
| 配置: | 14 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureKeyVaultDnsSuffix
Azure Key Vault サービスの DNS サフィックス。 例: vault-int.azure-int.net
| 型: | String |
| 配置: | 10 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureKeyVaultServiceEndpointResourceId
要求されたトークンの受信者である Azure Key Vault データ サービスのリソース識別子。
| 型: | String |
| 配置: | 11 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureOperationalInsightsEndpoint
Azure Log Analytics API と通信するときに使用するエンドポイント。
| 型: | String |
| 配置: | 22 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureOperationalInsightsEndpointResourceId
Azure Log Analytics API を使用して認証するトークンの対象ユーザー。
| 型: | String |
| 配置: | 21 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureSynapseAnalyticsEndpointResourceId
要求されたトークンの受信者である Azure Synapse Analytics のリソース識別子。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-AzureSynapseAnalyticsEndpointSuffix
Azure Synapse Analytics の DNS サフィックス。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-BatchEndpointResourceId
要求されたトークンの受信者である Azure Batch サービスのリソース識別子
| 型: | String |
| Aliases: | BatchResourceId, BatchAudience |
| 配置: | 20 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ContainerRegistryEndpointSuffix
Azure Container Registry のサフィックス。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DataLakeAudience
AD Data Lake サービス エンドポイントを使用して認証するトークンの対象ユーザー。
| 型: | String |
| Aliases: | DataLakeEndpointResourceId, DataLakeResourceId |
| 配置: | 19 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-EnableAdfsAuthentication
Active Directory フェデレーション サービス (AD FS) (ADFS) オンプレミス認証が許可されていることを示します。
| 型: | SwitchParameter |
| Aliases: | OnPremise |
| 配置: | 16 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-GalleryEndpoint
デプロイ テンプレートの Azure Resource Manager ギャラリーのエンドポイントを指定します。
パラメーターは、値を PSAzureEnvironment のGalleryUrlに設定することです。 GalleryUrlが ArmMetadata から削除されるため、Azure PowerShell では値が提供されなくなり、GalleryEndpoint設定することは推奨されなくなりました。
| 型: | String |
| Aliases: | Gallery, GalleryUrl |
| 配置: | 7 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-GraphAudience
AD Graph エンドポイントを使用して認証するトークンの対象ユーザー。
| 型: | String |
| Aliases: | GraphEndpointResourceId, GraphResourceId |
| 配置: | 18 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-GraphEndpoint
Graph (Active Directory メタデータ) 要求の URL を指定します。
| 型: | String |
| Aliases: | Graph, GraphUrl |
| 配置: | 9 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ManagementPortalUrl
管理ポータルの URL を指定します。
| 型: | String |
| 配置: | 3 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-MicrosoftGraphEndpointResourceId
Microsoft Graph のリソース識別子
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-MicrosoftGraphUrl
Microsoft Graph Url
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Name
変更する環境の名前を指定します。
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PublishSettingsFileUrl
.publishsettings ファイルのダウンロード元の URL を指定します。
| 型: | String |
| 配置: | 1 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ResourceManagerEndpoint
Azure Resource Manager 要求の URL を指定します。
| 型: | String |
| Aliases: | ResourceManager, ResourceManagerUrl |
| 配置: | 6 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Scope
コンテキスト変更のスコープを決定します。たとえば、変更が現在のプロセスにのみ適用されるか、このユーザーによって開始されたすべてのセッションに適用されるかなどです。
| 型: | ContextModificationScope |
| 指定可能な値: | Process, CurrentUser |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ServiceEndpoint
サービス管理 (RDFE) 要求のエンドポイントを指定します。
| 型: | String |
| Aliases: | ServiceManagement, ServiceManagementUrl |
| 配置: | 2 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-SqlDatabaseDnsSuffix
Azure SQL Database サーバーのドメイン名サフィックスを指定します。
| 型: | String |
| 配置: | 13 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-StorageEndpoint
ストレージ (BLOB、テーブル、キュー、ファイル) アクセスのエンドポイントを指定します。
| 型: | String |
| Aliases: | StorageEndpointSuffix |
| 配置: | 4 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-TrafficManagerDnsSuffix
Azure Traffic Manager サービスのドメイン名サフィックスを指定します。
| 型: | String |
| 配置: | 12 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
出力
関連リンク
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Azure PowerShell