Skip to content

Commit 5eb8440

Browse files
authored
Merge pull request #113110 from Ja-Dunn/automation-articles-jd-batch1
edit pass: automation-articles-jd-batch1
2 parents a30061b + c1f0fe4 commit 5eb8440

File tree

4 files changed

+120
-121
lines changed

4 files changed

+120
-121
lines changed

articles/automation/shared-resources/certificates.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Manage certificates 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.
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,24 +13,24 @@ manager: carmonm
1313

1414
# Manage certificates in Azure Automation
1515

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.
16+
Azure Automation stores certificates securely for access by runbooks and DSC configurations, by 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]
19-
>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.
19+
>Secure assets in Azure Automation include credentials, certificates, connections, and encrypted variables. These assets are encrypted and stored in Automation by using a unique key that is generated for each Automation account. Automation stores the key in the system-managed Key Vault service. Before storing a secure asset, Automation loads the key from Key Vault, and then uses it to encrypt the asset.
2020
2121
>[!NOTE]
22-
>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).
22+
>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).
2323
2424
## PowerShell cmdlets to access certificates
2525

2626
The cmdlets in the following table create and manage Automation certificates with PowerShell. They ship as part of the [Az modules](modules.md#az-modules).
2727

2828
|Cmdlet |Description|
2929
| --- | ---|
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 internal `Get-AutomationCertificate` cmdlet.|
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 internal `Get-AutomationCertificate` cmdlet.|
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
The [Add-AzureCertificate](/powershell/module/servicemanagement/azure/add-azurecertificate) cmdlet can also be used to upload a service certificate for the specified cloud service.
3636

@@ -43,11 +43,11 @@ The internal cmdlet in the following table is used to access certificates in you
4343
|`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.|
4444

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

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

5252
| Function | Description |
5353
|:---|:---|
@@ -58,16 +58,14 @@ The function in the following table is used to access certificates in a Python 2
5858
5959
## Create a new certificate
6060

61-
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**.
61+
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**.
6262

6363
### Create a new certificate with the Azure portal
6464

65-
1. From your Automation account, click **Assets** to open the Assets page.
66-
2. Select **Certificates** to open the Certificates page.
67-
3. Click **Add a certificate** at the top of the page.
68-
4. Type a name for the certificate in the **Name** field.
69-
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.
70-
6. Click **Create** to save the new certificate asset.
65+
1. From your Automation account, select **Assets** > **Certificates** > **Add a certificate**.
66+
1. In the **Name** field, type a name for the certificate.
67+
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.
68+
1. Select **Create** to save the new certificate asset.
7169

7270
### Create a new certificate with PowerShell
7371

@@ -84,7 +82,7 @@ New-AzAutomationCertificate -AutomationAccountName "MyAutomationAccount" -Name $
8482

8583
### Create a new certificate with a Resource Manager template
8684

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

8987
```powershell-interactive
9088
$AutomationAccountName = "<automation account name>"
@@ -127,7 +125,7 @@ New-AzResourceGroupDeployment -Name NewCert -ResourceGroupName TestAzureAuto -Te
127125

128126
## Get a certificate
129127

130-
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.
128+
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, because it returns information about the certificate asset, but not the certificate itself.
131129

132130
### Textual runbook example
133131

@@ -143,17 +141,17 @@ Add-AzureCertificate -ServiceName $serviceName -CertToDeploy $cert
143141

144142
### Graphical runbook example
145143

146-
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**.
144+
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**.
147145

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

150148
The following image shows an example of using a certificate in a graphical runbook.
151149

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

154152
### Python 2 example
155153

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

158156
```python
159157
# get a reference to the Azure Automation certificate

0 commit comments

Comments
 (0)