Partager via


Set-AzureEnvironment

Modifie les propriétés d’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

Set-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 Set-AzureEnvironment modifie les propriétés d’un environnement Azure. Elle retourne un objet qui représente l’environnement avec ses nouvelles valeurs de propriété. Utilisez le paramètre Name pour identifier l’environnement et les autres paramètres pour modifier les valeurs de propriété. Vous ne pouvez pas utiliser Set-AzureEnvironment pour modifier le nom d’un environnement Azure.

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.

REMARQUE : ne modifiez pas les propriétés des environnements AzureCloud ou AzureChinaCloud. Utilisez cette applet de commande pour modifier les valeurs des environnements privés que vous créez.

Exemples

Exemple 1 : Modifier les propriétés d’environnement

PS C:\> Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com"

Cette commande modifie les valeurs des propriétés PublishSettingsFileUrl et StorageEndpoint de l’environnement ContosoEnv.

Paramètres

-ActiveDirectoryEndpoint

Remplace le point de terminaison de l’authentification Microsoft Entra par la valeur spécifiée.

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

Remplace le point de terminaison de la galerie Azure Resource Manager par la valeur spécifiée. Le point de terminaison de la galerie est l’emplacement des 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-AzureResourceGroupGalleryTemplate.

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

Remplace l’URL du portail de gestion Azure par la valeur spécifiée.

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

Identifie l’environnement en cours de modification. Ce paramètre est obligatoire. La valeur du paramètre respecte la casse. Les caractères génériques ne sont pas autorisés.

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

Modifie l’URL des fichiers de paramètres de publication dans l’environnement spécifié. 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

Modifie 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

Modifie l’URL du point de terminaison de service Azure dans l’environnement spécifié. 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

Modifie le point de terminaison par défaut des services de stockage dans l’environnement spécifié.

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