|
1 | 1 | ---
|
2 |
| -title: Batch Certificate Migration Guide |
3 |
| -description: Describes the migration steps for the batch certificates and the end of support details. |
| 2 | +title: Migrate Batch certificates to Azure Key Vault |
| 3 | +description: Learn how to migrate access management from using certificates in Azure Batch to Azure Key Vault and plan for feature end of support. |
4 | 4 | author: harperche
|
5 | 5 | ms.author: harpercheng
|
6 | 6 | ms.service: batch
|
7 |
| -ms.topic: how-to #Required; leave this attribute/value as-is. |
| 7 | +ms.topic: how-to |
8 | 8 | ms.date: 08/15/2022
|
9 | 9 | ---
|
10 |
| -# Batch Certificate Migration Guide |
11 | 10 |
|
12 |
| -Securing the application and critical information has become essential in today's needs. With growing customers and increasing demand for security, managing key information plays a significant role in securing data. Many customers need to store secure data in the application, and it needs to be managed to avoid any leakage. In addition, only legitimate administrators or authorized users should access it. Azure Batch offers Certificates created and managed by the Batch service. Azure Batch also provides a Key Vault option, and it's considered an azure-standard method for delivering more controlled secure access management. |
| 11 | +# Migrate Batch certificates to Azure Key Vault |
13 | 12 |
|
14 |
| -Azure Batch provides certificates feature at the account level. Customers must generate the Certificate and upload it manually to the Azure Batch via the portal. To access the Certificate, it must be associated and installed for the 'Current User.' The Certificate is usually valid for one year and must follow a similar procedure every year. |
| 13 | +On *February 29, 2024*, the certificates feature for Azure Batch access management will be retired. Learn how to migrate your access management approach from using certificates in Azure Batch to using Azure Key Vault. |
15 | 14 |
|
16 |
| -For Azure Batch customers, a secure way of access should be provided in a more standardized way, reducing any manual interruption and reducing the readability of key generated. Therefore, we'll retire the certificate feature on **29 February 2024** to reduce the maintenance effort and better guide customers to use Azure Key Vault as a standard and more modern method with advanced security. After it's retired, the Certificate functionality may cease working properly. Additionally, pool creation with certificates will be rejected and possibly resize up. |
| 15 | +## About the feature |
17 | 16 |
|
18 |
| -## Retirement alternatives |
| 17 | +Often, you need to store secure data for an application. Your data must be securely managed so that only administrators or authorized users can access it. |
19 | 18 |
|
20 |
| -Azure Key Vault is the service provided by Microsoft Azure to store and manage secrets, certificates, tokens, keys, and other configuration values that authenticated users access the applications and services. The original idea was to remove the hard-coded storing of these secrets and keys in the application code. |
| 19 | +Currently, Azure Batch offers two ways to secure access. You can use a certificate that you create and manage in Azure Batch or you can use Azure Key Vault to store an access key. Using a key vault is an Azure-standard way to deliver more controlled secure access management. |
21 | 20 |
|
22 |
| -Azure Key Vault provides security at the transport layer by ensuring any data flow from the key vault to the client application is encrypted. Azure key vault stores the secrets and keys with such strong encryption that even Microsoft itself won't see the keys or secrets in any way. |
| 21 | +You can use a certificate at the account level in Azure Batch. You must generate the certificate and upload it manually to Batch by using the Azure portal. To access the certificate, the certificate must be associated with and installed for only the current user. A certificate typically is valid for one year, and it must be updated each year. |
23 | 22 |
|
24 |
| -Azure Key Vault provides a secure way to store the information and define the fine-grained access control. All the secrets can be managed from one dashboard. Azure Key Vault can store the key in the software-protected or hardware protected by hardware security module (HSMs) mechanism. In addition, it has a mechanism to auto-renew the Key Vault certificates. |
| 23 | +## Feature end of support |
25 | 24 |
|
26 |
| -## Migration steps |
| 25 | +To move toward a simpler, standardized way to secure access to your Batch resources, on February 29, 2024, we'll retire the certificates feature in Azure Batch. We recommend that you use Azure Key Vault as a standard and more modern method to secure your resources in Batch. |
27 | 26 |
|
28 |
| -Azure Key Vault can be created in three ways: |
| 27 | +In Key Vault, you get these benefits: |
29 | 28 |
|
30 |
| -1. Using Azure portal |
| 29 | +- Reduced manual maintenance and streamlined maintenance overall |
| 30 | +- Reduced access to and readability of the key that's generated |
| 31 | +- Advanced security |
31 | 32 |
|
32 |
| -2. Using PowerShell |
| 33 | +After the certificates feature in Azure Batch is retired on February 29, 2024, a certificate in Batch might not work as expected. After that date, you won't be able to create a pool by using a certificate. Pools that continue to use certificates after the feature is retired might increase in size and cost. |
33 | 34 |
|
34 |
| -3. Using CLI |
| 35 | +## Alternative: Use Key Vault |
35 | 36 |
|
36 |
| -**Create Azure Key Vault step by step procedure using Azure portal:** |
| 37 | +Azure Key Vault is an Azure service you can use to store and manage secrets, certificates, tokens, keys, and other configuration values that give authenticated users access to secure applications and services. Key Vault is based on the idea that security is improved and standardized when you remove hard-coded secrets and keys from application code that's deployed. |
37 | 38 |
|
38 |
| -__Prerequisite__: Valid Azure subscription and owner/contributor access on Key Vault service. |
| 39 | +Key Vault provides security at the transport layer by ensuring that any data flow from the key vault to the client application is encrypted. Azure Key Vault stores secrets and keys with such strong encryption that even Microsoft can't read key vault-protected keys and secrets. |
39 | 40 |
|
40 |
| - 1. Log in to the Azure portal. |
| 41 | +Azure Key Vault gives you a secure way to store essential access information and to set fine-grained access control. You can manage all secrets from one dashboard. Choose to store a key in either software-protected or hardware-protected hardware security modules (HSMs). You also can set Key Vault to auto-renew certificates |
41 | 42 |
|
42 |
| - 2. In the top-level search box, look for **Key Vaults**. |
| 43 | +## Create a key vault |
43 | 44 |
|
44 |
| - 3. In the Key Vault dashboard, click on create and provide all the details like subscription, resource group, Key Vault name, select the pricing tier (standard/premium), and select region. Once all these details are provided, click on review, and create. This will create the Key Vault account. |
| 45 | +To create a key vault to manage access for Batch resources, use one of the following options: |
45 | 46 |
|
46 |
| - 4. Key Vault names need to be unique across the globe. Once any user has taken a name, it won’t be available for other users. |
| 47 | +- Azure portal |
| 48 | +- PowerShell |
| 49 | +- Azure CLI |
47 | 50 |
|
48 |
| - 5. Now go to the newly created Azure Key Vault. There you can see the vault name and the vault URI used to access the vault. |
| 51 | +### Create a key vault by using the Azure portal |
49 | 52 |
|
50 |
| -**Create Azure Key Vault step by step using the Azure PowerShell:** |
| 53 | +- **Prerequisites**: To create a key vault by using the Azure portal, you must have a valid Azure subscription and Owner or Contributor access for Azure Key Vault. |
51 | 54 |
|
52 |
| - 1. Log in to the user PowerShell using the following command - Login-AzAccount |
| 55 | +To create a key vault: |
53 | 56 |
|
54 |
| - 2. Create an 'azure secure' resource group in the 'eastus' location. You can change the name and location as per your need. |
55 |
| -``` |
56 |
| - New-AzResourceGroup -Name "azuresecure" -Location "EastUS" |
57 |
| -``` |
58 |
| - 3. Create the Azure Key Vault using the cmdlet. You need to provide the key vault name, resource group, and location. |
59 |
| -``` |
60 |
| - New-AzKeyVault -Name "azuresecureKeyVault" -ResourceGroupName "azuresecure" -Location "East US" |
61 |
| -``` |
| 57 | +1. Sign in to the Azure portal. |
62 | 58 |
|
63 |
| - 4. Created the Azure Key Vault successfully using the PowerShell cmdlet. |
| 59 | +1. Search for **key vaults**. |
64 | 60 |
|
65 |
| -**Create Azure Key Vault step by step using the Azure CLI bash:** |
| 61 | +1. In the Key Vault dashboard, select **Create**. |
66 | 62 |
|
67 |
| - 1. Create an 'azure secure' resource in the 'eastus' location. You can change the name and location as per your need. Use the following bash command. |
68 |
| -``` |
69 |
| - az group create –name "azuresecure" -l "EastUS." |
70 |
| -``` |
| 63 | +1. Enter or select your subscription, a resource group name, a key vault name, the pricing tier (Standard or Premium), and the region closest to your users. Each key vault name must be unique in Azure. |
71 | 64 |
|
72 |
| - 2. Create the Azure Key Vault using the bash command. You need to provide the key vault name, resource group, and location. |
73 |
| -``` |
74 |
| - az keyvault create –name “azuresecureKeyVault” –resource-group “azure” –location “EastUS” |
75 |
| -``` |
76 |
| - 3. Successfully created the Azure Key Vault using the Azure CLI bash command. |
| 65 | +1. Select **Review**, and then select **Create** to create the key vault account. |
77 | 66 |
|
78 |
| -## FAQ |
| 67 | +1. Go to the key vault you created. The key vault name and the URI you use to access the vault are shown under deployment details. |
79 | 68 |
|
80 |
| - 1. Is Certificates or Azure Key Vault recommended? |
81 |
| - Azure Key Vault is recommended and essential to protect the data in the cloud. |
| 69 | +For more information, see [Quickstart: Create a key vault by using the Azure portal](../key-vault/general/quick-create-portal.md). |
82 | 70 |
|
83 |
| - 2. Does user subscription mode support Azure Key Vault? |
84 |
| - Yes, it's mandatory to create Key Vault while creating the Batch account in user subscription mode. |
| 71 | +### Create a key vault by using PowerShell |
85 | 72 |
|
86 |
| - 3. Are there best practices to use Azure Key Vault? |
87 |
| - Best practices are covered [here](../key-vault/general/best-practices.md). |
| 73 | +1. Use the PowerShell option in Azure Cloud Shell to sign in to your account: |
| 74 | + |
| 75 | + ```powershell |
| 76 | + Login-AzAccount |
| 77 | + ``` |
| 78 | + |
| 79 | +1. Use the following command to create a new resource group in the region that's closest to your users. For the `<placeholder>` values, enter the information for the Key Vault instance you want to create. |
| 80 | + |
| 81 | + ```powershell |
| 82 | + New-AzResourceGroup -Name <ResourceGroupName> -Location <Location> |
| 83 | + ``` |
| 84 | + |
| 85 | +1. Use the following cmdlet to create the key vault. For the `<placeholder>` values, use the use key vault name, resource group name, and region for the key vault you want to create. |
| 86 | + |
| 87 | + ```powershell |
| 88 | + New-AzKeyVault -Name <KeyVaultName> -ResourceGroupName <ResourceGroupName> -Location <Location> |
| 89 | + ``` |
| 90 | + |
| 91 | +For more information, see [Quickstart: Create a key vault by using PowerShell](../key-vault/general/quick-create-powershell.md). |
| 92 | + |
| 93 | +### Create a key vault by using the Azure CLI |
| 94 | + |
| 95 | +1. Use the Bash option in the Azure CLI to create a new resource group in the region that's closest to your users. For the `<placeholder>` values, enter the information for the Key Vault instance you want to create. |
| 96 | + |
| 97 | + ```bash |
| 98 | + az group create -name <ResourceGroupName> -l <Location> |
| 99 | + ``` |
| 100 | + |
| 101 | +1. Create the key vault by using the following command. For the `<placeholder>` values, use the use key vault name, resource group name, and region for the key vault you want to create. |
| 102 | + |
| 103 | + ```bash |
| 104 | + az keyvault create -name <KeyVaultName> -resource-group <ResourceGroupName> -location <Location> |
| 105 | + ``` |
| 106 | + |
| 107 | +For more information, see [Quickstart: Create a key vault by using the Azure CLI](../key-vault/general/quick-create-cli.md). |
| 108 | + |
| 109 | +## FAQs |
| 110 | + |
| 111 | +- Does Microsoft recommend using Azure Key Vault for access management in Batch? |
| 112 | + |
| 113 | + Yes. We recommend that you use Azure Key Vault as part of your approach to essential data protection in the cloud. |
| 114 | + |
| 115 | +- Does user subscription mode support Azure Key Vault? |
| 116 | + |
| 117 | + Yes. In user subscription mode, you must create the key vault at the time you create the Batch account. |
| 118 | + |
| 119 | +- Where can I find best practices for using Azure Key Vault? |
| 120 | + |
| 121 | + See [Azure Key Vault best practices](../key-vault/general/best-practices.md). |
88 | 122 |
|
89 | 123 | ## Next steps
|
90 | 124 |
|
91 |
| -For more information, see [Certificate Access Control](../key-vault/certificates/certificate-access-control.md). |
| 125 | +For more information, see [Key Vault certificate access control](../key-vault/certificates/certificate-access-control.md). |
0 commit comments