Add-AzEnvironment

リファレンス

モジュール:: Az.Accounts

Azure Resource Manager のインスタンスのエンドポイントとメタデータを追加します。

構文

Add-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>]

Add-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>]

Add-AzEnvironment
   [-AutoDiscover]
   [-Uri <Uri>]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Add-AzEnvironment コマンドレットは、エンドポイントとメタデータを追加して、Azure Resource Manager コマンドレットが Azure Resource Manager の新しいインスタンスに接続できるようにします。組み込みの環境 AzureCloud と AzureChinaCloud は、Azure Resource Manager の既存のパブリックインスタンスを対象としています。

例

例 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
OnPremise                                         : False
ActiveDirectoryServiceEndpointResourceId          : TestADApplicationId
AdTenant                                          :
GalleryUrl                                        : TestGalleryEndpoint
ManagementPortalUrl                               :
ServiceManagementUrl                              :
PublishSettingsFileUrl                            :
ResourceManagerUrl                                : TestRMEndpoint
SqlDatabaseDnsSuffix                              :
StorageEndpointSuffix                             :
ActiveDirectoryAuthority                          : NewTestADEndpoint
GraphUrl                                          : NewTestGraphEndpoint
GraphEndpointResourceId                           :
TrafficManagerDnsSuffix                           :
AzureKeyVaultDnsSuffix                            :
DataLakeEndpointResourceId                        :
AzureDataLakeStoreFileSystemEndpointSuffix        :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId            :
AzureOperationalInsightsEndpointResourceId        :
AzureOperationalInsightsEndpoint                  :
AzureAnalysisServicesEndpointSuffix               :
AzureAttestationServiceEndpointSuffix             :
AzureAttestationServiceEndpointResourceId         :
AzureSynapseAnalyticsEndpointSuffix               :
AzureSynapseAnalyticsEndpointResourceId           :
VersionProfiles                                   : {}
ExtendedProperties                                : {}
BatchEndpointResourceId                           :

この例では、Add-AzEnvironment を使用してサンプルエンドポイントを使用して新しい Azure 環境を作成し、コマンドレット Set-AzEnvironment を使用して、作成された環境の ActiveDirectoryEndpoint 属性と GraphEndpoint 属性の値を変更します。

例 2: URI を使用した新しい環境の検出

<#
Uri https://configuredmetadata.net returns an array of environment metadata. The following example contains a payload for the AzureCloud default environment.

[
  {
    "portal": "https://portal.azure.com",
    "authentication": {
      "loginEndpoint": "https://login.microsoftonline.com/",
      "audiences": [
        "https://management.core.windows.net/"
      ],
      "tenant": "common",
      "identityProvider": "AAD"
    },
    "media": "https://rest.media.azure.net",
    "graphAudience": "https://graph.windows.net/",
    "graph": "https://graph.windows.net/",
    "name": "AzureCloud",
    "suffixes": {
      "azureDataLakeStoreFileSystem": "azuredatalakestore.net",
      "acrLoginServer": "azurecr.io",
      "sqlServerHostname": ".database.windows.net",
      "azureDataLakeAnalyticsCatalogAndJob": "azuredatalakeanalytics.net",
      "keyVaultDns": "vault.azure.net",
      "storage": "core.windows.net",
      "azureFrontDoorEndpointSuffix": "azurefd.net"
    },
    "batch": "https://batch.core.windows.net/",
    "resourceManager": "https://management.azure.com/",
    "vmImageAliasDoc": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/arm-compute/quickstart-templates/aliases.json",
    "activeDirectoryDataLake": "https://datalake.azure.net/",
    "sqlManagement": "https://management.core.windows.net:8443/",
    "gallery": "https://gallery.azure.com/"
  },
……
]
#>

Add-AzEnvironment -AutoDiscover -Uri https://configuredmetadata.net

Name            Resource Manager Url ActiveDirectory Authority
----            -------------------- -------------------------
TestEnvironment TestRMEndpoint       TestADEndpoint/

この例では、URI から新しい Azure 環境を https://configuredmetadata.net 検出しています。

パラメーター

-ActiveDirectoryEndpoint

Azure Active Directory 認証の基本機関を指定します。

Type:	String
Aliases:	AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Position:	5
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ActiveDirectoryServiceEndpointResourceId

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

Type:	String
Position:	8
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AdTenant

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

Type:	String
Position:	17
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ARMEndpoint

Azure Resource Manager エンドポイント

Type:	String
Aliases:	ArmUrl
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-AutoDiscover

既定または構成されたエンドポイントを使用して環境を検出します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-AzureAnalysisServicesEndpointResourceId

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AzureAnalysisServicesEndpointSuffix

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AzureAttestationServiceEndpointResourceId

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureAttestationServiceEndpointSuffix

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

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

Type:	String
Position:	15
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureDataLakeStoreFileSystemEndpointSuffix

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

Type:	String
Position:	14
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureKeyVaultDnsSuffix

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

Type:	String
Position:	10
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureKeyVaultServiceEndpointResourceId

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

Type:	String
Position:	11
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureOperationalInsightsEndpoint

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

Type:	String
Position:	22
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureOperationalInsightsEndpointResourceId

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

Type:	String
Position:	21
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureSynapseAnalyticsEndpointResourceId

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AzureSynapseAnalyticsEndpointSuffix

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-BatchEndpointResourceId

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

Type:	String
Aliases:	BatchResourceId, BatchAudience
Position:	20
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContainerRegistryEndpointSuffix

Azure Container Registry のサフィックス。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DataLakeAudience

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

Type:	String
Aliases:	DataLakeEndpointResourceId, DataLakeResourceId
Position:	19
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableAdfsAuthentication

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

Type:	SwitchParameter
Aliases:	OnPremise
Position:	16
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-GalleryEndpoint

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

Type:	String
Aliases:	Gallery, GalleryUrl
Position:	7
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-GraphAudience

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

Type:	String
Aliases:	GraphEndpointResourceId, GraphResourceId
Position:	18
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-GraphEndpoint

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

Type:	String
Aliases:	Graph, GraphUrl
Position:	9
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ManagementPortalUrl

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

Type:	String
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MicrosoftGraphEndpointResourceId

Microsoft Graph のリソース識別子

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MicrosoftGraphUrl

Microsoft Graph Url

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

追加する環境の名前を指定します。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PublishSettingsFileUrl

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

Type:	String
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceManagerEndpoint

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

Type:	String
Aliases:	ResourceManager, ResourceManagerUrl
Position:	6
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Scope

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

Type:	ContextModificationScope
Accepted values:	Process, CurrentUser
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServiceEndpoint

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

Type:	String
Aliases:	ServiceManagement, ServiceManagementUrl
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SqlDatabaseDnsSuffix

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

Type:	String
Position:	13
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-StorageEndpoint

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

Type:	String
Aliases:	StorageEndpointSuffix
Position:	4
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TrafficManagerDnsSuffix

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

Type:	String
Position:	12
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Uri

環境をフェッチするインターネットリソースの URI を指定します。

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

String

SwitchParameter

出力

PSAzureEnvironment