Skip to content

Commit 1999d0c

Browse files
committed
edit pass: automation-articles-jd-batch1
1 parent c888b27 commit 1999d0c

File tree

2 files changed

+108
-110
lines changed

2 files changed

+108
-110
lines changed

articles/automation/shared-resources/certificates.md

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Manage certificate in Azure Automation
3-
description: Certificates are securely stored in Azure Automation so that runbooks or DSC configurations can access them to authenticate against Azure and third-party resources. This article explains the details of certificates and how to work with them in both textual and graphical authoring.
2+
title: Manage certificates in Azure Automation
3+
description: Azure Automation securely stores certificates, so that runbooks or DSC configurations can access them to authenticate against Azure and third-party resources. This article explains the details of certificates, and how to work with them in both textual and graphical authoring.
44
services: automation
55
ms.service: automation
66
ms.subservice: shared-capabilities
@@ -13,39 +13,39 @@ 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) activity 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+
Azure Automation securely stores certificates, so they can be accessed by runbooks or DSC configurations by using the [Get-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Get-AzAutomationCertificate?view=azps-3.7.0) activity 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

18-
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+
Secure assets in Azure Automation include credentials, certificates, connections, and encrypted variables. Automation encrypts and stores these assets by using a unique key that is generated for each automation account. This key is stored in a system-managed key vault. Before you store a secure asset, you load the key from Key Vault, and you encrypt the asset. Automation manages this process.
1919

2020
>[!NOTE]
21-
>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).
21+
>This article shows you how to use the Azure PowerShell Az module. You can still use the AzureRM module. To learn more about the 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 by using [How to update Azure PowerShell modules in Azure Automation](../automation-update-azure-modules.md).
2222
2323
## Az PowerShell cmdlets
2424

25-
For Az, the cmdlets in the following table are used to create and manage automation credential assets with Windows PowerShell. They ship as part of the [Az.Automation module](/powershell/azure/overview), which is available for use in Automation runbooks and DSC configurations.
25+
For Az, you use the cmdlets in the following table to create and manage automation credential assets with Windows PowerShell. They ship as part of the [Az.Automation module](/powershell/azure/overview), which is available for use in Automation runbooks and DSC configurations.
2626

