Partilhar via


Add-AzEnvironment

Adiciona pontos de extremidade e metadados para uma instância do Azure Resource Manager.

Sintaxe

Add-AzEnvironment
   [-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>]
   [[-AzureDataLakeStoreFileSystemEndpointSuffix] <String>]
   [[-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix] <String>]
   [-EnableAdfsAuthentication]
   [[-AdTenant] <String>]
   [[-GraphAudience] <String>]
   [[-DataLakeAudience] <String>]
   [[-BatchEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpoint] <String>]
   [-AzureAnalysisServicesEndpointSuffix <String>]
   [-AzureAnalysisServicesEndpointResourceId <String>]
   [-AzureAttestationServiceEndpointSuffix <String>]
   [-AzureAttestationServiceEndpointResourceId <String>]
   [-AzureSynapseAnalyticsEndpointSuffix <String>]
   [-ContainerRegistryEndpointSuffix <String>]
   [-AzureSynapseAnalyticsEndpointResourceId <String>]
   [-MicrosoftGraphEndpointResourceId <String>]
   [-MicrosoftGraphUrl <String>]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzEnvironment
   [-Name] <String>
   [[-StorageEndpoint] <String>]
   [-ARMEndpoint] <String>
   [[-AzureKeyVaultDnsSuffix] <String>]
   [[-AzureKeyVaultServiceEndpointResourceId] <String>]
   [[-DataLakeAudience] <String>]
   [[-BatchEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpointResourceId] <String>]
   [[-AzureOperationalInsightsEndpoint] <String>]
   [-AzureAnalysisServicesEndpointSuffix <String>]
   [-AzureAnalysisServicesEndpointResourceId <String>]
   [-AzureAttestationServiceEndpointSuffix <String>]
   [-AzureAttestationServiceEndpointResourceId <String>]
   [-AzureSynapseAnalyticsEndpointSuffix <String>]
   [-ContainerRegistryEndpointSuffix <String>]
   [-AzureSynapseAnalyticsEndpointResourceId <String>]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-AzEnvironment
   [-AutoDiscover]
   [-Uri <Uri>]
   [-Scope <ContextModificationScope>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

O cmdlet Add-AzEnvironment adiciona pontos de extremidade e metadados para permitir que os cmdlets do Azure Resource Manager se conectem a uma nova instância do Azure Resource Manager. Os ambientes internos AzureCloud e AzureChinaCloud destinam-se a instâncias públicas existentes do Azure Resource Manager.

Exemplos

Exemplo 1: Criando e modificando um novo ambiente

Add-AzEnvironment -Name TestEnvironment `
        -ActiveDirectoryEndpoint TestADEndpoint `
        -ActiveDirectoryServiceEndpointResourceId TestADApplicationId `
        -ResourceManagerEndpoint TestRMEndpoint `
        -GalleryEndpoint TestGalleryEndpoint `
        -GraphEndpoint TestGraphEndpoint

Name            Resource Manager Url ActiveDirectory Authority
----            -------------------- -------------------------
TestEnvironment TestRMEndpoint       TestADEndpoint/

Set-AzEnvironment -Name TestEnvironment `
        -ActiveDirectoryEndpoint NewTestADEndpoint `
        -GraphEndpoint NewTestGraphEndpoint | Format-List

Name                                              : TestEnvironment
EnableAdfsAuthentication                          : False
OnPremise                                         : False
ActiveDirectoryServiceEndpointResourceId          : TestADApplicationId
AdTenant                                          :
GalleryUrl                                        : TestGalleryEndpoint
ManagementPortalUrl                               :
ServiceManagementUrl                              :
PublishSettingsFileUrl                            :
ResourceManagerUrl                                : TestRMEndpoint
SqlDatabaseDnsSuffix                              :
StorageEndpointSuffix                             :
ActiveDirectoryAuthority                          : NewTestADEndpoint
GraphUrl                                          : NewTestGraphEndpoint
GraphEndpointResourceId                           :
TrafficManagerDnsSuffix                           :
AzureKeyVaultDnsSuffix                            :
DataLakeEndpointResourceId                        :
AzureDataLakeStoreFileSystemEndpointSuffix        :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId            :
AzureOperationalInsightsEndpointResourceId        :
AzureOperationalInsightsEndpoint                  :
AzureAnalysisServicesEndpointSuffix               :
AzureAttestationServiceEndpointSuffix             :
AzureAttestationServiceEndpointResourceId         :
AzureSynapseAnalyticsEndpointSuffix               :
AzureSynapseAnalyticsEndpointResourceId           :
VersionProfiles                                   : {}
ExtendedProperties                                : {}
BatchEndpointResourceId                           :

Neste exemplo, estamos criando um novo ambiente do Azure com pontos de extremidade de exemplo usando Add-AzEnvironment e, em seguida, estamos alterando o valor dos atributos ActiveDirectoryEndpoint e GraphEndpoint do ambiente criado usando o cmdlet Set-AzEnvironment.

Exemplo 2: Descobrindo um novo ambiente via Uri

<#
Uri https://configuredmetadata.net returns an array of environment metadata. The following example contains a payload for the AzureCloud default environment.

[
  {
    "portal": "https://portal.azure.com",
    "authentication": {
      "loginEndpoint": "https://login.microsoftonline.com/",
      "audiences": [
        "https://management.core.windows.net/"
      ],
      "tenant": "common",
      "identityProvider": "AAD"
    },
    "media": "https://rest.media.azure.net",
    "graphAudience": "https://graph.windows.net/",
    "graph": "https://graph.windows.net/",
    "name": "AzureCloud",
    "suffixes": {
      "azureDataLakeStoreFileSystem": "azuredatalakestore.net",
      "acrLoginServer": "azurecr.io",
      "sqlServerHostname": ".database.windows.net",
      "azureDataLakeAnalyticsCatalogAndJob": "azuredatalakeanalytics.net",
      "keyVaultDns": "vault.azure.net",
      "storage": "core.windows.net",
      "azureFrontDoorEndpointSuffix": "azurefd.net"
    },
    "batch": "https://batch.core.windows.net/",
    "resourceManager": "https://management.azure.com/",
    "vmImageAliasDoc": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/arm-compute/quickstart-templates/aliases.json",
    "activeDirectoryDataLake": "https://datalake.azure.net/",
    "sqlManagement": "https://management.core.windows.net:8443/",
    "gallery": "https://gallery.azure.com/"
  },
……
]
#>

Add-AzEnvironment -AutoDiscover -Uri https://configuredmetadata.net

Name            Resource Manager Url ActiveDirectory Authority
----            -------------------- -------------------------
TestEnvironment TestRMEndpoint       TestADEndpoint/

Neste exemplo, estamos descobrindo um novo ambiente do Azure a partir do https://configuredmetadata.net Uri.

Parâmetros

-ActiveDirectoryEndpoint

Especifica a autoridade base para a autenticação do Azure Ative Directory.

Tipo:String
Aliases:AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Position:5
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ActiveDirectoryServiceEndpointResourceId

Especifica a audiência de tokens que autenticam solicitações para o Gerenciador de Recursos do Azure ou pontos de extremidade de Gerenciamento de Serviços (RDFE).

Tipo:String
Position:8
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AdTenant

Especifica o locatário padrão do Ative Directory.

Tipo:String
Position:17
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ARMEndpoint

O ponto de extremidade do Azure Resource Manager

Tipo:String
Aliases:ArmUrl
Position:1
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AutoDiscover

Descobre ambientes por meio de endpoint padrão ou configurado.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-AzureAnalysisServicesEndpointResourceId

O identificador de recurso do recurso do Azure Analysis Services.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-AzureAnalysisServicesEndpointSuffix

O ponto de extremidade a ser usado ao se comunicar com a API do Azure Log Analytics.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-AzureAttestationServiceEndpointResourceId

O identificador de recurso do serviço de Atestado do Azure que é o destinatário do token solicitado.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureAttestationServiceEndpointSuffix

Sufixo Dns do serviço de Atestado do Azure.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Sufixo Dns dos serviços de catálogo e trabalho do Azure Data Lake Analytics

Tipo:String
Position:15
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureDataLakeStoreFileSystemEndpointSuffix

Sufixo Dns do Azure Data Lake Store FileSystem. Exemplo: azuredatalake.net

Tipo:String
Position:14
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureKeyVaultDnsSuffix

Sufixo Dns do serviço Azure Key Vault. Exemplo é vault-int.azure-int.net

Tipo:String
Position:10
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureKeyVaultServiceEndpointResourceId

Identificador de recurso do serviço de dados do Azure Key Vault que é o destinatário do token solicitado.

Tipo:String
Position:11
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureOperationalInsightsEndpoint

O ponto de extremidade a ser usado ao se comunicar com a API do Azure Log Analytics.

Tipo:String
Position:22
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureOperationalInsightsEndpointResourceId

O público para autenticação de tokens com a API do Azure Log Analytics.

Tipo:String
Position:21
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureSynapseAnalyticsEndpointResourceId

O identificador de recurso do Azure Synapse Analytics que é o destinatário do token solicitado.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-AzureSynapseAnalyticsEndpointSuffix

Sufixo Dns do Azure Synapse Analytics.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-BatchEndpointResourceId

O identificador de recurso do serviço de Lote do Azure que é o destinatário do token solicitado

Tipo:String
Aliases:BatchResourceId, BatchAudience
Position:20
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ContainerRegistryEndpointSuffix

Sufixo do Registro de Contêiner do Azure.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-DataLakeAudience

O público para autenticação de tokens com o Ponto de Extremidade dos serviços AD Data Lake.

Tipo:String
Aliases:DataLakeEndpointResourceId, DataLakeResourceId
Position:19
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-DefaultProfile

As credenciais, o locatário e a assinatura usados para comunicação com o azure

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-EnableAdfsAuthentication

Indica que a autenticação local dos Serviços de Federação do Ative Directory (ADFS) é permitida.

Tipo:SwitchParameter
Aliases:OnPremise
Position:16
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-GalleryEndpoint

Especifica o ponto de extremidade para a galeria de modelos de implantação do Azure Resource Manager. O parâmetro é definir o valor como GalleryUrl de PSAzureEnvironment. Como GalleryUrl é removido do ArmMetadata, o Azure PowerShell não fornecerá mais o valor e, portanto, não é recomendado definir GalleryEndpoint mais.

Tipo:String
Aliases:Gallery, GalleryUrl
Position:7
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-GraphAudience

O público para tokens autenticados com o ponto de extremidade do AD Graph.

Tipo:String
Aliases:GraphEndpointResourceId, GraphResourceId
Position:18
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-GraphEndpoint

Especifica a URL para solicitações do Graph (metadados do Ative Directory).

Tipo:String
Aliases:Graph, GraphUrl
Position:9
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ManagementPortalUrl

Especifica a URL do Portal de Gerenciamento.

Tipo:String
Position:3
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-MicrosoftGraphEndpointResourceId

O identificador de recurso do Microsoft Graph

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-MicrosoftGraphUrl

Microsoft Graph Url

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Name

Especifica o nome do ambiente a ser adicionado.

Tipo:String
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-PublishSettingsFileUrl

Especifica a URL a partir da qual os arquivos .publishsettings podem ser baixados.

Tipo:String
Position:1
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-ResourceManagerEndpoint

Especifica a URL para solicitações do Azure Resource Manager.

Tipo:String
Aliases:ResourceManager, ResourceManagerUrl
Position:6
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Scope

Determina o escopo das alterações de contexto, por exemplo, se as alterações se aplicam apenas ao processo atual ou a todas as sessões iniciadas por esse usuário.

Tipo:ContextModificationScope
Valores aceites:Process, CurrentUser
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ServiceEndpoint

Especifica o ponto de extremidade para solicitações RDFE (Gerenciamento de Serviços).

Tipo:String
Aliases:ServiceManagement, ServiceManagementUrl
Position:2
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-SqlDatabaseDnsSuffix

Especifica o sufixo de nome de domínio para servidores do Banco de Dados SQL do Azure.

Tipo:String
Position:13
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-StorageEndpoint

Especifica o ponto de extremidade para acesso ao armazenamento (blob, tabela, fila e arquivo).

Tipo:String
Aliases:StorageEndpointSuffix
Position:4
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-TrafficManagerDnsSuffix

Especifica o sufixo de nome de domínio para os serviços do Azure Traffic Manager.

Tipo:String
Position:12
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Uri

Especifica o URI do recurso da Internet para buscar ambientes.

Tipo:Uri
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

String

SwitchParameter

Saídas

PSAzureEnvironment