Utiliser les applets de commande PowerShell pour que les outils XRM se connectent à Microsoft Dataverse

Les outils XRM vous fournissent les applets de commande Windows PowerShell suivants que vous pouvez utiliser pour vous connecter à Dataverse et récupérer les organisations auxquelles l’utilisateur actuel a accès : Get-CrmConnection et Get-CrmOrganizations.

Configuration requise

  • Pour utiliser les applets de commande des outils XRM, vous avez besoin de la version 3.0 ou ultérieure de PowerShell. Pour vérifier la version, ouvrez une fenêtre PowerShell et exécutez la commande suivante : $Host

  • Définissez la stratégie d’exécution pour exécuter les scripts PowerShell signés. Pour cela, ouvrez une fenêtre PowerShell en tant qu’administrateur, puis exécutez la commande suivante : Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

Acheter l’applet de commande Microsoft.Xrm.Tooling.CrmConnector.PowerShell

Avant de pouvoir utiliser l’applet de commande Microsoft.Xrm.Tooling.CrmConnector.PowerShell, vous devez l’installer. L’applet de commande PowerShell des outils XRM est disponible dans la galerie PowerShell ici. Pour télécharger et installer l’applet de commande

Ouvrez PowerShell ou PowerShell ISE en mode administrateur, puis exécutez la commande suivante :

Install-Module -Name Microsoft.Xrm.Tooling.CrmConnector.PowerShell

Si vous avez installé le module dans le passé, vous pouvez le mettre à jour avec la commande suivante :

Update-Module -Name Microsoft.Xrm.Tooling.CrmConnector.PowerShell

Vous pouvez à présent utiliser l’applet de commande Microsoft.Xrm.Tooling.CrmConnector.PowerShell. Pour répertorier les fonctions que vous avez enregistrés, exécutez la commande suivante dans la fenêtre PowerShell :

Get-Help “Crm”  

Utilisez l’applet de commande pour récupérer des organisations auprès de Dataverse

Utilisez l’applet de commande Get-CrmOrganizations pour récupérer les organisations auxquelles vous avez accès.

  1. Fournissez vos informations d’identification pour vous connecter à votre instance Dataverse. La commande suivante vous invite à entrer votre nom d’utilisateur et votre mot de passe pour vous connecter à l’instance Dataverse ; ces informations seront stockées dans la variable $Cred.

    $Cred = Get-Credential  
    
  2. Utilisez la commande suivante pour récupérer vos organisations et stockez les informations dans la variable $CRMOrgs

    • Si vous vous connectez à une instance Dataverse :

      $CRMOrgs = Get-CrmOrganizations -Credential $Cred -DeploymentRegion NorthAmerica –OnlineType Office365  
      

      Notes

      Pour le paramètre DeploymentRegion, les valeurs valides sont : NorthAmerica, EMEA, APAC, SouthAmerica, Oceania, JPN, CAN, IND et NorthAmerica2. Pour le paramètre OnlineType, spécifiez Office365.

  3. Les informations d’identification fournies sont validées lorsque vous exécutez la commande à l’étape 2. Une fois que l’exécution de la commande s’est déroulée correctement, tapez la commande suivante et appuyez sur ENTRÉE pour afficher les organisations auxquelles vous avez accès :

    $CRMOrgs  
    

    Informations sur l’organisation Dataverse.

Conseil

Vous pouvez utiliser la variable utilisée pour stocker les organisations Dataverse récupérées (ici $CRMOrgs) avec l’applet de commande Get-CrmConnection pour vous connecter à Dataverse. Pour spécifier le nom de l’organisation, utilisez la commande suivante : $CRMOrgs.UniqueName.

S’il y a plus d’une valeur d’organisation stockée dans la variable $CRMOrgs, vous pouvez faire référence à l’organisation nth en utilisant la commande suivante : $CRMOrgs[n-1]. Par exemple, pour faire référence au nom unique de la deuxième organisation de la variable $CRMOrgs, utilisez la commande suivante : $CRMOrgs[1].UniqueName.

Utiliser l’applet de commande pour se connecter à Dataverse

