Set-AzEnvironment
Define propriedades para um ambiente do Azure.
Sintaxe
Name (Padrão)
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>]
[[-AdTenant] <String>]
[[-GraphAudience] <String>]
[[-DataLakeAudience] <String>]
[[-BatchEndpointResourceId] <String>]
[[-AzureOperationalInsightsEndpointResourceId] <String>]
[[-AzureOperationalInsightsEndpoint] <String>]
[-EnableAdfsAuthentication]
[-AzureAnalysisServicesEndpointSuffix <String>]
[-AzureAnalysisServicesEndpointResourceId <String>]
[-AzureAttestationServiceEndpointSuffix <String>]
[-AzureAttestationServiceEndpointResourceId <String>]
[-AzureSynapseAnalyticsEndpointSuffix <String>]
[-ContainerRegistryEndpointSuffix <String>]
[-AzureSynapseAnalyticsEndpointResourceId <String>]
[-MicrosoftGraphEndpointResourceId <String>]
[-MicrosoftGraphUrl <String>]
[-SshAuthScope <String>]
[-Scope <ContextModificationScope>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ARMEndpoint
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>]
Descrição
O cmdlet Set-AzEnvironment define pontos de extremidade e metadados para se conectar a uma instância do Azure.
Exemplos
Exemplo 1: Criando e modificando um novo ambiente
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 :
Neste exemplo, estamos criando um novo ambiente do Azure com pontos de extremidade de exemplo usando Add-AzEnvironment e, em seguida, estamos alterando o valor dos atributos ActiveDirectoryEndpoint e GraphEndpoint do ambiente criado usando o cmdlet Set-AzEnvironment.
Parâmetros
-ActiveDirectoryEndpoint
Especifica a autoridade base para a autenticação do Azure Ative Directory.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Conjuntos de parâmetros
Name
Posição: 5
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: 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).
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: 8
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AdTenant
Especifica o locatário padrão do Ative Directory.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: 17
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-ARMEndpoint
O ponto de extremidade do Azure Resource Manager.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: ArmUrl
Conjuntos de parâmetros
ARMEndpoint
Posição: 1
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureAnalysisServicesEndpointResourceId
O identificador de recurso do recurso do Azure Analysis Services.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: False
Valor dos argumentos restantes: False
-AzureAnalysisServicesEndpointSuffix
O ponto de extremidade a ser usado ao se comunicar com a API do Azure Log Analytics.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: False
Valor dos argumentos restantes: False
-AzureAttestationServiceEndpointResourceId
O identificador de recurso do serviço de Atestado do Azure que é o destinatário do token solicitado.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureAttestationServiceEndpointSuffix
Sufixo Dns do serviço de Atestado do Azure.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix
Sufixo Dns dos serviços de catálogo e trabalho do Azure Data Lake Analytics
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: 15
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureDataLakeStoreFileSystemEndpointSuffix
Sufixo Dns do Azure Data Lake Store FileSystem. Exemplo: azuredatalake.net
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: 14
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureKeyVaultDnsSuffix
Sufixo Dns do serviço Azure Key Vault. Exemplo é vault-int.azure-int.net
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: 10
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureKeyVaultServiceEndpointResourceId
Identificador de recurso do serviço de dados do Azure Key Vault que é o destinatário do token solicitado.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: 11
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureOperationalInsightsEndpoint
O ponto de extremidade a ser usado ao se comunicar com a API do Azure Log Analytics.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: 22
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureOperationalInsightsEndpointResourceId
O público para autenticação de tokens com a API do Azure Log Analytics.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: 21
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureSynapseAnalyticsEndpointResourceId
O identificador de recurso do Azure Synapse Analytics que é o destinatário do token solicitado.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-AzureSynapseAnalyticsEndpointSuffix
Sufixo Dns do Azure Synapse Analytics.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-BatchEndpointResourceId
O identificador de recurso do serviço de Lote do Azure que é o destinatário do token solicitado
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: BatchResourceId, BatchAudience
Conjuntos de parâmetros
(All)
Posição: 20
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
Tipo: SwitchParameter
Valor padrão: False
Suporta curingas: False
DontShow: False
Pseudónimos: Cf.
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: False
Valor dos argumentos restantes: False
-ContainerRegistryEndpointSuffix
Sufixo do Registro de Contêiner do Azure.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-DataLakeAudience
O público para autenticação de tokens com o Ponto de Extremidade dos serviços AD Data Lake.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: DataLakeEndpointResourceId, DataLakeResourceId
Conjuntos de parâmetros
(All)
Posição: 19
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-DefaultProfile
As credenciais, conta, locatário e assinatura usados para comunicação com o azure.
Propriedades dos parâmetros
Tipo: IAzureContextContainer
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: AzContext, AzureRmContext, AzureCredential
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: False
Valor dos argumentos restantes: False
-EnableAdfsAuthentication
Indica que a autenticação local dos Serviços de Federação do Ative Directory (ADFS) é permitida.
Propriedades dos parâmetros
Tipo: SwitchParameter
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: OnPremise
Conjuntos de parâmetros
Name
Posição: 16
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-GalleryEndpoint
Especifica o ponto de extremidade para a galeria de modelos de implantação do Azure Resource Manager.
O parâmetro é definir o valor como GalleryUrl de PSAzureEnvironment. Como GalleryUrl é removido do ArmMetadata, o Azure PowerShell não fornecerá mais o valor e, portanto, não é recomendado definir GalleryEndpoint mais.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: Gallery, GaleriaUrl
Conjuntos de parâmetros
Name
Posição: 7
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-GraphAudience
O público para tokens autenticados com o ponto de extremidade do AD Graph.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: GraphEndpointResourceId, GraphResourceId
Conjuntos de parâmetros
Name
Posição: 18
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-GraphEndpoint
Especifica a URL para solicitações do Graph (metadados do Ative Directory).
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: Graph, GraphUrl
Conjuntos de parâmetros
Name
Posição: 9
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-ManagementPortalUrl
Especifica a URL do Portal de Gerenciamento.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: 3
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-MicrosoftGraphEndpointResourceId
O identificador de recurso do Microsoft Graph
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-MicrosoftGraphUrl
Microsoft Graph Url
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-Name
Especifica o nome do ambiente a ser modificado.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: 0
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-PublishSettingsFileUrl
Especifica a URL a partir da qual os arquivos .publishsettings podem ser baixados.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: 1
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-ResourceManagerEndpoint
Especifica a URL para solicitações do Azure Resource Manager.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: Gestor de Recursos, ResourceManagerUrl
Conjuntos de parâmetros
Name
Posição: 6
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: 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.
Propriedades dos parâmetros
Tipo: ContextModificationScope
Valor padrão: None
Valores aceites: Process, CurrentUser
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: False
Valor dos argumentos restantes: False
-ServiceEndpoint
Especifica o ponto de extremidade para solicitações RDFE (Gerenciamento de Serviços).
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: Gestão de Serviços, ServiceManagementUrl
Conjuntos de parâmetros
Name
Posição: 2
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-SqlDatabaseDnsSuffix
Especifica o sufixo de nome de domínio para servidores do Banco de Dados SQL do Azure.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: 13
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-SshAuthScope
O escopo para autenticação quando SSH para uma VM do Azure.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-StorageEndpoint
Especifica o ponto de extremidade para acesso ao armazenamento (blob, tabela, fila e arquivo).
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Pseudónimos: Sufixo StorageEndpointSuffix
Conjuntos de parâmetros
(All)
Posição: 4
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: False
Valor dos argumentos restantes: False
-TrafficManagerDnsSuffix
Especifica o sufixo de nome de domínio para os serviços do Azure Traffic Manager.
Propriedades dos parâmetros
Tipo: String
Valor padrão: None
Suporta curingas: False
DontShow: False
Conjuntos de parâmetros
Name
Posição: 12
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: True
Valor dos argumentos restantes: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
Tipo: SwitchParameter
Valor padrão: False
Suporta curingas: False
DontShow: False
Pseudónimos: Wi
Conjuntos de parâmetros
(All)
Posição: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome da propriedade: False
Valor dos argumentos restantes: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas