Add-AzureEnvironment
Cria 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
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 personalizada 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 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.
Somente o parâmetro Name deste cmdlet é obrigatório. Se você omitir um parâmetro, seu valor será null ($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 .
Observação : alterar o ambiente pode fazer com que 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 do 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 :
Esse comando cria o ambiente do Azure ContosoEnv.
Parâmetros
-ActiveDirectoryEndpoint
Especifica o ponto de extremidade para autenticação do Microsoft Entra no novo ambiente.
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
Especifica o ponto de extremidade para a galeria do Gerenciador de Recursos do Azure, que armazena 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-AzureResourceGroupGalleryTemplatehttps://go.microsoft.com/fwlink/?LinkID=393052.
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
Especifica a URL do Portal de Gerenciamento do Azure no novo ambiente.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | 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.
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
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceManagerEndpoint
Especifica 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
Especifica a URL do ponto de extremidade de serviço do Azure. 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
Especifica o ponto de extremidade padrão dos serviços de armazenamento no novo ambiente.
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