Compartilhar via


Add-AzureEnvironment

Cria 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

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 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.

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

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.

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

Especifica a URL do Portal de Gerenciamento do Azure no novo ambiente.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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
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

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
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga: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 (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

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.

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

Especifica o ponto de extremidade padrão dos serviços de armazenamento no novo ambiente.

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