你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
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 cmdlet 设置用于连接到 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 环境,然后使用 cmdlet Set-AzEnvironment 更改创建的环境的 ActiveDirectoryEndpoint 和 GraphEndpoint 属性的值。
参数
-ActiveDirectoryEndpoint
指定 Azure Active Directory 身份验证的基本颁发机构。
类型: | String |
别名: | AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority |
Position: | 5 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ActiveDirectoryServiceEndpointResourceId
指定对 Azure 资源管理器 或服务管理(RDFE)终结点的请求进行身份验证的令牌受众。
类型: | String |
Position: | 8 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AdTenant
指定默认 Active Directory 租户。
类型: | String |
Position: | 17 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ARMEndpoint
Azure 资源管理器终结点。
类型: | String |
别名: | ArmUrl |
Position: | 1 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-AzureAnalysisServicesEndpointResourceId
Azure 分析服务资源的资源标识符。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-AzureAnalysisServicesEndpointSuffix
与 Azure Log Analytics API 通信时要使用的终结点。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-AzureAttestationServiceEndpointResourceId
Azure 证明服务的资源标识符,即所请求令牌的接收者。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureAttestationServiceEndpointSuffix
Azure 证明服务的 Dns 后缀。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix
Azure Data Lake Analytics 作业和目录服务的 Dns 后缀
类型: | String |
Position: | 15 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureDataLakeStoreFileSystemEndpointSuffix
Azure Data Lake Store FileSystem 的 Dns 后缀。 示例:azuredatalake.net
类型: | String |
Position: | 14 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureKeyVaultDnsSuffix
Azure 密钥库服务的 Dns 后缀。 示例为 vault-int.azure-int.net
类型: | String |
Position: | 10 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureKeyVaultServiceEndpointResourceId
Azure 密钥库数据服务的资源标识符,该服务是所请求令牌的接收者。
类型: | String |
Position: | 11 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureOperationalInsightsEndpoint
与 Azure Log Analytics API 通信时要使用的终结点。
类型: | String |
Position: | 22 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureOperationalInsightsEndpointResourceId
使用 Azure Log Analytics API 进行身份验证的令牌受众。
类型: | String |
Position: | 21 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureSynapseAnalyticsEndpointResourceId
Azure Synapse Analytics 的资源标识符,该标识符是所请求令牌的接收者。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-AzureSynapseAnalyticsEndpointSuffix
Azure Synapse Analytics 的 Dns 后缀。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-BatchEndpointResourceId
Azure Batch 服务的资源标识符,即所请求令牌的接收者
类型: | String |
别名: | BatchResourceId, BatchAudience |
Position: | 20 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-Confirm
提示你在运行 cmdlet 之前进行确认。
类型: | SwitchParameter |
别名: | cf |
Position: | Named |
默认值: | False |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ContainerRegistryEndpointSuffix
Azure 容器注册表后缀。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-DataLakeAudience
使用 AD Data Lake 服务终结点进行身份验证的令牌受众。
类型: | String |
别名: | DataLakeEndpointResourceId, DataLakeResourceId |
Position: | 19 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-DefaultProfile
用于与 Azure 通信的凭据、帐户、租户和订阅。
类型: | IAzureContextContainer |
别名: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-EnableAdfsAuthentication
指示允许Active Directory 联合身份验证服务(ADFS)本地身份验证。
类型: | SwitchParameter |
别名: | OnPremise |
Position: | 16 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-GalleryEndpoint
指定 Azure 资源管理器部署模板库的终结点。
参数是将值设置为 GalleryUrl
.PSAzureEnvironment
从 GalleryUrl
ArmMetadata 中删除后,Azure PowerShell 将不再提供该值,因此不建议再设置 GalleryEndpoint
该值。
类型: | String |
别名: | Gallery, GalleryUrl |
Position: | 7 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-GraphAudience
使用 AD Graph 终结点进行身份验证的令牌受众。
类型: | String |
别名: | GraphEndpointResourceId, GraphResourceId |
Position: | 18 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-GraphEndpoint
指定 Graph(Active Directory 元数据)请求的 URL。
类型: | String |
别名: | Graph, GraphUrl |
Position: | 9 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ManagementPortalUrl
指定管理门户的 URL。
类型: | String |
Position: | 3 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-MicrosoftGraphEndpointResourceId
Microsoft Graph 的资源标识符
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-MicrosoftGraphUrl
Microsoft图形 URL
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-Name
指定要修改的环境的名称。
类型: | String |
Position: | 0 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-PublishSettingsFileUrl
指定可从中下载 .publishsettings 文件的 URL。
类型: | String |
Position: | 1 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-ResourceManagerEndpoint
指定 Azure 资源管理器请求的 URL。
类型: | String |
别名: | ResourceManager, ResourceManagerUrl |
Position: | 6 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-Scope
确定上下文更改的范围,例如,更改仅适用于当前进程,还是应用于此用户启动的所有会话。
类型: | ContextModificationScope |
接受的值: | Process, CurrentUser |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ServiceEndpoint
指定服务管理 (RDFE) 请求的终结点。
类型: | String |
别名: | ServiceManagement, ServiceManagementUrl |
Position: | 2 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-SqlDatabaseDnsSuffix
指定Azure SQL 数据库服务器的域名后缀。
类型: | String |
Position: | 13 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-StorageEndpoint
指定存储(blob、表、队列和文件)访问的终结点。
类型: | String |
别名: | StorageEndpointSuffix |
Position: | 4 |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-TrafficManagerDnsSuffix
指定Azure 流量管理器服务的域名后缀。
类型: | String |
Position: | 12 |
默认值: | None |
必需: | False |
接受管道输入: | True |
接受通配符: | False |
-WhatIf
显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。
类型: | SwitchParameter |
别名: | wi |
Position: | Named |
默认值: | False |
必需: | False |
接受管道输入: | False |
接受通配符: | False |