Partilhar via


Set-AzureRmEnvironment

Define propriedades para um ambiente do Azure.

Aviso

O módulo AzureRM do PowerShell foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo Az PowerShell para garantir suporte e atualizações contínuos.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte nossos recursos de migração para obter orientação sobre a transição para o módulo Az.

Sintaxe

Set-AzureRmEnvironment
   [-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>]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzureRmEnvironment
   [-Name] <String>
   [[-StorageEndpoint] <String>]
   [-ARMEndpoint] <String>
   [[-AzureKeyVaultDnsSuffix] <String>]
   [[-AzureKeyVaultServiceEndpointResourceId] <String>]
   [[-DataLakeAudience] <String>]
   [[-BatchEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpoint] <String>]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet Set-AzureRMEnvironment define pontos de extremidade e metadados para se conectar a uma instância do Azure.

Exemplos

Exemplo 1: Criando e modificando um novo ambiente

PS C:\> Add-AzureRmEnvironment -Name TestEnvironment `
        -ActiveDirectoryEndpoint TestADEndpoint `
        -ActiveDirectoryServiceEndpointResourceId TestADApplicationId `
        -ResourceManagerEndpoint TestRMEndpoint `
        -GalleryEndpoint TestGalleryEndpoint `
        -GraphEndpoint TestGraphEndpoint

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

PS C:\> Set-AzureRmEnvironment -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        :

Neste exemplo, estamos criando um novo ambiente do Azure com pontos de extremidade de exemplo usando Add-AzureRmEnvironment e, em seguida, estamos alterando o valor dos atributos ActiveDirectoryEndpoint e GraphEndpoint do ambiente criado usando o cmdlet Set-AzureRmEnvironment.

Parâmetros

-ActiveDirectoryEndpoint

Especifica a autoridade base para a autenticação do Microsoft Entra.

Tipo:String
Aliases:AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Position:5
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ActiveDirectoryServiceEndpointResourceId

Especifica a audiência de tokens que autenticam solicitações para o Gerenciador de Recursos do Azure ou pontos de extremidade de Gerenciamento de Serviços (RDFE).

Tipo:String
Position:8
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AdTenant

Especifica o locatário padrão do Ative Directory.

Tipo:String
Position:17
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ARMEndpoint

O ponto de extremidade do Azure Resource Manager.

Tipo:String
Aliases:ArmUrl
Position:1
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureAnalysisServicesEndpointSuffix

Sufixo Dns dos pontos de extremidade de serviço do Azure Analysis Services

Tipo:String
Position:15
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Sufixo Dns dos serviços de catálogo e trabalho do Azure Data Lake Analytics

Tipo:String
Position:15
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureDataLakeStoreFileSystemEndpointSuffix

Sufixo Dns do Azure Data Lake Store FileSystem. Exemplo: azuredatalake.net

Tipo:String
Position:14
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureKeyVaultDnsSuffix

Especifica o sufixo de nome de domínio para os serviços do Cofre de Chaves.

Tipo:String
Position:10
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureKeyVaultServiceEndpointResourceId

Especifica a audiência para tokens de acesso que autorizam solicitações para serviços do Cofre de Chaves.

Tipo:String
Position:11
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureOperationalInsightsEndpoint

Especifica o ponto de extremidade para o acesso à consulta do Operational Insights.

Tipo:String
Position:22
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureOperationalInsightsEndpointResourceId

Especifica o público para tokens de acesso que autorizam solicitações para serviços do Operational Insights.

Tipo:String
Position:21
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-BatchEndpointResourceId

O identificador de recurso do serviço de Lote do Azure que é o destinatário do token solicitado

Tipo:String
Aliases:BatchResourceId, BatchAudience
Position:20
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DataLakeAudience

O público para autenticação de tokens com o Ponto de Extremidade dos serviços AD Data Lake.

Tipo:String
Aliases:DataLakeEndpointResourceId, DataLakeResourceId
Position:19
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-DefaultProfile

As credenciais, conta, locatário e assinatura usados para comunicação com o azure.

Tipo:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-EnableAdfsAuthentication

Indica que a autenticação local dos Serviços de Federação do Ative Directory (ADFS) é permitida.

Tipo:SwitchParameter
Aliases:OnPremise
Position:16
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-GalleryEndpoint

Especifica o ponto de extremidade para a galeria de modelos de implantação do Azure Resource Manager.

Tipo:String
Aliases:Gallery, GalleryUrl
Position:7
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-GraphAudience

O público para tokens autenticados com o ponto de extremidade do AD Graph.

Tipo:String
Aliases:GraphEndpointResourceId, GraphResourceId
Position:18
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-GraphEndpoint

Especifica a URL para solicitações do Graph (metadados do Ative Directory).

Tipo:String
Aliases:Graph, GraphUrl
Position:9
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ManagementPortalUrl

Especifica a URL do Portal de Gerenciamento.

Tipo:String
Position:3
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Name

Especifica o nome do ambiente a ser modificado.

Tipo:String
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-PublishSettingsFileUrl

Especifica a URL a partir da qual os arquivos .publishsettings podem ser baixados.

Tipo:String
Position:1
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ResourceManagerEndpoint

Especifica a URL para solicitações do Azure Resource Manager.

Tipo:String
Aliases:ResourceManager, ResourceManagerUrl
Position:6
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Scope

Determina o escopo das alterações de contexto, por exemplo, se as alterações se aplicam apenas ao processo atual ou a todas as sessões iniciadas por esse usuário.

Tipo:ContextModificationScope
Valores aceites:Process, CurrentUser
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ServiceEndpoint

Especifica o ponto de extremidade para solicitações RDFE (Gerenciamento de Serviços).

Tipo:String
Aliases:ServiceManagement, ServiceManagementUrl
Position:2
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-SqlDatabaseDnsSuffix

Especifica o sufixo de nome de domínio para servidores do Banco de Dados SQL do Azure.

Tipo:String
Position:13
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-StorageEndpoint

Especifica o ponto de extremidade para acesso ao armazenamento (blob, tabela, fila e arquivo).

Tipo:String
Aliases:StorageEndpointSuffix
Position:4
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-TrafficManagerDnsSuffix

Especifica o sufixo de nome de domínio para os serviços do Azure Traffic Manager.

Tipo:String
Position:12
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

String

SwitchParameter

Saídas

PSAzureEnvironment