Set-AzureEnvironment
Altera as propriedades de um ambiente do Azure.
Observação
Os cmdlets mencionados nesta documentação são para gerenciar recursos herdados do Azure que usam APIs do Azure Service Manager (ASM). Este módulo herdado do PowerShell não é recomendado ao criar novos recursos, já que o ASM está programado para desativação. Para obter mais informações, consulte Aposentadoria do Azure Service Manager.
O módulo Az PowerShell é o módulo do PowerShell recomendado para gerenciar recursos do Azure Resource Manager (ARM) com o PowerShell.
Sintaxe
Set-AzureEnvironment
-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>]
[-EnableAdfsAuthentication]
[-AdTenant <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>] Description
O cmdlet Set-AzureEnvironment altera as propriedades de um ambiente do Azure. Ele retorna um objeto que representa o ambiente com seus novos valores de propriedade. Use o parâmetro Name para identificar o ambiente e os outros parâmetros para alterar os valores de propriedade. Você não pode usar Set-AzureEnvironment para alterar o nome de um ambiente do Azure.
Um ambiente do Azure uma implantação independente do Microsoft Azure, como o AzureCloud para Azure global e o AzureChinaCloud para Azure operado pela 21Vianet na China. Você também pode criar ambientes locais do Azure usando o Pacote do Azure e os cmdlets WAPack. Para obter mais informações, consulte Pacote do Azure.
Observação : não altere as propriedades dos ambientes AzureCloud ou AzureChinaCloud. Use este cmdlet para alterar os valores dos ambientes privados que você criar.
Exemplos
Exemplo 1: Alterar propriedades do ambiente
PS C:\> Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com"Esse comando altera os valores das propriedades PublishSettingsFileUrl e StorageEndpoint do ambiente ContosoEnv.
Parâmetros
-ActiveDirectoryEndpoint
Altera o ponto de extremidade da autenticação do Microsoft Entra para o valor especificado.
| Tipo: | String |
| Aliases: | AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-ActiveDirectoryServiceEndpointResourceId
Especifica a ID de recurso de uma API de gerenciamento cujo acesso é gerenciado pela ID do Microsoft Entra.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-AdTenant
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-AzureKeyVaultDnsSuffix
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-AzureKeyVaultServiceEndpointResourceId
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-EnableAdfsAuthentication
| Tipo: | SwitchParameter |
| Aliases: | OnPremise |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-GalleryEndpoint
Altera o ponto de extremidade da galeria do Gerenciador de Recursos do Azure para o valor especificado. O ponto de extremidade da galeria é o local para modelos de galeria de grupo de recursos. Para obter mais informações sobre grupos de recursos e modelos de galeria do Azure, consulte o tópico de ajuda para Get-AzureResourceGroupGalleryTemplate.
| Tipo: | String |
| Aliases: | Gallery, GalleryUrl |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-GraphEndpoint
| Tipo: | String |
| Aliases: | Graph, GraphUrl |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-ManagementPortalUrl
Altera a URL do Portal de Gerenciamento do Azure para o valor especificado.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-Name
Identifica o ambiente que está sendo alterado. Este parâmetro é obrigatório. O valor do parâmetro diferencia maiúsculas de minúsculas. Caracteres curinga não são permitidos.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-Profile
Especifica o perfil do Azure a partir do qual este cmdlet lê. Se você não especificar um perfil, esse cmdlet será lido a partir do perfil padrão local.
| Tipo: | AzureSMProfile |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-PublishSettingsFileUrl
Altera a URL dos arquivos de configurações de publicação no ambiente especificado. Um arquivo de configurações de publicação do Azure é um arquivo XML que contém informações sobre sua conta e um certificado de gerenciamento que permite que o Windows PowerShell entre em sua conta do Azure em seu nome.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-ResourceManagerEndpoint
Altera o ponto de extremidade para dados do Gerenciador de Recursos do Azure, incluindo dados sobre grupos de recursos associados à conta. Para obter mais informações sobre o Gerenciador de Recursos do Azure, consulte Cmdlets do Gerenciador de Recursos do Azure (https://go.microsoft.com/fwlink/?LinkID=394765) e Usando o Windows PowerShell com o Gerenciador de Recursos (https://go.microsoft.com/fwlink/?LinkID=394767).
| Tipo: | String |
| Aliases: | ResourceManager, ResourceManagerUrl |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-ServiceEndpoint
Altera a URL do ponto de extremidade de serviço do Azure no ambiente especificado. O ponto de extremidade de serviço do Azure determina se seu aplicativo é gerenciado pela plataforma global do Azure, o Azure operado pela 21Vianet na China ou uma instalação privada do Azure.
| Tipo: | String |
| Aliases: | ServiceManagement, ServiceManagementUrl |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-SqlDatabaseDnsSuffix
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-StorageEndpoint
Altera o ponto de extremidade padrão dos serviços de armazenamento no ambiente especificado.
| Tipo: | String |
| Aliases: | StorageEndpointSuffix |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-TrafficManagerDnsSuffix
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
Entradas
None
Você pode canalizar a entrada para esse cmdlet pelo nome da propriedade, mas não pelo valor.
Saídas
Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment