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/automation-alert-metric.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Sign in to Azure at https://portal.azure.com
17
17
18
18
Alerts allow you to define a condition to monitor for and an action to take when that condition is met.
19
19
20
-
In the Azure portal, navigate to your Automation Account. Under **Monitoring**, select **Alerts** and click **+ New Alert Rule**. The scope for the target is already defined to your Automation Account.
20
+
In the Azure portal, navigate to your Automation account. Under **Monitoring**, select **Alerts** and click **+ New Alert Rule**. The scope for the target is already defined to your Automation account.
21
21
22
22
### Configure alert criteria
23
23
@@ -71,7 +71,7 @@ Once the metric is no longer outside of the threshold defined, the alert is deac
71
71
72
72
## Next steps
73
73
74
-
Continue to the following article to learn about other ways that you can integrate alertings into your Automation Account.
74
+
Continue to the following article to learn about other ways that you can integrate alertings into your Automation account.
75
75
76
76
> [!div class="nextstepaction"]
77
77
> [Use an alert to trigger an Azure Automation runbook](automation-create-alert-triggered-runbook.md)
Copy file name to clipboardExpand all lines: articles/automation/automation-config-aws-account.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
---
2
-
title: Configure Authentication with Amazon Web Services
2
+
title: Authenticate Azure Automation runbooks with Amazon Web Services
3
3
description: This article describes how to create and validate an AWS credential for runbooks in Azure Automation managing AWS resources.
4
4
keywords: aws authentication, configure aws
5
5
services: automation
6
6
ms.subservice: process-automation
7
7
ms.date: 04/17/2018
8
8
ms.topic: conceptual
9
9
---
10
-
# Authenticate Runbooks with Amazon Web Services
10
+
# Authenticate Azure Automation runbooks with Amazon Web Services
11
11
12
12
Automating common tasks with resources in Amazon Web Services (AWS) can be accomplished with Automation runbooks in Azure. You can automate many tasks in AWS using Automation runbooks just like you can with resources in Azure. All that is required are two things:
Copy file name to clipboardExpand all lines: articles/automation/automation-connections.md
+33-31Lines changed: 33 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,12 +9,15 @@ ms.topic: conceptual
9
9
10
10
# Connection assets in Azure Automation
11
11
12
-
An Automation connection asset contains the information required to connect to an external service or application from a runbook or DSC configuration. This may include information required for authentication such as a username and password in addition to connection information such as a URL or a port. The value of a connection is keeping all of the properties for connecting to a particular application in one asset as opposed to creating multiple variables. The user can edit the values for a connection in one place, and you can pass the name of a connection to a runbook or DSC configuration in a single parameter. The properties for a connection can be accessed in the runbook or DSC configuration with the **Get-AutomationConnection** activity.
12
+
An Automation connection asset contains the information required to connect to an external service or application from a runbook or DSC configuration. This may include information required for authentication such as a username and password in addition to connection information such as a URL or a port. The value of a connection is keeping all of the properties for connecting to a particular application in one asset as opposed to creating multiple variables. The user can edit the values for a connection in one place, and you can pass the name of a connection to a runbook or DSC configuration in a single parameter. The properties for a connection can be accessed in the runbook or DSC configuration with the `Get-AutomationConnection` activity.
13
13
14
-
When you create a connection, you must specify a *connection type*. The connection type is a template that defines a set of properties. The connection defines values for each property defined in its connection type. Connection types are added to Azure Automation in integration modules or created with the [Azure Automation API](/previous-versions/azure/reference/mt163818(v=azure.100)) if the integration module includes a connection type and is imported into your Automation account. Otherwise, you will need to create a metadata file to specify an Automation connection type. For more information regarding this, see [Integration Modules](automation-integration-modules.md).
14
+
When you create a connection, you must specify a *connection type*. The connection type is a template that defines a set of properties. The connection defines values for each property defined in its connection type. Connection types are added to Azure Automation in integration modules or created with the [Azure Automation API](/previous-versions/azure/reference/mt163818(v=azure.100)) if the integration module includes a connection type and is imported into your Automation account. Otherwise, you must create a metadata file to specify an Automation connection type. For more information regarding this, see [Integration Modules](automation-integration-modules.md).
15
15
16
16
>[!NOTE]
17
-
>Secure assets in Azure Automation include credentials, certificates, connections, and encrypted variables. These assets are encrypted and stored in Azure Automation using a unique key that is generated for each automation account. This key is stored in a system managed Key Vault. Before storing a secure asset, the key is loaded from Key Vault and then used to encrypt the asset. This process is managed by Azure Automation.
17
+
>Secure assets in Azure Automation include credentials, certificates, connections, and encrypted variables. These assets are encrypted and stored in Azure Automation using a unique key that is generated for each Automation account. This key is stored in a system managed Key Vault. Before storing a secure asset, the key is loaded from Key Vault and then used to encrypt the asset. This process is managed by Azure Automation.
18
+
19
+
>[!NOTE]
20
+
>This article has been updated to use the new Azure PowerShell Az module. You can still use the AzureRM module, which will continue to receive bug fixes until at least December 2020. To learn more about the new Az module and AzureRM compatibility, see [Introducing the new Azure PowerShell Az module](https://docs.microsoft.com/powershell/azure/new-azureps-module-az?view=azps-3.5.0). For Az module installation instructions on your Hybrid Runbook Worker, see [Install the Azure PowerShell Module](https://docs.microsoft.com/powershell/azure/install-az-ps?view=azps-3.5.0). For your Automation account, you can update your modules to the latest version using [How to update Azure PowerShell modules in Azure Automation](automation-update-azure-modules.md).
18
21
19
22
## Connection types
20
23
@@ -24,95 +27,94 @@ There are three types of built-in connections available in Azure Automation:
24
27
***AzureClassicCertificate** - This connection is used by the **AzureClassicRunAs** account.
25
28
***AzureServicePrincipal** - This connection is used by the **AzureRunAs** account.
26
29
27
-
In most cases, you don't need to create a connection resource because it is created when you create a [RunAs account](manage-runas-account.md).
30
+
In most cases, you don't need to create a connection resource because it is created when you create a [Run As account](manage-runas-account.md).
28
31
29
-
## Windows PowerShell Cmdlets
32
+
## Windows PowerShell cmdlets
30
33
31
34
The cmdlets in the following table are used to create and manage Automation connections with Windows PowerShell. They ship as part of the [Azure PowerShell module](/powershell/azure/overview), which is available for use in Automation runbooks and DSC configurations.
32
35
33
36
|Cmdlet|Description|
34
-
|:---|:---|
35
-
|[Get-AzureRmAutomationConnection](/powershell/module/azurerm.automation/get-azurermautomationconnection)|Retrieves a connection. Includes a hash table with the values of the connection’s fields.|
36
-
|[New-AzureRmAutomationConnection](/powershell/module/azurerm.automation/new-azurermautomationconnection)|Creates a new connection.|
37
-
|[Remove-AzureRmAutomationConnection](/powershell/module/azurerm.automation/remove-azurermautomationconnection)|Remove an existing connection.|
38
-
|[Set-AzureRmAutomationConnectionFieldValue](/powershell/module/azurerm.automation/set-azurermautomationconnectionfieldvalue)|Sets the value of a particular field for an existing connection.|
37
+
|---|---|
38
+
|[Get-AzAutomationConnection](https://docs.microsoft.com/powershell/module/az.automation/get-azautomationconnection?view=azps-3.7.0)|Retrieves a connection. Includes a hashtable with the values of the connection fields.|
39
+
|[New-AzAutomationConnection](https://docs.microsoft.com/powershell/module/az.automation/new-azautomationconnection?view=azps-3.7.0)|Creates a new connection.|
40
+
|[Remove-AzAutomationConnection](https://docs.microsoft.com/powershell/module/Az.Automation/Remove-AzAutomationConnection?view=azps-3.7.0)|Removes an existing connection.|
41
+
|[Set-AzAutomationConnectionFieldValue](https://docs.microsoft.com/powershell/module/Az.Automation/Set-AzAutomationConnectionFieldValue?view=azps-3.7.0)|Sets the value of a particular field for an existing connection.|
39
42
40
43
## Activities
41
44
42
45
The activities in the following table are used to access connections in a runbook or DSC configuration.
43
46
44
47
|Activities|Description|
45
48
|---|---|
46
-
|Get-AutomationConnection | Gets a connection to use. Returns a hash table with the properties of the connection.|
49
+
|`Get-AutomationConnection`| Gets a connection to use. Returns a hashtable with the properties of the connection.|
47
50
48
51
>[!NOTE]
49
-
>You should avoid using variables with the –Name parameter of **Get-AutomationConnection** since this can complicate discovering dependencies between runbooks or DSC configurations, and connection assets at design time.
50
-
52
+
>Avoid using variables with the `Name` parameter of `Get-AutomationConnection`. Use of this parameter can complicate discovery of dependencies between runbooks or DSC configurations, and connection assets at design time.
51
53
52
-
## Python2 functions
54
+
## Python 2 functions
53
55
54
-
The function in the following table is used to access connections in a Python2 runbook.
56
+
The function in the following table is used to access connections in a Python 2 runbook.
55
57
56
58
| Function | Description |
57
59
|:---|:---|
58
-
| automationassets.get_automation_connection | Retrieves a connection. Returns a dictionary with the properties of the connection. |
60
+
|`automationassets.get_automation_connection`| Retrieves a connection. Returns a dictionary with the properties of the connection. |
59
61
60
62
> [!NOTE]
61
-
> You must import the "automationassets" module at the top of your Python runbook in order to access the asset functions.
63
+
> You must import the `automationassets` module at the top of your Python runbook to access the asset functions.
62
64
63
-
## Creating a New Connection
65
+
## Creating a new connection
64
66
65
67
### To create a new connection with the Azure portal
66
68
67
-
1. From your automation account, click the **Assets** part to open the **Assets** blade.
69
+
1. From your Automation account, click the **Assets** part to open the **Assets** blade.
68
70
2. Click the **Connections** part to open the **Connections** blade.
69
71
3. Click **Add a connection** at the top of the blade.
70
72
4. In the **Type** dropdown, select the type of connection you want to create. The form will present the properties for that particular type.
71
73
5. Complete the form and click **Create** to save the new connection.
72
74
73
75
### To create a new connection with Windows PowerShell
74
76
75
-
Create a new connection with Windows PowerShell using the [New-AzureRmAutomationConnection](/powershell/module/azurerm.automation/new-azurermautomationconnection) cmdlet. This cmdlet has a parameter named **ConnectionFieldValues** that expects a [hash table](https://technet.microsoft.com/library/hh847780.aspx) defining values for each of the properties defined by the connection type.
77
+
Create a new connection with Windows PowerShell using the `New-AzAutomationConnection` cmdlet. This cmdlet has a parameter named `ConnectionFieldValues` that expects a [hashtable](https://technet.microsoft.com/library/hh847780.aspx) defining values for each of the properties defined by the connection type.
76
78
77
-
If you are familiar with the Automation [Run As account](automation-sec-configure-azure-runas-account.md) to authenticate runbooks using the service principal, the PowerShell script, provided as an alternative to creating the Run As account from the portal, creates a new connection asset using the following sample commands.
79
+
You can use the following example commands as an alternative to creating the Run As account from the portal to create a new connection asset.
You are able to use the script to create the connection asset because when you create your Automation account, it automatically includes several global modules by default along with the connection type **AzureServicePrincipal** to create the **AzureRunAsConnection** connection asset. This is important to keep in mind, because if you attempt to create a new connection asset to connect to a service or application with a different authentication method, it will fail because the connection type is not already defined in your Automation account. For more information on how to create your own connection type for your custom or module from the [PowerShell Gallery](https://www.powershellgallery.com), see [Integration Modules](automation-integration-modules.md)
87
+
You are able to use the script to create the connection asset because when you create your Automation account, it automatically includes several global modules by default along with the connection type `AzureServicePrincipal` to create the `AzureRunAsConnection` connection asset. This is important to keep in mind, because if you attempt to create a new connection asset to connect to a service or application with a different authentication method, it will fail because the connection type is not already defined in your Automation account. For more information on how to create your own connection type for your custom or module from the [PowerShell Gallery](https://www.powershellgallery.com), see [Integration Modules](automation-integration-modules.md)
86
88
87
89
## Using a connection in a runbook or DSC configuration
88
90
89
-
You retrieve a connection in a runbook or DSC configuration with the **Get-AutomationConnection** cmdlet. You cannot use the [Get-AzureRmAutomationConnection](/powershell/module/azurerm.automation/get-azurermautomationconnection) activity. This activity retrieves the values of the different fields in the connection and returns them as a [hash table](https://go.microsoft.com/fwlink/?LinkID=324844), which can then be used with the appropriate commands in the runbook or DSC configuration.
91
+
Retrieve a connection in a runbook or DSC configuration with the `Get-AutomationConnection` cmdlet. You can't use the `Get-AzAutomationConnection` activity. This activity retrieves the values of the different fields in the connection and returns them as a [hashtable](https://go.microsoft.com/fwlink/?LinkID=324844). This hashtable can then be used with the appropriate commands in the runbook or DSC configuration.
90
92
91
93
### Textual runbook sample
92
94
93
95
The following sample commands show how to use the Run As account mentioned earlier, to authenticate with Azure Resource Manager resources in your runbook. It uses the connection asset representing the Run As account, which references the certificate-based service principal, not credentials.
> **Add-AzureRmAccount** is now an alias for **Connect-AzureRMAccount**. When searching your library items, if you do not see **Connect-AzureRMAccount**, you can use **Add-AzureRmAccount**, or you can update your modules in your Automation Account.
102
+
> [!NOTE]
103
+
> For non-graphical PowerShell runbooks, `Add-AzAccount` and `Add-AzureRMAccount` are aliases for [Connect-AzAccount](https://docs.microsoft.com/powershell/module/az.accounts/connect-azaccount?view=azps-3.5.0). You can use these cmdlets or you can [update your modules](automation-update-azure-modules.md) in your Automation account to the latest versions. You might need to update your modules even if you have just created a new Automation account.
102
104
103
105
### Graphical runbook samples
104
106
105
-
You add a **Get-AutomationConnection** activity to a graphical runbook by right-clicking on the connection in the **Library** pane of the graphical editor and selecting **Add to canvas**.
107
+
You add a `Get-AutomationConnection` activity to a graphical runbook by right-clicking on the connection in the Library pane of the graphical editor and selecting **Add to canvas**.
106
108
107
109
108
110
109
-
The following image shows an example of using a connection in a graphical runbook. This is the same example shown above for authenticating using the Run As account with a textual runbook. This example uses the **Constant value** data set for the **Get RunAs Connection** activity that uses a connection object for authentication. A [pipeline link](automation-graphical-authoring-intro.md#links-and-workflow) is used here since the ServicePrincipalCertificate parameter set is expecting a single object.
111
+
The following image shows an example of using a connection in a graphical runbook. This is the same example shown above for authenticating using the Run As account with a textual runbook. This example uses the `Constant value` data set for the `Get RunAs Connection` activity that uses a connection object for authentication. A [pipeline link](automation-graphical-authoring-intro.md#links-and-workflow) is used here since the `ServicePrincipalCertificate` parameter set is expecting a single object.
0 commit comments