Add-AzureEnvironment
Cria 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
Add-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 Add-AzureEnvironment cria um novo ambiente de conta personalizado do Azure e o salva em seu perfil de usuário móvel. O cmdlet retorna um objeto que representa o novo ambiente. Quando o comando for concluído, você poderá usar o ambiente no Windows PowerShell.
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.
Somente o parâmetro Name deste cmdlet é obrigatório. Se você omitir um parâmetro, seu valor será nulo ($Null) e o serviço que usa esse ponto de extremidade pode não funcionar corretamente. Para adicionar ou alterar o valor de uma propriedade de ambiente, use o cmdlet Set-AzureEnvironment .
NOTA: Alterar o ambiente pode fazer com que a sua conta falhe. Normalmente, os ambientes são adicionados apenas para teste ou solução de problemas.
Este tópico descreve o cmdlet na versão 0.8.10 do módulo PowerShell do Microsoft Azure.
Para obter a versão do módulo que você está usando, no console do Azure PowerShell, digite (Get-Module -Name Azure).Version
.
Exemplos
Exemplo 1: Adicionar um ambiente do Azure
PS C:\> Add-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl https://contoso.com/fwlink/?LinkID=101 -ServiceEndpoint https://contoso.com/fwlink/?LinkID=102
Name : ContosoEnv
PublishSettingsFileUrl : https://contoso.com/fwlink/?LinkID=101
ServiceEndpoint : https://contoso.com/fwlink/?LinkID=102
ResourceManagerEndpoint :
ManagementPortalUrl :
ActiveDirectoryEndpoint :
ActiveDirectoryCommonTenantId :
StorageEndpointSuffix :
StorageBlobEndpointFormat :
StorageQueueEndpointFormat :
StorageTableEndpointFormat :
GalleryEndpoint :
Este comando cria o ambiente do Azure ContosoEnv.
Parâmetros
-ActiveDirectoryEndpoint
Especifica o ponto de extremidade para a autenticação do Microsoft Entra no novo ambiente.
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
Especifica o ponto de extremidade para a galeria do Azure Resource Manager, que armazena modelos de galeria de grupos 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-AzureResourceGroupGalleryTemplatehttps://go.microsoft.com/fwlink/?LinkID=393052.
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
Especifica a URL do Portal de Gerenciamento do Azure no novo ambiente.
Tipo: | String |
Position: | Named |
Default value: | None |
Necessário: | False |
Aceitar entrada de pipeline: | True |
Aceitar carateres universais: | False |
-Name
Especifica um nome para o ambiente. Este parâmetro é obrigatório. Não use os nomes dos ambientes padrão, AzureCloud e AzureChinaCloud.
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
Especifica a URL dos arquivos de configurações de publicação para sua conta. 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
Especifica o ponto de extremidade para os 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
Especifica a URL do ponto de extremidade do serviço do Azure. 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
Especifica o ponto de extremidade padrão dos serviços de armazenamento no novo ambiente.
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