Set-AzEnvironment
Définit les propriétés d’un environnement Azure.
Syntaxe
Set-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>]
Set-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>]
Description
L’applet de commande Set-AzEnvironment définit des points de terminaison et des métadonnées pour la connexion à une instance d’Azure.
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
ActiveDirectoryServiceEndpointResourceId : TestADApplicationId
AdTenant :
GalleryUrl : TestGalleryEndpoint
ManagementPortalUrl :
ServiceManagementUrl :
PublishSettingsFileUrl :
ResourceManagerUrl : TestRMEndpoint
SqlDatabaseDnsSuffix :
StorageEndpointSuffix :
ActiveDirectoryAuthority : NewTestADEndpoint
GraphUrl : NewTestGraphEndpoint
GraphEndpointResourceId :
TrafficManagerDnsSuffix :
AzureKeyVaultDnsSuffix :
AzureDataLakeStoreFileSystemEndpointSuffix :
AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix :
AzureKeyVaultServiceEndpointResourceId :
BatchEndpointResourceId :
AzureOperationalInsightsEndpoint :
AzureOperationalInsightsEndpointResourceId :
AzureAttestationServiceEndpointSuffix :
AzureAttestationServiceEndpointResourceId :
AzureSynapseAnalyticsEndpointSuffix :
AzureSynapseAnalyticsEndpointResourceId :
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.
Paramètres
-ActiveDirectoryEndpoint
Spécifie l’autorité de base pour l’authentification Azure Active Directory.
Type: | String |
Alias: | AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority |
Position: | 5 |
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’audience des jetons qui authentifient les demandes auprès des points de terminaison RDFE (Azure Resource Manager ou Service Management).
Type: | String |
Position: | 8 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AdTenant
Spécifie le locataire Active Directory par défaut.
Type: | String |
Position: | 17 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-ARMEndpoint
Point de terminaison Azure Resource Manager.
Type: | String |
Alias: | ArmUrl |
Position: | 1 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AzureAnalysisServicesEndpointResourceId
Identificateur de ressource de la ressource Azure Analysis Services.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-AzureAnalysisServicesEndpointSuffix
Point de terminaison à utiliser lors de la communication avec l’API Azure Log Analytique.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-AzureAttestationServiceEndpointResourceId
Identificateur de ressource du service Azure Attestation qui est le destinataire du jeton demandé.
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 |
-AzureAttestationServiceEndpointSuffix
Suffixe DNS du service Azure Attestation.
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 |
-AzureDataLakeAnalyticsCatalogAndJobEndpointSuffix
Suffixe DNS des services de travail et de catalogue Azure Data Lake Analytique
Type: | String |
Position: | 15 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AzureDataLakeStoreFileSystemEndpointSuffix
Suffixe DNS d’Azure Data Lake Store FileSystem. Exemple : azuredatalake.net
Type: | String |
Position: | 14 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AzureKeyVaultDnsSuffix
Suffixe DNS du service Azure Key Vault. Exemple : vault-int.azure-int.net
Type: | String |
Position: | 10 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AzureKeyVaultServiceEndpointResourceId
Identificateur de ressource du service de données Azure Key Vault qui est le destinataire du jeton demandé.
Type: | String |
Position: | 11 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AzureOperationalInsightsEndpoint
Point de terminaison à utiliser lors de la communication avec l’API Azure Log Analytique.
Type: | String |
Position: | 22 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AzureOperationalInsightsEndpointResourceId
Audience des jetons s’authentifiant auprès de l’API Azure Log Analytique.
Type: | String |
Position: | 21 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-AzureSynapseAnalyticsEndpointResourceId
L’identificateur de ressource d’Azure Synapse Analytique qui est le destinataire du jeton demandé.
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 |
-AzureSynapseAnalyticsEndpointSuffix
Suffixe DNS d’Azure Synapse Analytique.
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 |
-BatchEndpointResourceId
Identificateur de ressource du service Azure Batch qui est le destinataire du jeton demandé
Type: | String |
Alias: | BatchResourceId, BatchAudience |
Position: | 20 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-Confirm
Vous demande une confirmation avant d’exécuter l’applet de commande.
Type: | SwitchParameter |
Alias: | cf |
Position: | Named |
Valeur par défaut: | False |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ContainerRegistryEndpointSuffix
Suffixe d’Azure Container Registry.
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 |
-DataLakeAudience
Public pour les jetons s’authentifiant auprès du point de terminaison des services AD Data Lake.
Type: | String |
Alias: | DataLakeEndpointResourceId, DataLakeResourceId |
Position: | 19 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Type: | IAzureContextContainer |
Alias: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-EnableAdfsAuthentication
Indique que l’authentification locale services de fédération Active Directory (AD FS) (ADFS) est autorisée.
Type: | SwitchParameter |
Alias: | OnPremise |
Position: | 16 |
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 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 |
Alias: | Gallery, GalleryUrl |
Position: | 7 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-GraphAudience
Public pour les jetons s’authentifiant avec le point de terminaison AD Graph.
Type: | String |
Alias: | GraphEndpointResourceId, GraphResourceId |
Position: | 18 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-GraphEndpoint
Spécifie l’URL des requêtes Graph (métadonnées Active Directory).
Type: | String |
Alias: | Graph, GraphUrl |
Position: | 9 |
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.
Type: | String |
Position: | 3 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-MicrosoftGraphEndpointResourceId
Identificateur de ressource de Microsoft Graph
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 |
-MicrosoftGraphUrl
Microsoft Graph Url
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 le nom de l’environnement à modifier.
Type: | String |
Position: | 0 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-PublishSettingsFileUrl
Spécifie l’URL à partir de laquelle les fichiers .publishsettings peuvent être téléchargés.
Type: | String |
Position: | 1 |
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 l’URL des requêtes Azure Resource Manager.
Type: | String |
Alias: | ResourceManager, ResourceManagerUrl |
Position: | 6 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | 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 |
Valeurs acceptées: | Process, CurrentUser |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ServiceEndpoint
Spécifie le point de terminaison des requêtes RDFE (Service Management).
Type: | String |
Alias: | ServiceManagement, ServiceManagementUrl |
Position: | 2 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | False |
-SqlDatabaseDnsSuffix
Spécifie le suffixe de nom de domaine pour les serveurs Azure SQL Database.
Type: | String |
Position: | 13 |
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 pour l’accès au stockage (blob, table, file d’attente et fichier).
Type: | String |
Alias: | StorageEndpointSuffix |
Position: | 4 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-TrafficManagerDnsSuffix
Spécifie le suffixe de nom de domaine pour les services Azure Traffic Manager.
Type: | String |
Position: | 12 |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | True |
Accepter les caractères génériques: | 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 |
Alias: | wi |
Position: | Named |
Valeur par défaut: | False |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |