Skip to content

Commit 0f43b1a

Browse files
committed
edits
1 parent 3280983 commit 0f43b1a

File tree

2 files changed

+35
-39
lines changed

2 files changed

+35
-39
lines changed

articles/machine-learning/includes/managed-vnet-note.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ ms.author: larryfr
88
---
99

1010
> [!TIP]
11-
> Microsoft recommends using Azure Machine Learning **managed virtual networks** instead of the steps in this article. With a managed virtual network, Azure Machine Learning handles the job of network isolation for your workspace and managed computes. You can also add private endpoints for resources needed by the workspace, such as Azure Storage Account. For more information, see [Workspace managed network isolation](../how-to-managed-network.md).
11+
> You can use Azure Machine Learning **managed virtual networks** instead of the steps in this article. With a managed virtual network, Azure Machine Learning handles the job of network isolation for your workspace and managed computes. You can also add private endpoints for resources needed by the workspace, such as Azure Storage Account. For more information, see [Workspace managed network isolation](../how-to-managed-network.md).

articles/machine-learning/tutorial-create-secure-workspace-template.md

Lines changed: 34 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Use a template to create a secure workspace"
2+
title: Use a template to create a secure workspace
33
titleSuffix: Azure Machine Learning
44
description: Use a template to create an Azure Machine Learning workspace and associated required Azure services inside a secure virtual network.
55
services: machine-learning
@@ -33,19 +33,19 @@ The Bicep template also creates an Azure Kubernetes Service (AKS) cluster, and a
3333

3434
[!INCLUDE [managed-vnet-note](includes/managed-vnet-note.md)]
3535

36-
Select the Bicep or Terraform tabs in the following sections to view the Bicep or Terraform information.
36+
To view either Bicep or Terraform information, select the Bicep or Terraform tabs in the following sections.
3737

3838
## Prerequisites
3939

