Set-AzureEnvironment

Altera as propriedades de um ambiente do Azure.

Observação

Os cmdlets mostrados nesta documentação são usados para gerenciar recursos herdados do Azure que usam APIs de Gerenciamento de Serviços. Confira o módulo Az PowerShell para usar cmdlets a fim de gerenciar recursos do Azure Resource Manager.

Syntax

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.

Type:String
Aliases:AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ActiveDirectoryServiceEndpointResourceId

Especifica a ID de recurso de uma API de gerenciamento cujo acesso é gerenciado pela ID do Microsoft Entra.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AdTenant

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureKeyVaultDnsSuffix

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AzureKeyVaultServiceEndpointResourceId

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-EnableAdfsAuthentication

Type:SwitchParameter
Aliases:OnPremise
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Aliases:Gallery, GalleryUrl
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-GraphEndpoint

Type:String
Aliases:Graph, GraphUrl
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ManagementPortalUrl

Altera a URL do Portal de Gerenciamento do Azure para o valor especificado.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:AzureSMProfile
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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 () e Usando o Windows PowerShell com o Gerenciador de Recursos (https://go.microsoft.com/fwlink/?LinkID=394765https://go.microsoft.com/fwlink/?LinkID=394767).

Type:String
Aliases:ResourceManager, ResourceManagerUrl
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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.

Type:String
Aliases:ServiceManagement, ServiceManagementUrl
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SqlDatabaseDnsSuffix

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-StorageEndpoint

Altera o ponto de extremidade padrão dos serviços de armazenamento no ambiente especificado.

Type:String
Aliases:StorageEndpointSuffix
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrafficManagerDnsSuffix

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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