You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/automation/source-control-integration.md
+21-18Lines changed: 21 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Use source control integration in Azure Automation
2
+
title: Use Source Control Integration in Azure Automation
3
3
description: This article tells you how to synchronize Azure Automation source control with other repositories.
4
4
services: automation
5
5
ms.subservice: process-automation
@@ -18,7 +18,8 @@ author: jasminemehndir
18
18
Source control integration lets you easily collaborate with your team, track changes, and roll back to earlier versions of your runbooks. For example, source control allows you to synchronize different branches in source control with your development, test, and production Automation accounts.
19
19
20
20
> [!NOTE]
21
-
> Source control synchronization jobs are run under the user's Automation account and are billed at the same rate as other Automation jobs. Additionally, Azure Automation Jobs do not support MFA (Multi-Factor Authentication).
21
+
> * Source control synchronization jobs are run under the user's Automation account and are billed at the same rate as other Automation jobs. Additionally, Azure Automation Jobs do not support Multi-Factor Authentication (MFA).
22
+
> * Source control integration is supported for PowerShell 5.1 runbooks only.
22
23
23
24
## Source control types
24
25
@@ -41,7 +42,7 @@ Azure Automation supports three types of source control:
41
42
>
42
43
> If you have both a Run As account and managed identity enabled, then managed identity is given preference.
43
44
44
-
> [!Important]
45
+
> [!IMPORTANT]
45
46
> Azure Automation Run As Account has retired on **September 30, 2023**. We recommend that you use [Managed Identities](migrate-run-as-accounts-managed-identity.md).
46
47
47
48
> [!NOTE]
@@ -55,6 +56,8 @@ This section tells how to configure source control for your Automation account.
55
56
56
57
This example uses Azure PowerShell to show how to assign the Contributor role in the subscription to the Azure Automation account resource.
57
58
59
+
To assign managed identity to Contributor role, follow these steps:
60
+
58
61
1. Open a PowerShell console with elevated privileges.
59
62
1. Sign in to Azure by running the command `Connect-AzAccount`.
60
63
1. To assign the managed identity to the **Contributor** role, run the following command.
@@ -68,27 +71,27 @@ This example uses Azure PowerShell to show how to assign the Contributor role in
68
71
69
72
### Configure source control in Azure portal
70
73
71
-
Use this procedure to configure source control using the Azure portal.
74
+
To configure source control using the Azure portal, follow these steps:
72
75
73
-
1. In your Automation account, select **Source Control** and click **Add**.
76
+
1. In your Automation account, select **Source Control** and select **Add**.
2. Choose **Source Control type**, then click **Authenticate**.
80
+
2. Choose **Source Control type**, then select **Authenticate**.
78
81
79
82
3. A browser window opens and prompts you to sign in. Follow the prompts to complete authentication.
80
83
81
-
4. On the Source Control Summary page, use the fields to fill in the source control properties defined below. Click **Save** when finished.
84
+
4. On the **Source Control Summary** page, use the fields to fill in the source control properties defined below. Select **Save** when finished.
82
85
83
86
|Property |Description |
84
87
|---------|---------|
85
88
|Source control name | A friendly name for the source control. This name must contain only letters and numbers. |
86
89
|Source control type | Type of source control mechanism. Available options are:</br> * GitHub</br>* Azure DevOps (Git)</br> * Azure DevOps (TFVC) |
87
-
|Repository | Name of the repository or project. The first 200 repositories are retrieved. To search for a repository, type the name in the field and click **Search on GitHub**.|
90
+
|Repository | Name of the repository or project. The first 200 repositories are retrieved. To search for a repository, type the name in the field and select **Search on GitHub**.|
88
91
|Branch | Branch from which to pull the source files. Branch targeting isn't available for the TFVC source control type. |
89
92
|Folder path | Folder that contains the runbooks to synchronize, for example, **/Runbooks**. Only runbooks in the specified folder are synchronized. Recursion isn't supported. |
90
93
|Auto Sync<sup>1</sup> | Setting that turns on or off automatic synchronization when a commit is made in the source control repository or GitHub repo. |
91
-
|Publish Runbook | Setting of On if runbooks are automatically published after synchronization from source control, and Off otherwise. |
94
+
|Publish Runbook | Setting of On, if runbooks are automatically published after synchronization from source control, and Off otherwise. |
92
95
|Description | Text specifying additional details about the source control. |
93
96
94
97
<sup>1 To enable Auto Sync when configuring the source control integration with Azure DevOps, you must be the Project Administrator or the GitHub repo owner. Collaborators can only configure Source Control without Auto Sync.</sup></br>
@@ -138,7 +141,7 @@ Source control requires some minimum permissions for PATs. The following subsect
138
141
139
142
##### Minimum PAT permissions for GitHub
140
143
141
-
The following table defines the minimum PAT permissions required for GitHub. For more information about creating a PAT in GitHub, see [Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
144
+
The following table defines the minimum PAT permissions required for GitHub. For more information about creating a PAT in GitHub, see [Create a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
142
145
143
146
|Scope |Description |
144
147
|---------|---------|
@@ -169,19 +172,19 @@ The following list defines the minimum PAT permissions required for Azure DevOps
169
172
170
173
## Synchronize with source control
171
174
172
-
Follow these steps to synchronize with source control.
175
+
To synchronize with source control, follow these steps:
173
176
174
-
1. Select the source from the table on the Source control page.
177
+
1. Select the source from the table on the **Source control** page.
175
178
176
-
2.Click**Start Sync** to start the sync process.
179
+
2.Select**Start Sync** to start the sync process.
177
180
178
-
3. View the status of the current sync job or previous ones by clicking the **Sync jobs** tab.
181
+
3. View the status of the current sync job or previous ones by selecting the **Sync jobs** tab.
179
182
180
183
4. On the **Source Control** dropdown menu, select a source control mechanism.
@@ -213,17 +216,17 @@ Follow these steps to synchronize with source control.
213
216
214
217
```
215
218
216
-
6. Additional logging is available by selecting **All Logs** on the Source Control Sync Job Summary page. These additional log entries can help you troubleshoot issues that might arise when using source control.
219
+
6. Additional logging is available by selecting **All Logs** on the **Source Control Sync Job Summary** page. These additional log entries can help you troubleshoot issues that might arise when using source control.
217
220
218
221
## Disconnect source control
219
222
220
-
To disconnect from a source control repository:
223
+
To disconnect from a source control repository, follow these steps:
221
224
222
225
1. Open **Source control** under **Account Settings** in your Automation account.
223
226
224
227
2. Select the source control mechanism to remove.
225
228
226
-
3. On the Source Control Summary page, click **Delete**.
229
+
3. On the **Source Control Summary** page, select **Delete**.
0 commit comments