2727
|Cmdlet |Description|
2828
| --- | ---|
2929
|[Add-AzureCertificate](/powershell/module/servicemanagement/azure/add-azurecertificate)|Uploads a service certificate for the specified cloud service.|
30-
|[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-
|[New-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/New-AzAutomationCertificate?view=azps-3.7.0)|Creates a new certificate in Azure Automation.|
32-
|[Remove-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Remove-AzAutomationCertificate?view=azps-3.7.0)|Removes a certificate from Azure Automation.|
33-
|[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.|
30+
|[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 by using the `Get-AutomationCertificate` activity.|
31+
|[New-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/New-AzAutomationCertificate?view=azps-3.7.0)|Creates a new certificate in Automation.|
32+
|[Remove-AzAutomationCertificate](https://docs.microsoft.com/powershell/module/Az.Automation/Remove-AzAutomationCertificate?view=azps-3.7.0)|Removes a certificate from Automation.|
33+
|[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.|
3434

3535
## Activities
3636

37-
The activities in the following table are used to access certificates in a runbook and DSC configurations.
37+
Use the activities in the following table to access certificates in a runbook and DSC configurations.
3838

3939
| Activities | Description |
4040
|:---|:---|
4141
|`Get-AutomationCertificate`|Gets a certificate to use in a runbook or DSC configuration. Returns a [System.Security.Cryptography.X509Certificates.X509Certificate2](/dotnet/api/system.security.cryptography.x509certificates.x509certificate2) object.|
4242

4343
> [!NOTE]
44-
> You should avoid using variables in the `Name` parameter of `Get-AutomationCertificate` in a runbook or DSC configuration. Use of variables in this parameter complicates the discovery of dependencies between runbooks or DSC configurations and Automation variables at design time.
44+
> You should avoid using variables in the `Name` parameter of `Get-AutomationCertificate` in a runbook or DSC configuration. Such variables complicate the discovery of dependencies between runbooks or DSC configurations and Automation variables at design time.
4545
46-
## Python 2 functions
46+
## Python 2 function
4747

48-
The function in the following table is used to access certificates in a Python 2 runbook.
48+
Use the function in the following table to access certificates in a Python 2 runbook.
4949

5050
| Function | Description |
5151
|:---|:---|
@@ -54,18 +54,16 @@ The function in the following table is used to access certificates in a Python 2
5454
> [!NOTE]
5555
> You must import the `automationassets` module at the beginning of your Python runbook to access the asset functions.
5656
57-
## Creating a new certificate
57+
## Create a new certificate
5858

59-
When you create a new certificate, you upload a .cer or .pfx file to Azure Automation. If you mark the certificate as exportable, then you can transfer it out of the Azure Automation certificate store. If it isn't exportable, then it can only be used for signing within the runbook or DSC configuration. Azure Automation requires the certificate to have the provider **Microsoft Enhanced RSA and AES Cryptographic Provider**.
59+
When you create a new certificate, you upload a .cer or .pfx file to Automation. If you mark the certificate as exportable, then you can transfer it out of the Automation certificate store. If it isn't exportable, then it can only be used for signing within the runbook or DSC configuration. Automation requires the certificate to have the provider **Microsoft Enhanced RSA and AES Cryptographic Provider**.
6060

6161
### Create a new certificate with the Azure portal
6262

63-
1. From your Automation account, click **Assets** to open the Assets page.
64-
2. Select **Certificates** to open the Certificates page.
65-
3. Click **Add a certificate** at the top of the page.
66-
4. Type a name for the certificate in the **Name** field.
67-
5. To browse for a **.cer** or **.pfx** file, click **Select a file** under **Upload a certificate file**. If you select a **.pfx**file, specify a password and indicate if it can be exported.
68-
6. Click **Create** to save the new certificate asset.
63+
1. From your Automation account, select **Assets** > **Certificates** > **Add a certificate**..
64+
1. In the **Name** field, type a name for the certificate.
65+
1. To browse for a **.cer** or **.pfx** file, under **Upload a certificate file**, choose **Select a file**. If you select a **.pfx** file, specify a password and indicate if it can be exported.
66+
1. Select **Create** to save the new certificate asset.
6967

7068
### Create a new certificate with PowerShell
7169

@@ -82,7 +80,7 @@ New-AzAutomationCertificate -AutomationAccountName "MyAutomationAccount" -Name $
8280

8381
### Create a new certificate with a Resource Manager template
8482

85-
The following example demonstrates how to deploy a certificate to your Automation account using a Resource Manager template through PowerShell:
83+
The following example demonstrates how to deploy a certificate to your Automation account by using a Resource Manager template through PowerShell:
8684

8785
```powershell-interactive
8886
$AutomationAccountName = "<automation account name>"
@@ -123,9 +121,9 @@ $json | out-file .\template.json
123121
New-AzResourceGroupDeployment -Name NewCert -ResourceGroupName TestAzureAuto -TemplateFile .\template.json
124122
```
125123

126-
## Using a certificate
124+
## Use a certificate
127125

128-
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.
126+
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. This cmdlet returns information about the certificate asset, but not the certificate itself.
129127

130128
### Textual runbook example
131129

@@ -141,17 +139,17 @@ Add-AzureCertificate -ServiceName $serviceName -CertToDeploy $cert
141139

142140
### Graphical runbook example
143141

144-
Add a `Get-AutomationCertificate` activity to a graphical runbook by right-clicking on the certificate in the Library pane and selecting **Add to canvas**.
142+
Add a `Get-AutomationCertificate` activity to a graphical runbook by right-clicking on the certificate in the **Library** pane, and selecting **Add to canvas**.
145143

146-
![Add certificate to the canvas](../media/certificates/automation-certificate-add-to-canvas.png)
144+
![Screenshot of adding a certificate to the canvas](../media/certificates/automation-certificate-add-to-canvas.png)
147145

148146
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.
149147

150-
![Example Graphical Authoring](../media/certificates/graphical-runbook-add-certificate.png)
148+
![Screenshot of an example of graphical authoring](../media/certificates/graphical-runbook-add-certificate.png)
151149

152150
### Python 2 example
153151

154-
The following example shows how to access certificates in Python2 runbooks.
152+
The following example shows how to access certificates in Python 2 runbooks.
155153

156154
```python
157155
# get a reference to the Azure Automation certificate
@@ -163,4 +161,4 @@ print cert
163161

164162
## Next steps
165163

166-
- 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).
164+
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).

0 commit comments

Comments
 (0)