次の方法で共有


Set-AzEnvironment

Azure 環境のプロパティを設定します。

構文

Name (既定)

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>]
    [[-AdTenant] <String>]
    [[-GraphAudience] <String>]
    [[-DataLakeAudience] <String>]
    [[-BatchEndpointResourceId] <String>]
    [[-AzureOperationalInsightsEndpointResourceId] <String>]
    [[-AzureOperationalInsightsEndpoint] <String>]
    [-EnableAdfsAuthentication]
    [-AzureAnalysisServicesEndpointSuffix <String>]
    [-AzureAnalysisServicesEndpointResourceId <String>]
    [-AzureAttestationServiceEndpointSuffix <String>]
    [-AzureAttestationServiceEndpointResourceId <String>]
    [-AzureSynapseAnalyticsEndpointSuffix <String>]
    [-ContainerRegistryEndpointSuffix <String>]
    [-AzureSynapseAnalyticsEndpointResourceId <String>]
    [-MicrosoftGraphEndpointResourceId <String>]
    [-MicrosoftGraphUrl <String>]
    [-SshAuthScope <String>]
    [-Scope <ContextModificationScope>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ARMEndpoint

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
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:AdEndpointUrl, アクティブディレクトリ, ActiveDirectoryAuthority

パラメーター セット

Name
配置:5
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ActiveDirectoryServiceEndpointResourceId

Azure Resource Manager またはサービス管理 (RDFE) エンドポイントへの要求を認証するトークンの対象ユーザーを指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:8
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AdTenant

既定の Active Directory テナントを指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:17
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ARMEndpoint

Azure Resource Manager エンドポイント。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ArmUrl

パラメーター セット

ARMEndpoint
配置:1
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureAnalysisServicesEndpointResourceId

Azure Analysis Services リソースのリソース識別子。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AzureAnalysisServicesEndpointSuffix

Azure Log Analytics API と通信するときに使用するエンドポイント。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AzureAttestationServiceEndpointResourceId

要求されたトークンの受信者である Azure 構成証明サービスのリソース識別子。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureAttestationServiceEndpointSuffix

Azure Attestation サービスの DNS サフィックス。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Azure Data Lake Analytics ジョブおよびカタログ サービスの DNS サフィックス

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:15
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureDataLakeStoreFileSystemEndpointSuffix

Azure Data Lake Store FileSystem の DNS サフィックス。 例: azuredatalake.net

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:14
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureKeyVaultDnsSuffix

Azure Key Vault サービスの DNS サフィックス。 例: vault-int.azure-int.net

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:10
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureKeyVaultServiceEndpointResourceId

要求されたトークンの受信者である Azure Key Vault データ サービスのリソース識別子。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:11
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureOperationalInsightsEndpoint

Azure Log Analytics API と通信するときに使用するエンドポイント。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:22
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureOperationalInsightsEndpointResourceId

Azure Log Analytics API を使用して認証するトークンの対象ユーザー。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:21
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureSynapseAnalyticsEndpointResourceId

要求されたトークンの受信者である Azure Synapse Analytics のリソース識別子。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-AzureSynapseAnalyticsEndpointSuffix

Azure Synapse Analytics の DNS サフィックス。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-BatchEndpointResourceId

要求されたトークンの受信者である Azure Batch サービスのリソース識別子

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:BatchResourceId, BatchAudience

パラメーター セット

(All)
配置:20
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False
Aliases:cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ContainerRegistryEndpointSuffix

Azure Container Registry のサフィックス。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-DataLakeAudience

AD Data Lake サービス エンドポイントを使用して認証するトークンの対象ユーザー。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:DataLakeEndpointResourceId, DataLakeResourceId

パラメーター セット

(All)
配置:19
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

パラメーターのプロパティ

型:IAzureContextContainer
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-EnableAdfsAuthentication

Active Directory フェデレーション サービス (ADFS) のオンプレミス認証が許可されていることを示します。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:OnPremise

パラメーター セット

Name
配置:16
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-GalleryEndpoint

デプロイ テンプレートの Azure Resource Manager ギャラリーのエンドポイントを指定します。 パラメーターは、値を GalleryUrlPSAzureEnvironmentに設定することです。 GalleryUrlが ArmMetadata から削除されるため、Azure PowerShell では値が提供されなくなり、GalleryEndpoint設定することは推奨されなくなりました。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ギャラリー, ギャラリーURL

パラメーター セット

Name
配置:7
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-GraphAudience

AD Graph エンドポイントを使用して認証するトークンの対象ユーザー。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:GraphEndpointResourceId, GraphResourceId

パラメーター セット

Name
配置:18
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-GraphEndpoint

Graph (Active Directory メタデータ) 要求の URL を指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:Graph, GraphUrl

パラメーター セット

Name
配置:9
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ManagementPortalUrl

管理ポータルの URL を指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:3
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-MicrosoftGraphEndpointResourceId

Microsoft Graph のリソース識別子

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-MicrosoftGraphUrl

Microsoft Graph Url

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Name

変更する環境の名前を指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-PublishSettingsFileUrl

.publishsettings ファイルのダウンロード元の URL を指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:1
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ResourceManagerEndpoint

Azure Resource Manager 要求の URL を指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ResourceManager, ResourceManagerUrl

パラメーター セット

Name
配置:6
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Scope

コンテキスト変更のスコープを決定します。たとえば、変更が現在のプロセスにのみ適用されるか、このユーザーによって開始されたすべてのセッションに適用されるかなどです。

パラメーターのプロパティ

型:ContextModificationScope
規定値:None
指定可能な値:Process, CurrentUser
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ServiceEndpoint

サービス管理 (RDFE) 要求のエンドポイントを指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ServiceManagement, ServiceManagementUrl

パラメーター セット

Name
配置:2
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-SqlDatabaseDnsSuffix

Azure SQL Database サーバーのドメイン名サフィックスを指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:13
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-SshAuthScope

Azure VM に SSH 接続するときの認証のスコープ。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-StorageEndpoint

ストレージ (BLOB、テーブル、キュー、ファイル) アクセスのエンドポイントを指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ストレージエンドポイントサフィックス

パラメーター セット

(All)
配置:4
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-TrafficManagerDnsSuffix

Azure Traffic Manager サービスのドメイン名サフィックスを指定します。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Name
配置:12
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False
Aliases:ウィスコンシン

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

String

SwitchParameter

出力

PSAzureEnvironment