Set-AzureEnvironment
Altera as propriedades de um ambiente do Azure.
Nota
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 do PowerShell herdado não é recomendado ao criar novos recursos, uma vez que o ASM está agendado para desativação. Para obter mais informações, consulte Aposentadoria do Azure Service Manager.
O módulo Az PowerShell é o módulo 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. Não é possível usar Set-AzureEnvironment para alterar o nome de um ambiente do Azure.
Um ambiente do Azure uma implantação independente do Microsoft Azure, como AzureCloud para Azure global e AzureChinaCloud para Azure operado pela 21Vianet na China. Você também pode criar ambientes locais do Azure usando o Azure Pack e os cmdlets WAPack. Para obter mais informações, consulte Pacote do Azure.
NOTA: Não altere as propriedades dos ambientes AzureCloud ou AzureChinaCloud. Use este cmdlet para alterar os valores dos ambientes privados criados.
Exemplos
Exemplo 1: Alterar propriedades do ambiente
PS C:\> Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com"
Este 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 |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ActiveDirectoryServiceEndpointResourceId
Especifica a ID do recurso de uma API de gerenciamento cujo acesso é gerenciado pela ID do Microsoft Entra.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-AdTenant
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-AzureKeyVaultDnsSuffix
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-AzureKeyVaultServiceEndpointResourceId
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-EnableAdfsAuthentication
Tipo: | SwitchParameter |
Aliases: | OnPremise |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-GalleryEndpoint
Altera o ponto de extremidade da galeria do Azure Resource Manager para o valor especificado. O ponto de extremidade da galeria é o local para os modelos de galeria do grupo de recursos. Para obter mais informações sobre grupos de recursos do Azure e modelos de galeria, consulte o tópico de ajuda para Get-AzureResourceGroupGalleryTemplate.
Tipo: | String |
Aliases: | Gallery, GalleryUrl |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-GraphEndpoint
Tipo: | String |
Aliases: | Graph, GraphUrl |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ManagementPortalUrl
Altera a URL do Portal de Gerenciamento do Azure para o valor especificado.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | 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 |
Position: | Named |
Default value: | None |
Necessário: | True |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-Profile
Especifica o perfil do Azure a partir do qual este cmdlet é lido. Se você não especificar um perfil, esse cmdlet será lido a partir do perfil padrão local.
Tipo: | AzureSMProfile |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | 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 |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ResourceManagerEndpoint
Altera o ponto de extremidade dos dados do Azure Resource Manager, incluindo dados sobre grupos de recursos associados à conta. Para obter mais informações sobre o Azure Resource Manager, consulte Cmdlets do Azure Resource Manager (https://go.microsoft.com/fwlink/?LinkID=394765) e Usando o Windows PowerShell com o Resource Manager (https://go.microsoft.com/fwlink/?LinkID=394767).
Tipo: | String |
Aliases: | ResourceManager, ResourceManagerUrl |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-ServiceEndpoint
Altera a URL do ponto de extremidade do serviço do Azure no ambiente especificado. O ponto de extremidade do 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 |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-SqlDatabaseDnsSuffix
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-StorageEndpoint
Altera o ponto de extremidade padrão dos serviços de armazenamento no ambiente especificado.
Tipo: | String |
Aliases: | StorageEndpointSuffix |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | False |
Aceitar carateres universais: | False |
-TrafficManagerDnsSuffix
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | 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