你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Add-AzEnvironment

为 Azure 资源管理器实例添加终结点和元数据。

语法

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 cmdlet 添加了终结点和元数据,使 Azure 资源管理器 cmdlet 能够连接到 Azure 资源管理器的新实例。 内置环境 AzureCloud 和 AzureChinaCloud 面向 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
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
Accept pipeline input:True
Accept wildcard characters:False

-ActiveDirectoryServiceEndpointResourceId

指定对 Azure 资源管理器 或服务管理 (RDFE) 终结点的请求进行身份验证的令牌访问群体。

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

-AdTenant

指定默认 Active Directory 租户。

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

-ARMEndpoint

Azure 资源管理器终结点

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

-AutoDiscover

通过默认终结点或已配置的终结点发现环境。

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

-AzureAnalysisServicesEndpointResourceId

Azure Analysis Services资源的资源标识符。

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

-AzureAnalysisServicesEndpointSuffix

与 Azure Log Analytics API 通信时要使用的终结点。

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

-AzureAttestationServiceEndpointResourceId

Azure 证明服务的资源标识符,即所请求令牌的接收方。

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

-AzureAttestationServiceEndpointSuffix

Azure 证明服务的 Dns 后缀。

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

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Azure Data Lake Analytics作业和目录服务的 Dns 后缀

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

-AzureDataLakeStoreFileSystemEndpointSuffix

Azure Data Lake Store FileSystem 的 Dns 后缀。 示例:azuredatalake.net

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

-AzureKeyVaultDnsSuffix

Azure 密钥保管库服务的 Dns 后缀。 示例为 vault-int.azure-int.net

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

-AzureKeyVaultServiceEndpointResourceId

Azure 密钥保管库数据服务的资源标识符,它是所请求令牌的接收者。

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

-AzureOperationalInsightsEndpoint

与 Azure Log Analytics API 通信时要使用的终结点。

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

-AzureOperationalInsightsEndpointResourceId

使用 Azure Log Analytics API 进行身份验证的令牌受众。

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

-AzureSynapseAnalyticsEndpointResourceId

Azure Synapse Analytics 的资源标识符,该标识符是所请求令牌的接收方。

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

-AzureSynapseAnalyticsEndpointSuffix

Azure Synapse Analytics 的 Dns 后缀。

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

-BatchEndpointResourceId

Azure Batch服务的资源标识符,即所请求令牌的接收者

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

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

-ContainerRegistryEndpointSuffix

Azure 容器注册表后缀。

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

-DataLakeAudience

使用 AD Data Lake 服务终结点进行身份验证的令牌受众。

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

-DefaultProfile

用于与 azure 通信的凭据、租户和订阅

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

-EnableAdfsAuthentication

指示允许Active Directory 联合身份验证服务 (ADFS) 本地身份验证。

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

-GalleryEndpoint

指定部署模板的 Azure 资源管理器库的终结点。

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

-GraphAudience

使用 AD Graph 终结点进行身份验证的令牌受众。

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

-GraphEndpoint

指定 Graph (Active Directory 元数据) 请求的 URL。

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

-ManagementPortalUrl

指定管理门户的 URL。

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

-MicrosoftGraphEndpointResourceId

Microsoft Graph 的资源标识符

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

-MicrosoftGraphUrl

Microsoft Graph Url

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

-Name

指定要添加的环境的名称。

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

-PublishSettingsFileUrl

指定可从中下载 .publishsettings 文件的 URL。

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

-ResourceManagerEndpoint

指定 Azure 资源管理器请求的 URL。

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

-Scope

确定上下文更改的范围,例如,更改仅适用于当前进程,还是适用于此用户启动的所有会话。

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

-ServiceEndpoint

指定服务管理 (RDFE) 请求的终结点。

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

-SqlDatabaseDnsSuffix

指定Azure SQL数据库服务器的域名后缀。

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

-StorageEndpoint

指定存储 (blob、表、队列和文件) 访问的终结点。

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

-TrafficManagerDnsSuffix

指定 Azure 流量管理器服务的域名后缀。

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

-Uri

指定要提取环境的 Internet 资源的 URI。

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

-WhatIf

显示在此 cmdlet 运行的情况下将会发生什么。 此 cmdlet 未运行。

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

输入

String

SwitchParameter

输出

PSAzureEnvironment