Skip to content

Commit e1763a5

Browse files
committed
more changes
1 parent 14b27ad commit e1763a5

File tree

1 file changed

+33
-30
lines changed

1 file changed

+33
-30
lines changed

articles/machine-learning/how-to-manage-workspace-cli.md

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ You can also use the following methods to create and manage Azure Machine Learni
3030
## Prerequisites
3131

3232
- An Azure subscription with a free or paid version of Azure Machine Learning. If you don't have an Azure subscription, [create a free account before you begin](https://azure.microsoft.com/free/).
33-
- If you want to run the Azure CLI commands in this article locally, you need [Azure CLI](/cli/azure/install-azure-cli) v. 2.38.0 or greater installed.
33+
- If you want to run the Azure CLI commands in this article locally, you need [Azure CLI](/cli/azure/install-azure-cli) installed.
3434

35-
If you use [Azure Cloud Shell](https://azure.microsoft.com//features/cloud-shell/), you don't need to install anything. The browser accesses the latest cloud version of Azure CLI and the Azure Machine Learning extension.
35+
If you run the Azure CLI commands in [Azure Cloud Shell](https://azure.microsoft.com//features/cloud-shell/), you don't need to install anything. The browser accesses the latest cloud version of Azure CLI and the Azure Machine Learning extension.
3636

3737
## Limitations
3838

3939
[!INCLUDE [register-namespace](includes/machine-learning-register-namespace.md)]
4040

41-
- The following limitation applies to the Application Insights instance that's created during workspace creation:
41+
- The following limitation applies to the Application Insights instance created during workspace creation:
4242

4343
[!INCLUDE [application-insight](includes/machine-learning-application-insight.md)]
4444

@@ -93,7 +93,7 @@ To create a new workspace with new automatically created dependent services, run
9393
az ml workspace create -n <workspace-name> -g <resource-group-name>
9494
```
9595

96-
To create a new workspace that uses existing associated resources, you first define the resources in a YAML configuration file, as described in the following section. Then you reference the YAML file in the Azure CLI workspace creation command as follows:
96+
To create a new workspace that uses existing resources, you first define the resources in a YAML configuration file, as described in the following section. Then you reference the YAML file in the Azure CLI workspace creation command as follows:
9797

9898
```azurecli-interactive
9999
az ml workspace create -g <resource-group-name> --file <configuration-file>.yml
@@ -128,13 +128,13 @@ To use existing resources for a new workspace, you create a YAML configuration f
128128

129129
:::code language="YAML" source="~/azureml-examples-main/cli/resources/workspace/with-existing-resources.yml":::
130130

131-
You don't have to specify all the associated dependent resources in the configuration file. You can specify one or more of the resources, and the others are automatically created.
131+
You don't have to specify all the associated dependent resources in the configuration file. You can specify one or more of the resources, and let the others be automatically created.
132132

133133
If you use an existing storage account for the workspace, it must meet the following criteria. These requirements apply only to the *default* storage account for the workspace.
134134

135-
- Not a premium account (Premium_LRS or Premium_GRS).
136-
- Both Azure Blob and Azure File capabilities enabled.
137-
- For Azure Data Lake Storage, hierarchical namespace disabled.
135+
- Not a premium account (Premium_LRS or Premium_GRS)
136+
- Both Azure Blob and Azure File capabilities enabled
137+
- For Azure Data Lake Storage, hierarchical namespace disabled
138138

139139
To use an existing Azure container registry with an Azure Machine Learning workspace, you must [enable the admin account](/azure/container-registry/container-registry-authentication#admin-account) on the container registry.
140140

@@ -154,30 +154,19 @@ The query results look similar to the following string:<br>
154154

155155
## Secure Azure CLI communications
156156

157-
All Azure Machine Learning V2 `az ml` commands communicate operational data, such as YAML parameters and metadata, to Azure Resource Manager. If your Azure Machine Learning workspace is public and isn't behind a virtual network, communications are secured by using HTTPS/TLS 1.2. No extra configuration is required.
157+
All Azure Machine Learning V2 `az ml` commands communicate operational data, such as YAML parameters and metadata, to Azure Resource Manager. Some of the Azure CLI commands communicate with Azure Resource Manager over the internet. If your Azure Machine Learning workspace is public and isn't behind a virtual network, communications are secured by using HTTPS/TLS 1.2. No extra configuration is required.
158158

159159
If your Azure Machine Learning workspace uses a private endpoint and virtual network, you must choose one of the following configurations to use Azure CLI:
160160

161-
- To communicate over the public internet, set the `--public-network-access` parameter in the YAML configuration file to `Enabled`.
161+
- To communicate over the public internet, set the `--public-network-access` parameter to `Enabled`.
162162

163163
- To increase security and avoid communicating over the public internet, configure Azure Machine Learning to use private network connectivity with an Azure Private Link endpoint, as described in the following section.
164164

165-
### Configure workspace for private network connectivity
165+
### Private network connectivity
166166

167167
Depending on your use case and organizational requirements, you can configure Azure Machine Learning to use private network connectivity. You can use the Azure CLI to deploy a workspace and a Private Link endpoint for the workspace resource.
168168

169-
Use the following process to secure communications with Azure Resource Manager by using Private Link:
170-
171-
1. [Configure a private endpoint for your Azure Machine Learning workspace](how-to-configure-private-link.md).
172-
1. [Create a private link for managing Azure resources](/azure/azure-resource-manager/management/create-private-link-access-portal).
173-
1. [Create a private endpoint](/azure/azure-resource-manager/management/create-private-link-access-portal#create-private-endpoint) for the private link created in the previous step.
174-
175-
For more information on using a private endpoint and virtual network with your workspace, see [Virtual network isolation and privacy overview](how-to-network-security-overview.md). For complex resource configurations, also refer to template based deployment options including [Azure Resource Manager](how-to-create-workspace-template.md).
176-
177-
> [!IMPORTANT]
178-
> To configure the private link for Azure Resource Manager, you must be the **Owner** of the Azure subscription, and an **Owner** or **Contributor** on the root management group. For more information, see [Create a private link for managing Azure resources](/azure/azure-resource-manager/management/create-private-link-access-portal).
179-
180-
When you use Private Link, your workspace can't use Azure Container Registry to build Docker images. In your YAML workspace configuration file, you must set the `image_build_compute` property to a CPU compute cluster name to use for Docker image environment building. You also specify that the private link workspace isn't accessible over the internet by setting the `public_network_access` property to `Disabled`.
169+
When you use Private Link, your workspace can't use Azure Container Registry to build Docker images. In your YAML workspace configuration file, you must set the `image_build_compute` property to a CPU compute cluster name to use for Docker image environment building. You can also specify that the private link workspace isn't accessible over the internet by setting the `public_network_access` property to `Disabled`.
181170

182171
:::code language="YAML" source="~/azureml-examples-main/cli/resources/workspace/privatelink.yml":::
183172

@@ -235,12 +224,27 @@ az network private-endpoint dns-zone-group add \
235224
--zone-name 'privatelink.notebooks.azure.net'
236225
```
237226

227+
For more information on using a private endpoint and virtual network with your workspace, see:
228+
229+
- [Configure a private endpoint for your Azure Machine Learning workspace](how-to-configure-private-link.md).
230+
- [Virtual network isolation and privacy overview](how-to-network-security-overview.md)
231+
232+
### Resource management private links
233+
234+
You can use the following process to secure communications with all Azure Resource Manager resources in an Azure management group by using Private Link:
235+
236+
1. [Create a private link for managing Azure resources](/azure/azure-resource-manager/management/create-private-link-access-portal).
237+
1. [Create a private endpoint](/azure/azure-resource-manager/management/create-private-link-access-portal#create-private-endpoint) for the private link created in the previous step.
238+
239+
> [!IMPORTANT]
240+
> To configure a private link for Azure Resource Manager, you must be the **Owner** of the Azure subscription, and an **Owner** or **Contributor** on the root management group. For more information, see [Create a private link for managing Azure resources](/azure/azure-resource-manager/management/create-private-link-access-portal).
241+
238242
## Advanced configurations
239243

240-
There are several other advanced configurations you can apply to workspaces.
244+
There are several other advanced configurations you can apply to workspaces. For complex resource configurations, also refer to template based deployment options including [Azure Resource Manager](how-to-create-workspace-template.md).
241245

242-
<a name="#customer-managed-key-and-high-business-impact-workspace"></a>
243-
### Customer-managed key
246+
<a name="customer-managed-key-and-high-business-impact-workspace"></a>
247+
### Customer-managed keys
244248

245249
By default, workspace metadata is stored in an Azure Cosmos DB instance that Microsoft maintains, and encrypted using Microsoft-managed keys. Instead of using the Microsoft-managed key, you can provide your own key. Using your own key creates an extra set of resources in your Azure subscription to store your data.
246250

@@ -256,9 +260,9 @@ To learn more about the resources that are created when you use your own key for
256260
> [!NOTE]
257261
> To manage the added data encryption resources, use Identity and Access Management to authorize the Machine Learning App with **Contributor** permissions on your subscription.
258262
259-
### High business impact workspace
263+
### High business impact workspaces
260264

261-
To [limit the data that Microsoft collects](./concept-data-encryption.md#encryption-at-rest) on your workspace, you can specify a high business impact workspace by using the `hbi_workspace` property in the YAML configuration file. You can set high business impact only when you create a workspace. You can't change this setting after workspace creation.
265+
To [limit the data that Microsoft collects](./concept-data-encryption.md#encryption-at-rest) on your workspace, you can specify a high business impact workspace by setting the `hbi_workspace` property in the YAML configuration file to `TRUE`. You can set high business impact only when you create a workspace. You can't change this setting after workspace creation.
262266

263267
For more information on customer-managed keys and high business impact workspace, see [Enterprise security for Azure Machine Learning](concept-data-encryption.md#encryption-at-rest).
264268

@@ -321,8 +325,7 @@ To delete a workspace after it's no longer needed, use the following command:
321325
az ml workspace delete -n <workspace-name> -g <resource-group-name>
322326
```
323327

324-
> [!TIP]
325-
> The default behavior for Azure Machine Learning is to *soft delete* the workspace. The workspace isn't immediately deleted, but instead is marked for deletion. For more information, see [Soft delete](./concept-soft-delete.md).
328+
The default behavior for Azure Machine Learning is to *soft delete* the workspace. The workspace isn't immediately deleted, but instead is marked for deletion. For more information, see [Soft delete](./concept-soft-delete.md).
326329

327330
[!INCLUDE [machine-learning-delete-workspace](includes/machine-learning-delete-workspace.md)]
328331

0 commit comments

Comments
 (0)