Add-AzEnvironment

Module:

Az.Accounts

Ajoute des points de terminaison et des métadonnées pour une instance d’Azure Resource Manager.

Syntax

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

L’applet de commande Add-AzEnvironment ajoute des points de terminaison et des métadonnées pour permettre aux applets de commande Azure Resource Manager de se connecter à une nouvelle instance d’Azure Resource Manager. Les environnements intégrés AzureCloud et AzureChinaCloud ciblent des instances publiques existantes d’Azure Resource Manager.

Exemples

Exemple 1 : Création et modification d’un nouvel environnement

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                           :

Dans cet exemple, nous créons un environnement Azure avec des exemples de points de terminaison à l’aide de Add-AzEnvironment, puis nous modifions la valeur des attributs ActiveDirectoryEndpoint et GraphEndpoint de l’environnement créé à l’aide de l’applet de commande Set-AzEnvironment.

Exemple 2 : Découverte d’un nouvel environnement 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/

Dans cet exemple, nous découvrons un nouvel environnement Azure à partir de l’URI https://configuredmetadata.net .

Paramètres

-ActiveDirectoryEndpoint

Spécifie l’autorité de base pour l’authentification Azure Active Directory.

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

-ActiveDirectoryServiceEndpointResourceId

Spécifie l’audience des jetons qui authentifient les demandes auprès des points de terminaison RDFE (Azure Resource Manager ou Service Management).

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

-AdTenant

Spécifie le locataire Active Directory par défaut.

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

-ARMEndpoint

Point de terminaison Azure Resource Manager

Type:	String
Aliases:	ArmUrl
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-AutoDiscover

Découvre les environnements via un point de terminaison par défaut ou configuré.

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

-AzureAnalysisServicesEndpointResourceId

Identificateur de ressource de la ressource Azure Analysis Services.

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

-AzureAnalysisServicesEndpointSuffix

Point de terminaison à utiliser lors de la communication avec l’API Azure Log Analytics.

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

-AzureAttestationServiceEndpointResourceId

Identificateur de ressource du service Azure Attestation qui est le destinataire du jeton demandé.

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

-AzureAttestationServiceEndpointSuffix

Suffixe DNS du service Azure Attestation.

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

-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix

Suffixe DNS des services de travail et de catalogue Azure Data Lake Analytics

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

-AzureDataLakeStoreFileSystemEndpointSuffix

Suffixe DNS d’Azure Data Lake Store FileSystem. Exemple : azuredatalake.net

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

-AzureKeyVaultDnsSuffix

Suffixe DNS du service Azure Key Vault. Exemple : vault-int.azure-int.net

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

-AzureKeyVaultServiceEndpointResourceId

Identificateur de ressource du service de données Azure Key Vault qui est le destinataire du jeton demandé.

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

-AzureOperationalInsightsEndpoint

Point de terminaison à utiliser lors de la communication avec l’API Azure Log Analytics.

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

-AzureOperationalInsightsEndpointResourceId

Audience des jetons qui s’authentifient avec l’API Azure Log Analytics.

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

-AzureSynapseAnalyticsEndpointResourceId

Identificateur de ressource d’Azure Synapse Analytics qui est le destinataire du jeton demandé.

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

-AzureSynapseAnalyticsEndpointSuffix

Suffixe DNS d’Azure Synapse Analytics.

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

-BatchEndpointResourceId

Identificateur de ressource du service Azure Batch qui est le destinataire du jeton demandé

Type:	String
Aliases:	BatchResourceId, BatchAudience
Position:	20
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContainerRegistryEndpointSuffix

Suffixe d’Azure Container Registry.

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

-DataLakeAudience

Public pour les jetons s’authentifiant auprès du point de terminaison des services AD Data Lake.

Type:	String
Aliases:	DataLakeEndpointResourceId, DataLakeResourceId
Position:	19
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

Informations d’identification, locataire et abonnement utilisés pour la communication avec Azure

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableAdfsAuthentication

Indique que l’authentification locale services de fédération Active Directory (AD FS) (ADFS) est autorisée.

Type:	SwitchParameter
Aliases:	OnPremise
Position:	16
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-GalleryEndpoint

Spécifie le point de terminaison de la galerie Azure Resource Manager de modèles de déploiement. Le paramètre doit définir la valeur GalleryUrl sur PSAzureEnvironment. Comme GalleryUrl il est supprimé d’ArmMetadata, Azure PowerShell ne fournit plus la valeur et il n’est donc plus recommandé de définir GalleryEndpoint .

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

-GraphAudience

Public pour les jetons s’authentifiant avec le point de terminaison AD Graph.

Type:	String
Aliases:	GraphEndpointResourceId, GraphResourceId
Position:	18
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-GraphEndpoint

Spécifie l’URL des requêtes Graph (métadonnées Active Directory).

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

-ManagementPortalUrl

Spécifie l’URL du Portail de gestion.

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

-MicrosoftGraphEndpointResourceId

Identificateur de ressource de Microsoft Graph

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

-MicrosoftGraphUrl

Microsoft Graph Url

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

-Name

Spécifie le nom de l’environnement à ajouter.

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

-PublishSettingsFileUrl

Spécifie l’URL à partir de laquelle les fichiers .publishsettings peuvent être téléchargés.

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

-ResourceManagerEndpoint

Spécifie l’URL des requêtes Azure Resource Manager.

Type:	String
Aliases:	ResourceManager, ResourceManagerUrl
Position:	6
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Scope

Détermine l’étendue des modifications de contexte, par exemple, si les modifications s’appliquent uniquement au processus actuel ou à toutes les sessions démarrées par cet utilisateur.

Type:	ContextModificationScope
Accepted values:	Process, CurrentUser
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ServiceEndpoint

Spécifie le point de terminaison des requêtes RDFE (Service Management).

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

-SqlDatabaseDnsSuffix

Spécifie le suffixe de nom de domaine pour les serveurs Azure SQL Database.

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

-StorageEndpoint

Spécifie le point de terminaison pour l’accès au stockage (blob, table, file d’attente et fichier).

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

-TrafficManagerDnsSuffix

Spécifie le suffixe de nom de domaine pour les services Azure Traffic Manager.

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

-Uri

Spécifie l’URI de la ressource Internet pour extraire des environnements.

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

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entrées

String

SwitchParameter

Sorties

PSAzureEnvironment

Liens associés

• Get-AzEnvironment
• Remove-AzEnvironment
• Set-AzEnvironment