Add-AzEnvironment

模組:

Az.Accounts

新增 Azure Resource Manager 實例的端點和元數據。

Syntax

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

Description

Add-AzEnvironment Cmdlet 會新增端點和元數據，讓 Azure Resource Manager Cmdlet 能夠與 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 環境，然後使用 Cmdlet 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/

在此範例中，我們會從 https://configuredmetadata.net Uri 探索新的 Azure 環境。

參數

-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 證明 服務的 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 金鑰保存庫 服務的 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 金鑰保存庫 數據服務的資源標識符，這是所要求令牌的收件者。

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

執行 Cmdlet 之前先提示您確認。

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 同盟服務 （ADFS） 內部部署驗證。

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

-GalleryEndpoint

指定部署範本的 Azure Resource Manager 資源庫端點。 參數是將 值設定為 GalleryUrlPSAzureEnvironment。 從 GalleryUrl ArmMetadata 中移除時，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 資料庫 伺服器的網域名稱後綴。

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 流量管理員 服務的功能變數名稱後綴。

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

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

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

輸入

String

SwitchParameter

輸出

PSAzureEnvironment

相關連結

• Get-AzEnvironment
• Remove-AzEnvironment
• Set-AzEnvironment