Utilisez l’applet de commande Get-CrmConnection pour vous connecter à une instance Dataverse. L’applet de commande vous permet d’utiliser le contrôle commun de connexion des outils XRM pour spécifier les informations d’identification et pour vous connecter à Dataverse ou vous permet de spécifier les informations d’identification comme paramètres inclus. Pour plus d’informations, voir : Utiliser le contrôle commun de connexion des outils XRM

Important

Avant d’utiliser l’applet de commande Get-CrmConnection, assurez-vous d’utiliser la commande suivante de appliquer l’utilisation de TLS 1.2 par PowerShell pour vous connecter à votre instance Dataverse
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12
Pour plus d’informations sur la configuration requise de TLS 1.2 pour la connexion à Dataverse Billet de blog : Mises à jour à venir pour la sécurité de connexion à Dataverse

Se connecter à Dataverse à l’aide du contrôle commun de connexion

  1. Si vous souhaitez utiliser le contrôle de connexion commun pour fournir vos informations d’identification et vous connecter à Dataverse, utilisez la commande suivante. Les informations de connexion sont stockées dans la variable $CRMConn afin que vous puissiez les utiliser ultérieurement.

    $CRMConn = Get-CrmConnection -InteractiveMode  
    
  2. La boîte de dialogue Contrôle de connexion apparaît. Fournissez vos informations d’identification pour vous connecter à votre instance Dataverse, puis cliquez sur Connexion.

Se connecter aux applications Dataverse en spécifiant les informations d’identification incluses

  1. Pour vous connecter à Dataverse, utilisez les commandes suivantes. Notez que ces commandes utilisent la variable $Cred créée précédemment pour stocker les informations d’authentification lors de la récupération des organisations. Les informations de connexion sont stockées dans la variable $CRMConn :

    • Si vous vous connectez à une instance Dataverse

      $CRMConn = Get-CrmConnection -Credential $Cred -DeploymentRegion <Deployment region name> –OnlineType Office365 –OrganizationName <OrgName>  
      

      Notes

      Pour le paramètre DeploymentRegion, les valeurs valides sont : NorthAmerica, EMEA, APAC, SouthAmerica, Oceania, JPN, CAN, IND et NorthAmerica2. Pour le paramètre OnlineType, spécifiez Office365.

      Notes

      Pour le paramètre OrganizationName de toutes les commandes précédentes, vous pouvez spécifier le nom unique ou le nom convivial de l’organisation. Vous pouvez également utiliser le nom unique ou le nom convivial que vous avez récupéré avec l’applet de commande Get-CrmOrganizations et stocké dans la variable $CRMOrgs. Par exemple, vous pouvez utiliser $CRMOrgs[x].UniqueName ou $CRMOrgs[x].FriendlyName.

  2. Les informations d’identification fournies sont validées lorsque vous exécutez la commande à l’étape 1. Une fois que l’exécution de l’applet de commande s’est déroulée correctement, tapez la commande suivante et appuyez sur ENTRÉE pour afficher les organisations auxquelles vous avez accès :

     $CRMConn  
    

    Informations de connexion Dataverse et statut.

Se connecter à Dataverse à l’aide d’OAuth

L’authentification OAuth est utilisée en interne par les outils XRM lorsque vous spécifiez le paramètre -InteractiveMode.

$CRMConn = Get-CrmConnection -InteractiveMode  

L’authentification OAuth peut également être spécifiée lors de l’utilisation d’une chaîne de connexion où AuthType=OAuth ou AuthType=ClientSecret.

$CRMConn = Get-CrmConnection -ConnectionString "AuthType=ClientSecret;ClientId=..."

Pour plus d’informations : Utiliser les chaînes de connexion des outils XRM pour se connecter à Microsoft Dataverse

Voir aussi

Utiliser l‘API des outils XRM pour se connecter à Dataverse
Créer des applications clientes Windows à l’aide des outils XRM
Blog : module PowerShell pour effectuer des opérations de données et gérer l’utilisateur et les paramètres système dans Dataverse

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).