Utiliser l’intégration du contrôle de code source

L’intégration du contrôle de code source à Azure Automation vous permet d’effectuer des synchronisations unidirectionnelles à partir de votre dépôt de contrôle de code source. Le contrôle des sources vous permet de tenir à jour vos runbooks dans votre compte Automation avec les scripts de votre dépôt de contrôle des sources GitHub ou Azure DevOps. Cette fonctionnalité simplifie la promotion du code qui a été testé dans votre environnement de développement dans votre compte Automation de production.

L’intégration du contrôle de code source vous permet de facilement collaborer avec votre équipe, suivre les modifications et restaurer des versions antérieures de vos runbooks. Par exemple, le contrôle de code source vous permet de synchroniser différentes branches dans le contrôle de code source avec vos comptes Automation de développement, de test et de production.

Types de contrôle de code source

Azure Automation prend en charge trois types de contrôles de code source :

• GitHub
• Azure DevOps (Git)
• Azure DevOps (TFVC)

Prérequis

• Un référentiel de contrôle de code source (GitHub ou Azure DevOps)
• Le compte Automation requiert l’attribution d’une identité géréepar le système ou par l’utilisateur. Si vous n'avez pas configuré d'identité gérée avec votre compte d'automatisation, voir Activer l'identité gérée attribuée par le système ou activer l'identité gérée attribuée par l'utilisateur pour la créer.
• Affectez l’identité managée affectée par le système au rôle Contributeur dans le compte Automation.

Configuration du contrôle de code source

Cette section explique comment configurer le contrôle de code source pour votre compte Automation. Vous pouvez utiliser le portail Azure ou PowerShell.

Affecter une identité managée au rôle contributeur

Cet exemple utilise Azure PowerShell pour montrer comment attribuer le rôle Contributeur dans l’abonnement à la ressource du compte Azure Automation.

Pour affecter une identité managée au rôle Contributeur, procédez comme suit :

1. Ouvrez une console PowerShell avec des privilèges élevés.

2. Connectez-vous à Azure en exécutant la commande Connect-AzAccount.

3. Pour affecter l’identité managée au rôle Contributeur, exécutez la commande suivante.

   New-AzRoleAssignment `
       -ObjectId <automation-Identity-Object(Principal)-Id> `
       -Scope "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}" `
       -RoleDefinitionName "Contributor"
   

Configurer le contrôle de code source dans le portail Azure

Pour configurer le contrôle de code source à l’aide du portail Azure, procédez comme suit :

1. Dans votre compte Automation, sélectionnez Contrôle de code source , puis Ajouter.

   

2. Choisissez le type de contrôle de code source, puis sélectionnez Authentifier.

3. Une fenêtre de navigateur s’ouvre et vous invite à vous connecter. Suivez les invites pour effectuer l’authentification.

4. Dans la page Résumé du contrôle de code source, utilisez les champs pour renseigner les propriétés du contrôle de code source définies ci-dessous. Sélectionnez Enregistrer lorsque vous avez terminé.

   Propriété	Descriptif
   Nom du contrôle de code source	Nom convivial du contrôle de code source. Ce nom ne doit contenir que des lettres et des chiffres.
   Type de contrôle de code source	Type de mécanisme de contrôle de code source. Les options disponibles sont les suivantes : * GitHub * Azure DevOps (Git) * Azure DevOps (TFVC)
   Référentiel	Nom du dépôt ou du projet. Les 200 premiers dépôts sont retournés. Pour rechercher un référentiel, tapez le nom dans le champ et sélectionnez Rechercher sur GitHub.
   Branche	Branche à partir de laquelle extraire les fichiers sources. Le ciblage de branche n’est pas disponible pour le contrôle de code source de type TFVC.
   Chemin d’accès du dossier	Dossier qui contient les runbooks à synchroniser, par exemple, /Runbooks. Seuls les runbooks inclus dans le dossier spécifié sont synchronisés. La récursivité n’est pas prise en charge.
   Synchronisation automatique1	Paramètre qui active ou désactive la synchronisation automatique lorsqu'une validation est effectuée dans le référentiel de contrôle de code source ou le dépôt GitHub.
   Publier un runbook	Paramètre activé, si les runbooks sont automatiquement publiés après la synchronisation à partir du contrôle de code source, sinon désactivé.
   Descriptif	Texte spécifiant des détails supplémentaires sur le contrôle de code source.

   ^{1 Pour activer la synchronisation automatique lors de la configuration de l'intégration du contrôle de code source avec Azure DevOps, vous devez être l'administrateur du projet ou le propriétaire du dépôt GitHub. Les collaborateurs peuvent uniquement configurer le contrôle de source sans synchronisation automatique.}
   La synchronisation automatique ne fonctionne pas avec Automation Private Link. Si vous activez le Private Link, les appels de webhook de contrôle de code source échouent car il se trouve en dehors du réseau.

   

Configurer le contrôle de code source dans PowerShell

Vous pouvez également utiliser PowerShell pour configurer le contrôle de code source dans Azure Automation. Pour utiliser des applets de commande PowerShell pour cette opération, vous avez besoin d’un jeton d’accès personnel (PAT). Pour créer la connexion de contrôle de code source, utilisez l’applet de commande New-AzAutomationSourceControl. Cette applet de commande exige une chaîne sécurisée pour le PAT. Pour savoir comment créer une chaîne sécurisée, consultez ConvertTo-SecureString.

Les sous-sections suivantes illustrent la création par PowerShell de la connexion de contrôle de code source pour GitHub, Azure Repos (Git) et Azure Repos (TFVC).

Créer une connexion de contrôle de code source pour GitHub

New-AzAutomationSourceControl -Name SCGitHub -RepoUrl https://github.com/<accountname>/<reponame>.git -SourceType GitHub -FolderPath "/MyRunbooks" -Branch main -AccessToken <secureStringofPAT> -ResourceGroupName <ResourceGroupName> -AutomationAccountName <AutomationAccountName>

Créer une connexion de contrôle de code source pour Azure DevOps (Git)

New-AzAutomationSourceControl -Name SCReposGit -RepoUrl https://dev.azure.com/<accountname>/<adoprojectname>/_git/<repositoryname> -SourceType VsoGit -AccessToken <secureStringofPAT> -Branch main -ResourceGroupName <ResourceGroupName> -AutomationAccountName <AutomationAccountName> -FolderPath "/Runbooks"

Créer une connexion de contrôle de code source pour Azure DevOps (TFVC)

New-AzAutomationSourceControl -Name SCReposTFVC -RepoUrl https://dev.azure.com/<accountname>/<adoprojectname>/_git/<repositoryname> -SourceType VsoTfvc -AccessToken <secureStringofPAT> -ResourceGroupName <ResourceGroupName> -AutomationAccountName <AutomationAccountName> -FolderPath "/Runbooks"

Autorisations de jeton d’accès personnel (PAT)

Le contrôle de code source exige des autorisations minimales pour les PAT. Les sous-sections suivantes indiquent les autorisations minimales nécessaires pour accéder à GitHub et à Azure DevOps.

Autorisations PAT minimales pour GitHub

Le tableau suivant définit les autorisations PAT minimales nécessaires pour GitHub. Pour plus d’informations sur la création d’un jeton d’accès personnel dans GitHub, consultez Créer un jeton d’accès personnel pour la ligne de commande.

Autorisations PAT minimales pour Azure DevOps

La liste suivante définit les autorisations PAT minimales nécessaires pour Azure DevOps. Pour plus d’informations sur la création d’un PAT dans Azure DevOps, consultez Authentifier l’accès à l’aide de jetons d’accès personnels.

¹ L’autorisation Service connections est uniquement nécessaire si vous avez activé la synchronisation automatique.

Synchroniser avec le contrôle de code source

Pour synchroniser avec le contrôle de code source, procédez comme suit :

1. Sélectionnez la source dans la table de la page contrôle de code source .

2. Sélectionnez Démarrer la synchronisation pour démarrer le processus de synchronisation.

3. Affichez l’état du travail de synchronisation actuel ou des travaux précédents en sélectionnant l’onglet Tâches de synchronisation.

4. Dans le menu déroulant Contrôle de code source, sélectionnez un mécanisme de contrôle de code source.

   

5. La sélection d’un travail vous permet d’afficher le résultat du travail. L’exemple suivant présente la sortie d’un travail de synchronisation du contrôle de code source.

   ===================================================================
   
   Azure Automation Source Control.
   Supported runbooks to sync: PowerShell Workflow, PowerShell Scripts, DSC Configurations, Graphical, and Python 2.
   
   Setting AzEnvironment.
   
   Getting AzureRunAsConnection.
   
   Logging in to Azure...
   
   Source control information for syncing:
   
   [Url = https://ContosoExample.visualstudio.com/ContosoFinanceTFVCExample/_versionControl] [FolderPath = /Runbooks]
   
   Verifying url: https://ContosoExample.visualstudio.com/ContosoFinanceTFVCExample/_versionControl
   
   Connecting to VSTS...
   
   Source Control Sync Summary:
   
   2 files synced:
    - ExampleRunbook1.ps1
    - ExampleRunbook2.ps1
   
   ==================================================================
   
   

6. Une journalisation supplémentaire est disponible en sélectionnant tous les journaux dans la page Résumé du travail de synchronisation du contrôle de code source . Ces entrées de journal supplémentaires peuvent vous aider à résoudre les problèmes qui peuvent survenir lorsque vous utilisez le contrôle de code source.

Déconnecter le contrôle de code source

Pour vous déconnecter d’un référentiel de contrôle de code source, procédez comme suit :

1. Ouvrez Contrôle de code source sous Paramètres du compte dans votre compte Automation.

2. Sélectionnez le mécanisme de contrôle de code source à supprimer.

3. Dans la page Résumé du contrôle de code source , sélectionnez Supprimer.

Gérer les problèmes d’encodage

Si plusieurs personnes modifient des runbooks dans votre dépôt de contrôle de code source à l’aide de différents éditeurs, des problèmes d’encodage peuvent se produire. Pour plus d’informations sur cette situation, consultez Causes courantes des problèmes d’encodage.

Mettre à jour le jeton d’accès personnel (PAT, Personal Access Token)

Actuellement, vous ne pouvez pas utiliser le portail Azure pour mettre à jour le PAT dans le contrôle de code source. Lorsque votre PAT a expiré ou a été révoqué, vous pouvez mettre à jour le contrôle de code source avec un nouveau jeton d’accès de l’une des manières suivantes :

• Utilisez l’API REST.
• Utilisez l’applet de commande Update-AzAutomationSourceControl.

Étapes suivantes

• Pour intégrer le contrôle de source Runbook à Visual Studio Codespaces, consultez Azure Automation : Intégration du contrôle de source Runbook à l'aide de Visual Studio Codespaces.