4040
- 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](https://azure.microsoft.com/free/) before you begin.
4141

4242
- Git installed on your development environment to clone the template repository. If you don't have the `git` command, you can install Git from [https://git-scm.com/](https://git-scm.com/).
4343

44-
- Either a Bash or Azure PowerShell command line.
44+
- A Bash or Azure PowerShell command line.
4545

4646
# [Bicep](#tab/bicep)
4747

48-
- To install the command-line tools, see [Set up Bicep development and deployment environments](../azure-resource-manager/bicep/install.md).
48+
- To install the command-line tools, see [Set up Bicep development and deployment environments](/azure/azure-resource-manager/bicep/install).
4949

5050
- The Bicep template for this article is at [Azure Machine Learning end-to-end secure setup](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure). To clone the GitHub repo to your development environment and switch to the template directory, run the following commands:
5151

@@ -74,56 +74,52 @@ Select the Bicep or Terraform tabs in the following sections to view the Bicep o
7474

7575
# [Bicep](#tab/bicep)
7676

77-
The Bicep template is made up of the [main.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/main.bicep) and the *.bicep* files in the [modules](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules) subdirectory. The following table describes what each file is responsible for:
77+
The Bicep template is made up of the [main.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/main.bicep) and other *\*.bicep* files in the [modules](https://github.com/Azure/azure-quickstart-templates/tree/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules) subdirectory. The following table describes what each file is responsible for:
7878

7979
| File | Description |
8080
| ----- | ----- |
81-
| [main.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/main.bicep) | Parameters and variables. Passing parameters & variables to other modules in the `modules` subdirectory. |
82-
| [vnet.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/vnet.bicep) | Defines the Azure Virtual Network and subnets. |
83-
| [nsg.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/nsg.bicep) | Defines the network security group rules for the VNet. |
84-
| [bastion.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/bastion.bicep) | Defines the Azure Bastion host and subnet. Azure Bastion allows you to easily access a VM inside the VNet using your web browser. |
85-
| [dsvmjumpbox.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/dsvmjumpbox.bicep) | Defines the Data Science Virtual Machine (DSVM). Azure Bastion is used to access this VM through your web browser. |
81+
| [main.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/main.bicep) | Passes parameters and variables to other modules in the *modules* subdirectory.|
82+
| [vnet.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/vnet.bicep) | Defines the Azure virtual network and subnets. |
83+
| [nsg.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/nsg.bicep) | Defines the network security group rules for the virtual network. |
84+
| [bastion.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/bastion.bicep) | Defines the Azure Bastion host and subnet. Azure Bastion allows you to easily access a virtual machine (VM) inside the virtual network using your web browser. |
85+
| [dsvmjumpbox.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/dsvmjumpbox.bicep) | Defines the DSVM. Azure Bastion is used to access this VM through your web browser. |
8686
| [storage.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/storage.bicep) | Defines the Azure Storage account used by the workspace for default storage. |
8787
| [keyvault.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/keyvault.bicep) | Defines the Azure Key Vault used by the workspace. |
8888
| [containerregistry.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/containerregistry.bicep) | Defines the Azure Container Registry used by the workspace. |
8989
| [applicationinsights.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/applicationinsights.bicep) | Defines the Azure Application Insights instance used by the workspace. |
90-
| [machinelearningnetworking.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/machinelearningnetworking.bicep) | Defines the private endpoints and DNS zones for the Azure Machine Learning workspace. |
91-
| [Machinelearning.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/machinelearning.bicep) | Defines the Azure Machine Learning workspace. |
90+
| [machinelearningnetworking.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/machinelearningnetworking.bicep) | Defines the private endpoints and Domain Name System (DNS) zones for the workspace. |
91+
| [machinelearning.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/machinelearning.bicep) | Defines the Azure Machine Learning workspace. |
9292
| [machinelearningcompute.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/machinelearningcompute.bicep) | Defines an Azure Machine Learning compute cluster and compute instance. |
93-
| [privateaks.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/privateaks.bicep) | Defines an Azure Kubernetes Services cluster instance. |
93+
| [privateaks.bicep](https://github.com/Azure/azure-quickstart-templates/blob/master/quickstarts/microsoft.machinelearningservices/machine-learning-end-to-end-secure/modules/privateaks.bicep) | Defines an AKS cluster instance. |
9494

9595
> [!IMPORTANT]
96-
> The example templates might not always use the latest API version for Azure Machine Learning. Before using the template, you should modify it to use the latest API versions. For information on the latest API versions for Azure Machine Learning, see the [Azure Machine Learning REST API](/rest/api/azureml/).
96+
> The example templates might not always use the latest API version for Azure Machine Learning. Before using the template, you should modify it to use the latest API version. For information on the latest API version for Azure Machine Learning, see the [Azure Machine Learning REST API](/rest/api/azureml/).
9797
>
9898
> Each Azure service has its own set of API versions. For information on the API for a specific service, check the service information in the [Azure REST API reference](/rest/api/azure/).
9999
>
100-
> To update the API version, find the `Microsoft.MachineLearningServices/<resource>` entry for the resource type and update it to the latest version. The following example is an entry for the Azure Machine Learning workspace that uses an API version of `2022-05-01`:
101-
>
102-
>```json
103-
>resource machineLearning 'Microsoft.MachineLearningServices/workspaces@2022-05-01' = {
104-
>```
100+
> To update the API version, find the `Microsoft.MachineLearningServices/<resource>` entry for the resource type and update it to the latest version.
105101
106102
# [Terraform](#tab/terraform)
107103

108104
The template consists of multiple files. The following table describes what each file is responsible for:
109105

110106
| File | Description |
111107
| ----- | ----- |
112-
| [variables.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/variables.tf) | Variables and default values used by the template.
108+
| [variables.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/variables.tf) | Defines variables and default values used by the template.
113109
| [main.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/main.tf) | Specifies the Azure Resource Manager provider and defines the resource group. |
114-
| [network.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/network.tf) | Defines the Azure Virtual Network, subnets, and network security groups (NSG). |
115-
| [bastion.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/bastion.tf) | Defines the Azure Bastion host and associated NSG. Azure Bastion allows you to easily access a virtual machine (VM) inside a virtual network by using your web browser. |
110+
| [network.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/network.tf) | Defines the Azure virtual network, subnets, and network security groups (NSG). |
111+
| [bastion.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/bastion.tf) | Defines the Azure Bastion host and associated NSG. Azure Bastion allows you to easily access a VM inside a virtual network by using your web browser. |
116112
| [dsvm.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/dsvm.tf) | Defines the DSVM. Azure Bastion is used to access this VM through your web browser. |
117113
| [workspace.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/workspace.tf) | Defines the Azure Machine Learning workspace, including dependent resources for Azure Storage, Key Vault, Application Insights, and Container Registry. |
118114
| [compute.tf](https://github.com/Azure/terraform/blob/master/quickstart/201-machine-learning-moderately-secure/compute.tf) | Defines an Azure Machine Learning compute instance and cluster. |
119115

120116
> [!TIP]
121-
> The [Terraform Azure provider](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs) supports more arguments that aren't used in this tutorial. For example, the [environment](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs#environment) argument allows you to target cloud regions such as Azure Government and Microsoft Azure operated by 21Vianet.
117+
> The [Terraform Azure provider](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs) supports more arguments that this tutorial doesn't use. For example, the [environment](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs#environment) argument lets you target cloud regions such as Azure Government and Microsoft Azure operated by 21Vianet.
122118
123119
---
124120

125121
> [!IMPORTANT]
126-
> The DSVM and Azure Bastion are used as easy ways to connect to the secured workspace for this tutorial. In a production environment, it's best to use an [Azure VPN gateway](/azure/vpn-gateway/vpn-gateway-about-vpngateways) or [Azure ExpressRoute](/azure/expressroute/expressroute-introduction) to access the resources inside the virtual network directly from your on-premises network.
122+
> The DSVM and Azure Bastion are easy ways to connect to the secured workspace for this tutorial. In a production environment, it's best to use an [Azure VPN gateway](/azure/vpn-gateway/vpn-gateway-about-vpngateways) or [Azure ExpressRoute](/azure/expressroute/expressroute-introduction) to access the resources inside the virtual network directly from your on-premises network.
127123
128124
## Configure the template
129125

@@ -176,6 +172,8 @@ To deploy the Bicep template, run the following commands from the *machine-learn
176172
> [!WARNING]
177173
> You should avoid using plain text strings in scripts or from the command line. The plain text can show up in event logs and command history. For more information, see [ConvertTo-SecureString](/powershell/module/microsoft.powershell.security/convertto-securestring).
178174
175+
---
176+
179177
---
180178
181179
# [Terraform](#tab/terraform)
@@ -212,11 +210,18 @@ To deploy the Terraform template, use the following commands from the *201-machi
212210
213211
---
214212
213+
> [!IMPORTANT]
214+
> The DSVM and any compute resources bill you for every hour that they run. To avoid excess charges, you should stop these resources when they're not in use. For more information, see the following articles:
215+
>
216+
> - [Create/manage VMs (Linux)](/azure/virtual-machines/linux/tutorial-manage-vm).
217+
> - [Create/manage VMs (Windows)](/azure/virtual-machines/windows/tutorial-manage-vm).
218+
> - [Create compute instance](how-to-create-compute-instance.md).
219+
215220
## Connect to the workspace
216221
217222
After the deployment completes, use the following steps to connect to the DSVM:
218223
219-
1. From the [Azure portal](https://portal.azure.com), select the Azure Resource Group you used with the template. Then, select the DSVM that the template created. If you have trouble finding it, use the filters section to filter the __Type__ to __virtual machine__.
224+
1. From the [Azure portal](https://portal.azure.com), select the Azure resource group you used with the template. Then, select the DSVM that the template created. If you have trouble finding it, use the filters section to filter the __Type__ to __virtual machine__.
220225
221226
:::image type="content" source="./media/tutorial-create-secure-workspace-template/select-vm.png" alt-text="Screenshot of filtering and selecting the vm.":::
222227
@@ -235,27 +240,18 @@ After the deployment completes, use the following steps to connect to the DSVM:
235240
236241
The following error can occur when the name for the DSVM jump box is greater than 15 characters or includes one of the following characters: `~`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `(`, `)`, `=`, `+`, `_`, `[`, `]`, `{`, `}`, `\`, `|`, `;`, `:`, `.`, `'`, `"`, `,`, `<`, `>`, `/`, or `?`.
237242
238-
**Error: Windows computer name cannot be more than 15 characters long, be entirely numeric, or contain the following characters**
243+
**Error: Windows computer name cannot be more than 15 characters long, be entirely numeric, or contain the following characters.**
239244
240245
# [Bicep](#tab/bicep)
241246
242247
The Bicep template generates the jump box name programmatically by using the prefix value provided to the template. To make sure the name doesn't exceed 15 characters or contain any invalid characters, use a prefix that's five or fewer characters and doesn't use the characters `~`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `(`, `)`, `=`, `+`, `_`, `[`, `]`, `{`, `}`, `\`, `|`, `;`, `:`, `.`, `'`, `"`, `,`, `<`, `>`, `/`, or `?`.
243248
244249
# [Terraform](#tab/terraform)
245250
246-
The Terraform template passes the jump box name by using the `dsvm_name` parameter. To avoid the error, use a name that's not greater than 15 characters and doesn't use the characters `~`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `(`, `)`, `=`, `+`, `_`, `[`, `]`, `{`, `}`, `\`, `|`, `;`, `:`, `.`, `'`, `"`, `,`, `<`, `>`, `/`, or `?`.
247-
248-
> [!IMPORTANT]
249-
> The DSVM and any compute resources bill you for every hour that they run. To avoid excess charges, you should stop these resources when they're not in use. For more information, see the following articles:
250-
>
251-
> - [Create/manage VMs (Linux)](/azure/virtual-machines/linux/tutorial-manage-vm).
252-
> - [Create/manage VMs (Windows)](/azure/virtual-machines/windows/tutorial-manage-vm).
253-
> - [Create compute instance](how-to-create-compute-instance.md).
251+
The Terraform template passes the jump box name by using the `dsvm_name` parameter. To avoid the error, use a name that's 15 characters or fewer and doesn't use the characters `~`, `!`, `@`, `#`, `$`, `%`, `^`, `&`, `*`, `(`, `)`, `=`, `+`, `_`, `[`, `]`, `{`, `}`, `\`, `|`, `;`, `:`, `.`, `'`, `"`, `,`, `<`, `>`, `/`, or `?`.
254252
255-
## Next steps
253+
## Related content
256254
257-
:::moniker range="azureml-api-2"
258-
To continue learning how to use the secured workspace from the DSVM, see [Tutorial: Azure Machine Learning in a day](tutorial-azure-ml-in-a-day.md).
259-
:::moniker-end
255+
To continue getting started with Azure Machine Learning, see [Quickstart: Get started with Azure Machine Learning](tutorial-azure-ml-in-a-day.md).
260256
261257
To learn more about common secure workspace configurations and input/output requirements, see [Azure Machine Learning secure workspace traffic flow](concept-secure-network-traffic-flow.md).

0 commit comments

Comments
 (0)