Skip to content

Commit 8e15dae

Browse files
committed
freshness/moniker work
1 parent ab26a07 commit 8e15dae

File tree

4 files changed

+45
-19
lines changed

4 files changed

+45
-19
lines changed

articles/machine-learning/concept-customer-managed-keys.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ ms.topic: conceptual
99
ms.author: jhirono
1010
author: jhirono
1111
ms.reviewer: larryfr
12-
ms.date: 01/19/2023
12+
ms.date: 09/12/2023
1313
ms.custom: engagement-fy23
14+
monikerRange: 'azureml-api-2 || azureml-api-1'
1415
---
1516
# Customer-managed keys for Azure Machine Learning
1617

@@ -20,7 +21,7 @@ Azure Machine Learning is built on top of multiple Azure services. While the dat
2021

2122
In addition to customer-managed keys, Azure Machine Learning also provides a [hbi_workspace flag](/python/api/azure-ai-ml/azure.ai.ml.entities.workspace). Enabling this flag reduces the amount of data Microsoft collects for diagnostic purposes and enables [extra encryption in Microsoft-managed environments](../security/fundamentals/encryption-atrest.md). This flag also enables the following behaviors:
2223

23-
* Starts encrypting the local scratch disk in your Azure Machine Learning compute cluster, provided you havent created any previous clusters in that subscription. Else, you need to raise a support ticket to enable encryption of the scratch disk of your compute clusters.
24+
* Starts encrypting the local scratch disk in your Azure Machine Learning compute cluster, provided you haven't created any previous clusters in that subscription. Else, you need to raise a support ticket to enable encryption of the scratch disk of your compute clusters.
2425
* Cleans up your local scratch disk between jobs.
2526
* Securely passes credentials for your storage account, container registry, and SSH account from the execution layer to your compute clusters using your key vault.
2627

