Compartilhar via

Set-AzureRmEnvironment

  • Referência
Módulo:
AzureRM.Profile

Define propriedades para um ambiente do Azure.

Aviso

O módulo PowerShell do AzureRM 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 do Az PowerShell para garantir o suporte e as atualizações contínuas.

Embora o módulo AzureRM ainda possa funcionar, ele não tem suporte ou será mantido, colocando qualquer uso contínuo a critério e risco do usuário. Consulte nossos recursos de migração para obter diretrizes 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 autenticação do Microsoft Entra.

Tipo:String
Aliases:AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Cargo:5
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ActiveDirectoryServiceEndpointResourceId

Especifica o público-alvo de tokens que autenticam solicitações para pontos de extremidade do Azure Resource Manager ou do Gerenciamento de Serviços (RDFE).

Tipo:String
Cargo:8
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AdTenant

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

Tipo:String
Cargo:17
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ARMEndpoint

O ponto de extremidade do Azure Resource Manager.

Tipo:String
Aliases:ArmUrl
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AzureAnalysisServicesEndpointSuffix

Sufixo DNS de pontos de extremidade de serviço do Azure Analysis Services

Tipo:String
Cargo:15
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

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

Tipo:String
Cargo:15
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AzureDataLakeStoreFileSystemEndpointSuffix

Sufixo DNS do Sistema de Arquivos do Azure Data Lake Store. Exemplo: azuredatalake.net

Tipo:String
Cargo:14
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AzureKeyVaultDnsSuffix

Especifica o sufixo do nome de domínio para os serviços do Key Vault.

Tipo:String
Cargo:10
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AzureKeyVaultServiceEndpointResourceId

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

Tipo:String
Cargo:11
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AzureOperationalInsightsEndpoint

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

Tipo:String
Cargo:22
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-AzureOperationalInsightsEndpointResourceId

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

Tipo:String
Cargo:21
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-BatchEndpointResourceId

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

Tipo:String
Aliases:BatchResourceId, BatchAudience
Cargo:20
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DataLakeAudience

O público-alvo de tokens autenticados com o Ponto de Extremidade de serviços do AD Data Lake.

Tipo:String
Aliases:DataLakeEndpointResourceId, DataLakeResourceId
Cargo:19
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-DefaultProfile

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

Tipo:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EnableAdfsAuthentication

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

Tipo:SwitchParameter
Aliases:OnPremise
Cargo:16
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-GalleryEndpoint

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

Tipo:String
Aliases:Gallery, GalleryUrl
Cargo:7
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-GraphAudience

O público-alvo de tokens autenticados com o Ponto de Extremidade do Graph do AD.

Tipo:String
Aliases:GraphEndpointResourceId, GraphResourceId
Cargo:18
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-GraphEndpoint

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

Tipo:String
Aliases:Graph, GraphUrl
Cargo:9
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ManagementPortalUrl

Especifica a URL para o Portal de Gerenciamento.

Tipo:String
Cargo:3
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

Especifica o nome do ambiente a ser modificado.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PublishSettingsFileUrl

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

Tipo:String
Cargo:1
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-ResourceManagerEndpoint

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

Tipo:String
Aliases:ResourceManager, ResourceManagerUrl
Cargo:6
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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 aceitos:Process, CurrentUser
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ServiceEndpoint

Especifica o ponto de extremidade para solicitações de gerenciamento de serviços (RDFE).

Tipo:String
Aliases:ServiceManagement, ServiceManagementUrl
Cargo:2
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-SqlDatabaseDnsSuffix

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

Tipo:String
Cargo:13
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-StorageEndpoint

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

Tipo:String
Aliases:StorageEndpointSuffix
Cargo:4
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-TrafficManagerDnsSuffix

Especifica o sufixo de nome de domínio para os serviços do Gerenciador de Tráfego do Azure.

Tipo:String
Cargo:12
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

String

SwitchParameter

Saídas

PSAzureEnvironment