Add-AzureEnvironment
Crée un environnement Azure.
Remarque
Les applets de commande référencées dans cette documentation concernent la gestion des ressources Azure héritées qui utilisent les API Azure Service Manager (ASM). Ce module PowerShell hérité n’est pas recommandé lors de la création de ressources, car ASM est planifié pour la mise hors service. Pour plus d’informations, consultez la mise hors service d’Azure Service Manager.
Le module Az PowerShell est le module PowerShell recommandé pour la gestion des ressources Azure Resource Manager (ARM) avec PowerShell.
Syntaxe
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
L’applet de commande Add-AzureEnvironment crée un environnement de compte Azure personnalisé et l’enregistre dans votre profil utilisateur itinérant. L’applet de commande retourne un objet qui représente le nouvel environnement. Une fois la commande terminée, vous pouvez utiliser l’environnement dans Windows PowerShell.
Un environnement Azure un déploiement indépendant de Microsoft Azure, tel qu’AzureCloud pour Azure global et AzureChinaCloud pour Azure géré par 21Vianet en Chine. Vous pouvez également créer des environnements Azure locaux à l’aide d’Azure Pack et des applets de commande WAPack. Pour plus d’informations, consultez Azure Pack.
Seul le paramètre Name de cette applet de commande est obligatoire. Si vous omettez un paramètre, sa valeur est Null ($Null) et le service qui utilise ce point de terminaison peut ne pas fonctionner correctement. Pour ajouter ou modifier la valeur d’une propriété d’environnement, utilisez l’applet de commande Set-AzureEnvironment .
REMARQUE : la modification de votre environnement peut entraîner l’échec de votre compte. En règle générale, les environnements sont ajoutés uniquement pour les tests ou la résolution des problèmes.
Cette rubrique décrit l’applet de commande dans la version 0.8.10 du module Microsoft Azure PowerShell.
Pour obtenir la version du module que vous utilisez, dans la console Azure PowerShell, tapez (Get-Module -Name Azure).Version
.
Exemples
Exemple 1 : Ajouter un environnement 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 :
Cette commande crée l’environnement Azure ContosoEnv.
Paramètres
-ActiveDirectoryEndpoint
Spécifie le point de terminaison de l’authentification Microsoft Entra dans le nouvel environnement.
Type: | String |
Alias: | AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ActiveDirectoryServiceEndpointResourceId
Spécifie l’ID de ressource d’une API de gestion dont l’accès est géré par l’ID Microsoft Entra.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AdTenant
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AzureKeyVaultDnsSuffix
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AzureKeyVaultServiceEndpointResourceId
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-EnableAdfsAuthentication
Type: | SwitchParameter |
Alias: | OnPremise |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-GalleryEndpoint
Spécifie le point de terminaison de la galerie Azure Resource Manager, qui stocke les modèles de galerie de groupes de ressources. Pour plus d’informations sur les groupes de ressources Azure et les modèles de galerie, consultez la rubrique d’aide pour Get-AzureResourceGroupGalleryTemplatehttps://go.microsoft.com/fwlink/?LinkID=393052.
Type: | String |
Alias: | Gallery, GalleryUrl |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-GraphEndpoint
Type: | String |
Alias: | Graph, GraphUrl |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ManagementPortalUrl
Spécifie l’URL du portail de gestion Azure dans le nouvel environnement.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Name
Spécifie un nom pour l’environnement. Ce paramètre est obligatoire. N’utilisez pas les noms des environnements par défaut, AzureCloud et AzureChinaCloud.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Profile
Spécifie le profil Azure à partir duquel cette applet de commande lit. Si vous ne spécifiez pas de profil, cette applet de commande lit le profil par défaut local.
Type: | AzureSMProfile |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-PublishSettingsFileUrl
Spécifie l’URL des fichiers de paramètres de publication pour votre compte. Un fichier de paramètres de publication Azure est un fichier XML qui contient des informations sur votre compte et un certificat de gestion qui permet à Windows PowerShell de se connecter à votre compte Azure en votre nom.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ResourceManagerEndpoint
Spécifie le point de terminaison pour les données Azure Resource Manager, y compris les données relatives aux groupes de ressources associés au compte. Pour plus d’informations sur Azure Resource Manager, consultez applets de commande Azure Resource Manager (https://go.microsoft.com/fwlink/?LinkID=394765) et utilisation de Windows PowerShell avec Resource Manager (https://go.microsoft.com/fwlink/?LinkID=394767).
Type: | String |
Alias: | ResourceManager, ResourceManagerUrl |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ServiceEndpoint
Spécifie l’URL du point de terminaison de service Azure. Le point de terminaison de service Azure détermine si votre application est gérée par la plateforme Azure mondiale, Azure géré par 21Vianet en Chine ou une installation Azure privée.
Type: | String |
Alias: | ServiceManagement, ServiceManagementUrl |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-SqlDatabaseDnsSuffix
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-StorageEndpoint
Spécifie le point de terminaison par défaut des services de stockage dans le nouvel environnement.
Type: | String |
Alias: | StorageEndpointSuffix |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-TrafficManagerDnsSuffix
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
Entrées
None
Vous pouvez diriger l’entrée vers cette applet de commande par nom de propriété, mais pas par valeur.
Sorties
Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment