Skip to content

Commit 880deee

Browse files
committed
Fixing typos
1 parent 16dd9e8 commit 880deee

File tree

5 files changed

+25
-25
lines changed

5 files changed

+25
-25
lines changed

articles/automation/automation-connections.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.topic: conceptual
99

1010
# Manage connections in Azure Automation
1111

12-
An Azure Automation connection asset contains the information listed below. This information is required for connection to an external service or application from a runbook or DSC configuration:
12+
An Azure Automation connection asset contains the information listed below. This information is required for connection to an external service or application from a runbook or DSC configuration.
1313

1414
* Information needed for authentication, such as user name and password
1515
* Connection information, such as URL or port
@@ -138,7 +138,7 @@ You add a `Get-AutomationConnection` activity to a graphical runbook by right-cl
138138

139139
![add to canvas](media/automation-connections/connection-add-canvas.png)
140140

141-
The following image shows an example of using a connection in a graphical runbook. This is the same example as 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.
141+
The following image shows an example of using a connection in a graphical 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.
142142

143143
![get connections](media/automation-connections/automation-get-connection-object.png)
144144

articles/automation/shared-resources/certificates.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ manager: carmonm
1313

1414
# Manage certificates in Azure Automation
1515

16-
Certificates are stored securely in Azure Automation so they can be accessed by runbooks or DSC configurations using the [Get-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Get-AzAutomationCertificate?view=azps-3.7.0) cmdlet for Azure Resource Manager resources. Secure certificate storage allows you to create runbooks and DSC configurations that use certificates for authentication or add them to Azure or third-party resources.
16+
Certificates are stored securely in Azure Automation for access by runbooks and DSC configurations using the [Get-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Get-AzAutomationCertificate?view=azps-3.7.0) cmdlet for Azure Resource Manager resources. Secure certificate storage allows you to create runbooks and DSC configurations that use certificates for authentication or add them to Azure or third-party resources.
1717

1818
>[!NOTE]
1919
>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. Azure Automation stores the key in the system-managed Key Vault. Before storing a secure asset, Automation loads the key from Key Vault and then uses it to encrypt the asset.
@@ -28,7 +28,7 @@ For Az, the cmdlets in the following table are used to create and manage automat
2828
|Cmdlet |Description|
2929
| --- | ---|
3030
|[Add-AzureCertificate](/powershell/module/servicemanagement/azure/add-azurecertificate)|Uploads a service certificate for the specified cloud service.|
31-
|[Get-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Get-AzAutomationCertificate?view=azps-3.7.0)|Retrieves information about a certificate to use in a runbook or DSC configuration. You can only retrieve the certificate itself using the `Get-AutomationCertificate` activity.|
31+
|[Get-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Get-AzAutomationCertificate?view=azps-3.7.0)|Retrieves information about a certificate to use in a runbook or DSC configuration. You can only retrieve the certificate itself using the internal `Get-AutomationCertificate` cmdlet.|
3232
|[New-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/New-AzAutomationCertificate?view=azps-3.7.0)|Creates a new certificate in Azure Automation.|
3333
|[Remove-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Remove-AzAutomationCertificate?view=azps-3.7.0)|Removes a certificate from Azure Automation.|
3434
|[Set-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Set-AzAutomationCertificate?view=azps-3.7.0)|Sets the properties for an existing certificate including uploading the certificate file and setting the password for a **.pfx** file.|
@@ -126,7 +126,7 @@ New-AzResourceGroupDeployment -Name NewCert -ResourceGroupName TestAzureAuto -Te
126126

127127
## Using a certificate
128128

129-
To use a certificate, use the `Get-AutomationCertificate` activity. You can't use the [Get-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Get-AzAutomationCertificate?view=azps-3.7.0) cmdlet, since it returns information about the certificate asset but not the certificate itself.
129+
To retrieve a certificate, use the internal `Get-AutomationCertificate` cmdlet. You can't use the [Get-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Get-AzAutomationCertificate?view=azps-3.7.0) cmdlet, since it returns information about the certificate asset but not the certificate itself.
130130

131131
### Textual runbook example
132132

@@ -142,11 +142,11 @@ Add-AzureCertificate -ServiceName $serviceName -CertToDeploy $cert
142142

143143
### Graphical runbook example
144144

145-
Add a `Get-AutomationCertificate` activity to a graphical runbook by right-clicking on the certificate in the Library pane and selecting **Add to canvas**.
145+
Add an activity for the internal `Get-AutomationCertificate` cmdlet to a graphical runbook by right-clicking on the certificate in the Library pane and selecting **Add to canvas**.
146146

147147
![Add certificate to the canvas](../media/certificates/automation-certificate-add-to-canvas.png)
148148

149-
The following image shows an example of using a certificate in a graphical runbook. This is the same as the preceding example that shows how to add a certificate to a cloud service from a textual runbook.
149+
The following image shows an example of using a certificate in a graphical runbook.
150150

151151
![Example Graphical Authoring](../media/certificates/graphical-runbook-add-certificate.png)
152152

@@ -164,4 +164,4 @@ print cert
164164

165165
## Next steps
166166

167-
- To learn more about working with links to control the logical flow of activities performed by your runbook, see [Links in graphical authoring](../automation-graphical-authoring-intro.md#links-and-workflow).
167+
- To learn more about working with links to control the logical flow of activities in your graphical runbook, see [Links in graphical authoring](../automation-graphical-authoring-intro.md#links-and-workflow).

articles/automation/shared-resources/credentials.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ New-AzureAutomationCredential -AutomationAccountName "MyAutomationAccount" -Name
9797

9898
## Using a PowerShell credential
9999

100-
A runbook or DSC configuration retrieves a credential asset with the `Get-AutomationPSCredential` activity. This activity retrieves a `PSCredential` object that you can use with an activity or cmdlet that requires a credential. You can also retrieve the properties of the credential object to use individually. The object has properties for the user name and the secure password. Alternatively, you can use the [GetNetworkCredential](https://docs.microsoft.com/dotnet/api/system.management.automation.pscredential.getnetworkcredential?view=pscore-6.2.0) method to retrieve a [NetworkCredential](/dotnet/api/system.net.networkcredential) object that represents an unsecured version of the password.
100+
A runbook or DSC configuration retrieves a credential asset with the internal `Get-AutomationPSCredential` cmdlet. This cmdlet retrieves a `PSCredential` object that you can use with a cmdlet or activity that requires a credential. You can also retrieve the properties of the credential object to use individually. The object has properties for the user name and the secure password. Alternatively, you can use the [GetNetworkCredential](https://docs.microsoft.com/dotnet/api/system.management.automation.pscredential.getnetworkcredential?view=pscore-6.2.0) method to retrieve a [NetworkCredential](/dotnet/api/system.net.networkcredential) object that represents an unsecured version of the password.
101101

102102
> [!NOTE]
103103
> `Get-AzAutomationCredential` does not retrieve a `PSCredential` object that can be used for authentication. It only provides information about the credential. If you need to use a credential in a runbook, you must retrieve it as a `PSCredential` object using `Get-AutomationPSCredential`.
@@ -130,7 +130,7 @@ Connect-AzAccount -Credential $myPsCred
130130

131131
### Graphical runbook example
132132

133-
You can add a `Get-AutomationPSCredential` activity to a graphical runbook by right-clicking on the credential in the Library pane of the graphical editor and selecting **Add to canvas**.
133+
You can add an activity for the internal `Get-AutomationPSCredential` cmdlet to a graphical runbook by right-clicking on the credential in the Library pane of the graphical editor and selecting **Add to canvas**.
134134

135135
![Add credential to canvas](../media/credentials/credential-add-canvas.png)
136136

articles/automation/shared-resources/schedules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Use the [New-AzAutomationSchedule](https://docs.microsoft.com/powershell/module/
6464

6565
#### Create a one-time schedule
6666

67-
The following sample commands create a one-time schedule.
67+
The following example creates a one-time schedule.
6868

6969
```azurepowershell-interactive
7070
$TimeZone = ([System.TimeZoneInfo]::Local).Id
@@ -93,7 +93,7 @@ New-AzAutomationSchedule -AutomationAccountName "ContosoAutomation" -Name "Sched
9393

9494
#### Create a weekly recurring schedule for weekends
9595

96-
The following sample commands show how to create a weekly schedule that runs on weekends only.
96+
The following example shows how to create a weekly schedule that runs on weekends only.
9797

9898
```azurepowershell-interactive
9999
$StartTime = (Get-Date "18:00:00").AddDays(1)

articles/automation/shared-resources/variables.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ When you create a variable with the Azure portal, you must specify a data type f
4242
* Boolean
4343
* Null
4444

45-
The variable isn't restricted to the designated data type. You must set the variable using Windows PowerShell if you want to specify a value of a different type. If you indicate `Not defined`, the value of the variable is set to Null. You must set the value with the [Set-AzAutomationVariable](https://docs.microsoft.com/powershell/module/az.automation/set-azautomationvariable?view=azps-3.5.0) cmdlet or the `Set-AutomationVariable` activity.
45+
The variable isn't restricted to the specified data type. You must set the variable using Windows PowerShell if you want to specify a value of a different type. If you indicate `Not defined`, the value of the variable is set to Null. You must set the value with the [Set-AzAutomationVariable](https://docs.microsoft.com/powershell/module/az.automation/set-azautomationvariable?view=azps-3.5.0) cmdlet or the internal `Set-AutomationVariable` cmdlet.
4646

4747
You can't use the Azure portal to create or change the value for a complex variable type. However, you can provide a value of any type using Windows PowerShell. Complex types are retrieved as a [PSCustomObject](/dotnet/api/system.management.automation.pscustomobject).
4848

@@ -57,7 +57,7 @@ For the Az module, the cmdlets in the following table are used to create and man
5757

5858
| Cmdlet | Description |
5959
|:---|:---|
60-
|[Get-AzAutomationVariable](https://docs.microsoft.com/powershell/module/az.automation/get-azautomationvariable?view=azps-3.5.0) | Retrieves the value of an existing variable. You can't use this cmdlet to retrieve the value of an encrypted variable. The only way to do this is by using the `Get-AutomationVariable` activity in a runbook or DSC configuration. |
60+
|[Get-AzAutomationVariable](https://docs.microsoft.com/powershell/module/az.automation/get-azautomationvariable?view=azps-3.5.0) | Retrieves the value of an existing variable. You can't use this cmdlet to retrieve the value of an encrypted variable. The only way to do this is by using the internal `Get-AutomationVariable` cmdlet in a runbook or DSC configuration. |
6161
|[New-AzAutomationVariable](https://docs.microsoft.com/powershell/module/az.automation/new-azautomationvariable?view=azps-3.5.0) | Creates a new variable and sets its value.|
6262
|[Remove-AzAutomationVariable](https://docs.microsoft.com/powershell/module/az.automation/remove-azautomationvariable?view=azps-3.5.0)| Removes an existing variable.|
6363
|[Set-AzAutomationVariable](https://docs.microsoft.com/powershell/module/az.automation/set-azautomationvariable?view=azps-3.5.0)| Sets the value for an existing variable. |
@@ -74,7 +74,7 @@ The internal cmdlets in the following table are used to access variables in your
7474
> [!NOTE]
7575
> Avoid using variables in the `Name` parameter of `Get-AutomationVariable` in a runbook or DSC configuration. Use of this parameter can complicate the discovery of dependencies between runbooks and Automation variables at design time.
7676
77-
Note that `Get-AutomationVariable` does not work in PowerShell, but only in a runbook or DSC configuration. For example, to see the value of an encrypted variable, you might create a runbook to get the variable and then write it to the output stream:
77+
`Get-AutomationVariable` does not work in PowerShell, but only in a runbook or DSC configuration. For example, to see the value of an encrypted variable, you might create a runbook to get the variable and then write it to the output stream:
7878

7979
```powershell
8080
$mytestencryptvar = Get-AutomationVariable -Name TestVariable
@@ -114,7 +114,7 @@ A PowerShell script uses the `New-AzAutomationVariable` cmdlet, or its AzureRM m
114114
The script retrieves the value of the variable using [Get-AzAutomationVariable](https://docs.microsoft.com/powershell/module/az.automation/get-azautomationvariable?view=azps-3.5.0). If the value is a simple type, the cmdlet retrieves that same type. If it's a complex type, a `PSCustomObject` type is retrieved.
115115

116116
>[!NOTE]
117-
>A PowerShell script can't retrieve an encrypted value. The only way to do this is to use a `Get-AutomationVariable` activity in a runbook or DSC configuration.
117+
>A PowerShell script can't retrieve an encrypted value. The only way to do this is to use the internal `Get-AutomationVariable` cmdlet in a runbook or DSC configuration.
118118
119119
The following example shows how to create a variable of type String and then return its value.
120120

@@ -143,13 +143,13 @@ $vmIpAddress = $vmValue.IpAddress
143143
The only way to create a new variable from within a runbook or DSC configuration is to use the `New-AzAutomationVariable` cmdlet or its AzureRM module equivalent. The script uses this cmdlet to set the initial value of the variable. The script can then retrieve the value using `Get-AzAutomationVariable`. If the value is a simple type, that same type is retrieved. If it's a complex type, then a `PSCustomObject` type is retrieved.
144144

145145
>[!NOTE]
146-
>The only way to retrieve an encrypted value is by using the `Get-AutomationVariable` activity in the runbook or DSC configuration.
146+
>The only way to retrieve an encrypted value is by using the internal `Get-AutomationVariable` cmdlet in the runbook or DSC configuration.
147147
148-
### Textual runbook samples
148+
### Textual runbook examples
149149

150-
#### Set and retrieve a simple value from a variable
150+
#### Retrieve and set a simple value from a variable
151151

152-
The following sample commands show how to set and retrieve a variable in a textual runbook. This sample assumes the creation of integer variables named `NumberOfIterations` and `NumberOfRunnings` and a string variable named `SampleMessage`.
152+
The following example shows how to set and retrieve a variable in a textual runbook. This example assumes the creation of integer variables named `NumberOfIterations` and `NumberOfRunnings` and a string variable named `SampleMessage`.
153153

154154
```powershell
155155
$NumberOfIterations = Get-AzAutomationVariable -ResourceGroupName "ResourceGroup01" –AutomationAccountName "MyAutomationAccount" -Name 'NumberOfIterations'
@@ -164,9 +164,9 @@ for ($i = 1; $i -le $NumberOfIterations; $i++) {
164164
Set-AzAutomationVariable -ResourceGroupName "ResourceGroup01" –AutomationAccountName "MyAutomationAccount" –Name NumberOfRunnings –Value ($NumberOfRunnings += 1)
165165
```
166166

167-
#### Set and retrieve a variable in a Python 2 runbook
167+
#### Retrieve and set a variable in a Python 2 runbook
168168

169-
The following sample shows how to use a variable, set a variable, and handle an exception for a nonexistent variable in a Python 2 runbook.
169+
The following sample shows how to get a variable, set a variable, and handle an exception for a nonexistent variable in a Python 2 runbook.
170170

171171
```python
172172
import automationassets
@@ -188,15 +188,15 @@ except AutomationAssetNotFound:
188188
print "variable not found"
189189
```
190190

191-
### Graphical runbook samples
191+
### Graphical runbook examples
192192

193-
In a graphical runbook, you can add the `Get-AutomationVariable` or `Set-AutomationVariable` activity. Simply right-click the variable in the Library pane of the graphical editor and select the activity that you want.
193+
In a graphical runbook, you can add activities for the internal cmdlets `Get-AutomationVariable` or `Set-AutomationVariable`. Just right-click each variable in the Library pane of the graphical editor and select the activity that you want.
194194

195195
![Add variable to canvas](../media/variables/runbook-variable-add-canvas.png)
196196

197197
#### Set values in a variable
198198

199-
The following image shows sample activities to update a variable with a simple value in a graphical runbook. In this sample, `Get-AzVM` retrieves a single Azure virtual machine and saves the computer name to an existing Automation string variable. It doesn't matter whether the [link is a pipeline or sequence](../automation-graphical-authoring-intro.md#links-and-workflow) since the code only expects a single object in the output.
199+
The following image shows example activities to update a variable with a simple value in a graphical runbook. In this example, the activity for `Get-AzVM` retrieves a single Azure virtual machine and saves the computer name to an existing Automation string variable. It doesn't matter whether the [link is a pipeline or sequence](../automation-graphical-authoring-intro.md#links-and-workflow) since the code only expects a single object in the output.
200200

201201
![Set simple variable](../media/variables/runbook-set-simple-variable.png)
202202

0 commit comments

Comments
 (0)