@@ -43,15 +44,15 @@ In addition to customer-managed keys, Azure Machine Learning also provides a [hb
4344

4445
## Limitations
4546

46-
* The customer-managed key for resources the workspace depends on cant be updated after workspace creation.
47-
* Resources managed by Microsoft in your subscription cant transfer ownership to you.
47+
* The customer-managed key for resources the workspace depends on can't be updated after workspace creation.
48+
* Resources managed by Microsoft in your subscription can't transfer ownership to you.
4849
* You can't delete Microsoft-managed resources used for customer-managed keys without also deleting your workspace.
4950

5051
## How workspace metadata is stored
5152

5253
The following resources store metadata for your workspace:
5354

54-
| Service | How its used |
55+
| Service | How it's used |
5556
| ----- | ----- |
5657
| Azure Cosmos DB | Stores job history data. |
5758
| Azure Cognitive Search | Stores indices that are used to help query your machine learning content. |
@@ -84,12 +85,21 @@ These Microsoft-managed resources are located in a new Azure resource group is c
8485

8586
Azure Machine Learning uses compute resources to train and deploy machine learning models. The following table describes the compute options and how data is encrypted by each one:
8687

88+
:::moniker range="azureml-api-1"
8789
| Compute | Encryption |
8890
| ----- | ----- |
8991
| Azure Container Instance | Data is encrypted by a Microsoft-managed key or a customer-managed key.</br>For more information, see [Encrypt data with a customer-managed key](../container-instances/container-instances-encrypt-data.md). |
9092
| Azure Kubernetes Service | Data is encrypted by a Microsoft-managed key or a customer-managed key.</br>For more information, see [Bring your own keys with Azure disks in Azure Kubernetes Services](../aks/azure-disk-customer-managed-keys.md). |
9193
| Azure Machine Learning compute instance | Local scratch disk is encrypted if the `hbi_workspace` flag is enabled for the workspace. |
9294
| Azure Machine Learning compute cluster | OS disk encrypted in Azure Storage with Microsoft-managed keys. Temporary disk is encrypted if the `hbi_workspace` flag is enabled for the workspace. |
95+
:::moniker-end
96+
:::moniker range="azureml-api-2"
97+
| Compute | Encryption |
98+
| ----- | ----- |
99+
| Azure Kubernetes Service | Data is encrypted by a Microsoft-managed key or a customer-managed key.</br>For more information, see [Bring your own keys with Azure disks in Azure Kubernetes Services](../aks/azure-disk-customer-managed-keys.md). |
100+
| Azure Machine Learning compute instance | Local scratch disk is encrypted if the `hbi_workspace` flag is enabled for the workspace. |
101+
| Azure Machine Learning compute cluster | OS disk encrypted in Azure Storage with Microsoft-managed keys. Temporary disk is encrypted if the `hbi_workspace` flag is enabled for the workspace. |
102+
:::moniker-end
93103

94104
**Compute cluster**
95105
The OS disk for each compute node stored in Azure Storage is encrypted with Microsoft-managed keys in Azure Machine Learning storage accounts. This compute target is ephemeral, and clusters are typically scaled down when no jobs are queued. The underlying virtual machine is de-provisioned, and the OS disk is deleted. Azure Disk Encryption isn't supported for the OS disk.
@@ -101,8 +111,8 @@ The OS disk for compute instance is encrypted with Microsoft-managed keys in Azu
101111

102112
### HBI_workspace flag
103113

104-
* The `hbi_workspace` flag can only be set when a workspace is created. It cant be changed for an existing workspace.
105-
* When this flag is set to True, it may increase the difficulty of troubleshooting issues because less telemetry data is sent to Microsoft. Theres less visibility into success rates or problem types. Microsoft may not be able to react as proactively when this flag is True.
114+
* The `hbi_workspace` flag can only be set when a workspace is created. It can't be changed for an existing workspace.
115+
* When this flag is set to True, it may increase the difficulty of troubleshooting issues because less telemetry data is sent to Microsoft. There's less visibility into success rates or problem types. Microsoft may not be able to react as proactively when this flag is True.
106116

107117
To enable the `hbi_workspace` flag when creating an Azure Machine Learning workspace, follow the steps in one of the following articles:
108118

articles/machine-learning/how-to-setup-customer-managed-keys.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ ms.topic: conceptual
1010
ms.author: jhirono
1111
author: jhirono
1212
ms.reviewer: larryfr
13-
ms.date: 01/20/2023
13+
ms.date: 09/12/2023
14+
monikerRange: 'azureml-api-2 || azureml-api-1'
1415
---
1516
# Use customer-managed keys with Azure Machine Learning
1617

@@ -27,7 +28,7 @@ In the [customer-managed keys concepts article](concept-customer-managed-keys.md
2728
| Resource provider | Why it's needed |
2829
| ----- | ----- |
2930
| Microsoft.MachineLearningServices | Creating the Azure Machine Learning workspace.
30-
| Microsoft.Storage Azure | Storage Account is used as the default storage for the workspace.
31+
| Microsoft.Storage Azure | Storage Account is used as the default storage for the workspace.
3132
| Microsoft.KeyVault |Azure Key Vault is used by the workspace to store secrets.
3233
| Microsoft.DocumentDB/databaseAccounts | Azure Cosmos DB instance that logs metadata for the workspace.
3334
| Microsoft.Search/searchServices | Azure Search provides indexing capabilities for the workspace.
@@ -37,8 +38,8 @@ In the [customer-managed keys concepts article](concept-customer-managed-keys.md
3738

3839
## Limitations
3940

40-
* The customer-managed key for resources the workspace depends on cant be updated after workspace creation.
41-
* Resources managed by Microsoft in your subscription cant transfer ownership to you.
41+
* The customer-managed key for resources the workspace depends on can't be updated after workspace creation.
42+
* Resources managed by Microsoft in your subscription can't transfer ownership to you.
4243
* You can't delete Microsoft-managed resources used for customer-managed keys without also deleting your workspace.
4344
* The key vault that contains your customer-managed key must be in the same Azure subscription as the Azure Machine Learning workspace.
4445
* OS disk of machine learning compute can't be encrypted with customer-managed key, but can be encrypted with Microsoft-managed key if the workspace is created with `hbi_workspace` parameter set to `TRUE`. For more details, see [Data encryption](concept-data-encryption.md#machine-learning-compute).
@@ -131,6 +132,7 @@ Once the workspace has been created, you'll notice that Azure resource group is
131132
132133
For more information on customer-managed keys with Azure Cosmos DB, see [Configure customer-managed keys for your Azure Cosmos DB account](../cosmos-db/how-to-setup-cmk.md).
133134
135+
:::moniker range="azureml-api-1"
134136
### Azure Container Instance
135137
136138
> [!IMPORTANT]
@@ -146,12 +148,11 @@ To use the key when deploying a model to Azure Container Instance, create a new
146148
147149
For more information on creating and using a deployment configuration, see the following articles:
148150
149-
* [AciWebservice.deploy_configuration()](/python/api/azureml-core/azureml.core.webservice.aci.aciwebservice#deploy-configuration-cpu-cores-none--memory-gb-none--tags-none--properties-none--description-none--location-none--auth-enabled-none--ssl-enabled-none--enable-app-insights-none--ssl-cert-pem-file-none--ssl-key-pem-file-none--ssl-cname-none--dns-name-label-none--primary-key-none--secondary-key-none--collect-model-data-none--cmk-vault-base-url-none--cmk-key-name-none--cmk-key-version-none-) reference
150-
* [Where and how to deploy](how-to-deploy-online-endpoints.md)
151+
* [AciWebservice.deploy_configuration()](/python/api/azureml-core/azureml.core.webservice.aci.aciwebservice#deploy-configuration-cpu-cores-none--memory-gb-none--tags-none--properties-none--description-none--location-none--auth-enabled-none--ssl-enabled-none--enable-app-insights-none--ssl-cert-pem-file-none--ssl-key-pem-file-none--ssl-cname-none--dns-name-label-none--primary-key-none--secondary-key-none--collect-model-data-none--cmk-vault-base-url-none--cmk-key-name-none--cmk-key-version-none-)
151152
* [Deploy a model to Azure Container Instances (SDK/CLI v1)](v1/how-to-deploy-azure-container-instance.md)
152153
153154
For more information on using a customer-managed key with ACI, see [Encrypt deployment data](../container-instances/container-instances-encrypt-data.md).
154-
155+
:::moniker-end
155156
### Azure Kubernetes Service
156157
157158
You may encrypt a deployed Azure Kubernetes Service resource using customer-managed keys at any time. For more information, see [Bring your own keys with Azure Kubernetes Service](../aks/azure-disk-customer-managed-keys.md).

articles/machine-learning/includes/machine-learning-customer-managed-keys.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,33 @@ ms.service: machine-learning
44
ms.topic: include
55
ms.date: 03/08/2022
66
ms.author: larryfr
7+
monikerRange: 'azureml-api-2 || azureml-api-1'
78
---
89

910
Customer-managed keys are used with the following services that Azure Machine Learning relies on:
1011

11-
| Service | What it’s used for |
12+
:::moniker range="azureml-api-2"
13+
| Service | What it's used for |
1214
| ----- | ----- |
1315
| Azure Cosmos DB | Stores metadata for Azure Machine Learning |
1416
| Azure Cognitive Search | Stores workspace metadata for Azure Machine Learning |
15-
| Azure Storage Account | Stores workspace metadata for Azure Machine Learning |
16-
| Azure Container Instance | Hosting trained models as inference endpoints |
17+
| Azure Storage Account | Stores workspace metadata for Azure Machine Learning |
18+
| Azure Kubernetes Service | Hosting trained models as inference endpoints |
19+
20+
> [!TIP]
21+
> * Azure Cosmos DB, Cognitive Search, and Storage Account are secured using the same key. You can use a different key for Azure Kubernetes Service.
22+
> * To use a customer-managed key with Azure Cosmos DB, Cognitive Search, and Storage Account, the key is provided when you create your workspace. The key used with Kubernetes Service is provided when configuring that resource.
23+
:::moniker-end
24+
:::moniker range="azureml-api-1"
25+
| Service | What it's used for |
26+
| ----- | ----- |
27+
| Azure Cosmos DB | Stores metadata for Azure Machine Learning |
28+
| Azure Cognitive Search | Stores workspace metadata for Azure Machine Learning |
29+
| Azure Storage Account | Stores workspace metadata for Azure Machine Learning |
1730
| Azure Kubernetes Service | Hosting trained models as inference endpoints |
31+
| Azure Container Instance | Hosting trained models as inference endpoints |
1832

1933
> [!TIP]
2034
> * Azure Cosmos DB, Cognitive Search, and Storage Account are secured using the same key. You can use a different key for Azure Kubernetes Service and Container Instance.
21-
> * To use a customer-managed key with Azure Cosmos DB, Cognitive Search, and Storage Account, the key is provided when you create your workspace. The key(s) used with Azure Container Instance and Kubernetes Service are provided when configuring those resources.
35+
> * To use a customer-managed key with Azure Cosmos DB, Cognitive Search, and Storage Account, the key is provided when you create your workspace. The key(s) used with Azure Container Instance and Kubernetes Service are provided when configuring those resources.
36+
:::moniker-end

articles/machine-learning/monitor-resource-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.reviewer: larryfr
99
ms.author: aashishb
1010
author: aashishb
1111
ms.custom: subject-monitoring engagement-fy23
12-
ms.date: 01/19/2023
12+
ms.date: 09/12/2023
1313
---
1414

1515
# Monitoring Azure Machine Learning data reference

0 commit comments

Comments
 (0)