Skip to content

Commit 9403474

Browse files
Merge pull request #199754 from lilinvictorms/private-link-v2
Update Azure Batch documents for No Public IP v2 public preview
2 parents c1d994e + 657e2ed commit 9403474

29 files changed

+475
-150
lines changed

articles/batch/TOC.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484
displayName: compute node, application package, scaling, schedule, os, configuration
8585
href: nodes-and-pools.md
8686
- name: Jobs and tasks
87-
displayName: Batch job, start task, environment
87+
displayName: Batch job, start task, environment
8888
href: jobs-and-tasks.md
8989
- name: Files and directories
9090
displayName: Batch file, working directory
@@ -113,8 +113,12 @@
113113
href: batch-management-dotnet.md
114114
- name: Get cost analysis and set budgets
115115
href: budget.md
116+
- name: Configure public network access with Batch accounts
117+
href: public-network-access.md
116118
- name: Use private endpoints with Batch accounts
117119
href: private-connectivity.md
120+
- name: Manage private endpoint connections with Batch accounts
121+
href: manage-private-endpoint-connections.md
118122
- name: Configure customer-managed keys
119123
href: batch-customer-managed-key.md
120124
- name: Move between regions
@@ -170,6 +174,9 @@
170174
- name: Create a pool without public IP addresses
171175
displayName: private
172176
href: batch-pool-no-public-ip-address.md
177+
- name: Create a simplified node communication pool without public IP addresses
178+
displayName: private
179+
href: simplified-node-communication-pool-no-public-ip.md
173180
- name: Create a pool with ephemeral OS disk nodes
174181
href: create-pool-ephemeral-os-disk.md
175182
- name: Use extensions with pools
@@ -253,7 +260,7 @@
253260
href: batch-js-get-started.md
254261
- name: Run workloads
255262
items:
256-
- name: MPI
263+
- name: MPI
257264
displayName: multi-instance, message passing interface
258265
href: batch-mpi.md
259266
- name: Container workloads

articles/batch/batch-account-create-portal.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,11 @@ For background about Batch accounts and scenarios, see [Batch service workflow a
3939

4040
:::image type="content" source="media/batch-account-create-portal/storage_account.png" alt-text="Screenshot of the options when creating a storage account.":::
4141

42-
1. If desired, select **Advanced** to specify **Identity type**, **Public network access** or **Pool allocation mode**. For most scenarios, the default options are fine.
42+
1. If desired, select **Advanced** to specify **Identity type**, **Pool allocation mode** or **Authentication mode**. For most scenarios, the default options are fine.
43+
44+
1. If desired, select **Networking** to configure [public network access](public-network-access.md) with your Batch account.
45+
46+
:::image type="content" source="media/batch-account-create-portal/batch-account-networking.png" alt-text="Screenshot of the networking options when creating a Batch account.":::
4347

4448
1. Select **Review + create**, then select **Create** to create the account.
4549

@@ -50,7 +54,7 @@ Once the account has been created, select the account to access its settings and
5054
> [!NOTE]
5155
> The name of the Batch account is its ID and can't be changed. If you need to change the name of a Batch account, you'll need to delete the account and create a new one with the intended name.
5256
53-
:::image type="content" source="media/batch-account-create-portal/batch_blade.png" alt-text="Screenshot of the Batch account page in the Azure portal.":::
57+
:::image type="content" source="media/batch-account-create-portal/batch-blade.png" alt-text="Screenshot of the Batch account page in the Azure portal.":::
5458

5559
When you develop an application with the [Batch APIs](batch-apis-tools.md#azure-accounts-for-batch-development), you need an account URL and key to access your Batch resources. (Batch also supports Azure Active Directory authentication.) To view the Batch account access information, select **Keys**.
5660

@@ -127,7 +131,7 @@ Make sure to set the following parameters based on your Batch pool's configurati
127131
For example:
128132

129133
```powershell
130-
Get-AzMarketplaceTerms -Publisher 'microsoft-azure-batch' -Product 'ubuntu-server-container' -Name '20-04-lts' | Set-AzMarketplaceTerms -Accept
134+
Get-AzMarketplaceTerms -Publisher 'microsoft-azure-batch' -Product 'ubuntu-server-container' -Name '20-04-lts' | Set-AzMarketplaceTerms -Accept
131135
```
132136

133137

articles/batch/batch-cli-templates.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,10 @@ The following is an example of a template that creates a pool of Linux VMs with
8989
"imageReference": {
9090
"publisher": "Canonical",
9191
"offer": "UbuntuServer",
92-
"sku": "16.04-LTS",
92+
"sku": "18.04-LTS",
9393
"version": "latest"
9494
},
95-
"nodeAgentSKUId": "batch.node.ubuntu 16.04"
95+
"nodeAgentSKUId": "batch.node.ubuntu 18.04"
9696
},
9797
"vmSize": "STANDARD_D3_V2",
9898
"targetDedicatedNodes": "[parameters('nodeCount')]",

articles/batch/batch-parallel-node-tasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ For more information on adding pools by using the REST API, see [Add a pool to a
145145
"offer": "ubuntuserver",
146146
"sku": "18.04-lts"
147147
},
148-
"nodeAgentSKUId": "batch.node.ubuntu 16.04"
148+
"nodeAgentSKUId": "batch.node.ubuntu 18.04"
149149
},
150150
"targetDedicatedComputeNodes":2,
151151
"taskSlotsPerNode":4,

articles/batch/batch-pool-no-public-ip-address.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,17 @@ ms.date: 01/11/2022
66
ms.custom: references_regions
77
---
88

9-
# Create an Azure Batch pool without public IP addresses (preview)
9+
# Create a Batch pool without public IP addresses (preview)
1010

1111
> [!IMPORTANT]
12-
> Support for pools without public IP addresses in Azure Batch is currently in public preview for the following regions: France Central, East Asia, West Central US, South Central US, West US 2, East US, North Europe, East US 2, Central US, West Europe, North Central US, West US, Australia East, Japan East, Japan West.
13-
> This preview version is provided without a service level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
14-
> For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
12+
> - Support for pools without public IP addresses in Azure Batch is currently in public preview for the following regions: France Central, East Asia, West Central US, South Central US, West US 2, East US, North Europe, East US 2, Central US, West Europe, North Central US, West US, Australia East, Japan East, Japan West.
13+
> - This preview version will be replaced by [Simplified node communication pool without public IP addresses](simplified-node-communication-pool-no-public-ip.md).
14+
> - This preview version is provided without a service level agreement, and it's not recommended for production workloads. Certain features might not be supported or might have constrained capabilities.
15+
> - For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
1516
1617
When you create an Azure Batch pool, you can provision the virtual machine configuration pool without a public IP address. This article explains how to set up a Batch pool without public IP addresses.
1718

18-
## Why use a pool without public IP Addresses?
19+
## Why use a pool without public IP addresses?
1920

2021
By default, all the compute nodes in an Azure Batch virtual machine configuration pool are assigned a public IP address. This address is used by the Batch service to schedule tasks and for communication with compute nodes, including outbound access to the internet.
2122

@@ -59,7 +60,7 @@ To restrict access to these nodes and reduce the discoverability of these nodes
5960

6061
## Use the Batch REST API to create a pool without public IP addresses
6162

62-
The example below shows how to use the [Azure Batch REST API](/rest/api/batchservice/pool/add) to create a pool that uses public IP addresses.
63+
The example below shows how to use the [Batch Service REST API](/rest/api/batchservice/pool/add) to create a pool that uses public IP addresses.
6364

6465
### REST API URI
6566

@@ -78,9 +79,9 @@ client-request-id: 00000000-0000-0000-0000-000000000000
7879
"imageReference": {
7980
"publisher": "Canonical",
8081
"offer": "UbuntuServer",
81-
"sku": "16.040-LTS"
82+
"sku": "18.04-lts"
8283
},
83-
"nodeAgentSKUId": "batch.node.ubuntu 16.04"
84+
"nodeAgentSKUId": "batch.node.ubuntu 18.04"
8485
}
8586
"networkConfiguration": {
8687
"subnetId": "/subscriptions/<your_subscription_id>/resourceGroups/<your_resource_group>/providers/Microsoft.Network/virtualNetworks/<your_vnet_name>/subnets/<your_subnet_name>",
@@ -98,11 +99,11 @@ client-request-id: 00000000-0000-0000-0000-000000000000
9899
"enableAutoScale": false,
99100
"enableInterNodeCommunication": true,
100101
"metadata": [
101-
{
102-
"name": "myproperty",
103-
"value": "myvalue"
104-
}
105-
]
102+
{
103+
"name": "myproperty",
104+
"value": "myvalue"
105+
}
106+
]
106107
}
107108
```
108109

articles/batch/create-pool-availability-zones.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@ Request body
5858
"imageReference": {
5959
"publisher": "Canonical",
6060
"offer": "UbuntuServer",
61-
"sku": "16.040-LTS"
61+
"sku": "18.04-lts"
6262
},
6363
"nodePlacementConfiguration": {
6464
"policy": "Zonal"
6565
}
66-
"nodeAgentSKUId": "batch.node.ubuntu 16.04"
66+
"nodeAgentSKUId": "batch.node.ubuntu 18.04"
6767
},
6868
"resizeTimeout": "PT15M",
6969
"targetDedicatedNodes": 5,
@@ -78,4 +78,4 @@ Request body
7878

7979
- Learn about the [Batch service workflow and primary resources](batch-service-workflow-features.md) such as pools, nodes, jobs, and tasks.
8080
- Learn about [creating a pool in a subnet of an Azure virtual network](batch-virtual-network.md).
81-
- Learn about [creating an Azure Batch pool without public IP addresses](./batch-pool-no-public-ip-address.md).
81+
- Learn about [creating an Azure Batch pool without public IP addresses](./simplified-node-communication-pool-no-public-ip.md).

articles/batch/create-pool-public-ip.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ ms.date: 12/20/2021
77

88
# Create an Azure Batch pool with specified public IP addresses
99

10-
In Azure Batch, you can [create a Batch pool in a subnet of an Azure virtual network (VNet)](batch-virtual-network.md). Virtual machines (VMs) in the Batch pool are accessible through public IP addresses that Batch creates. These public IP addresses can change over the lifetime of the pool. If the IP addresses aren't refreshed, your network settings might become outdated.
10+
In Azure Batch, you can [create a Batch pool in a subnet of an Azure virtual network (VNet)](batch-virtual-network.md). Virtual machines (VMs) in the Batch pool are accessible through public IP addresses that Batch creates. These public IP addresses can change over the lifetime of the pool. If the IP addresses aren't refreshed, your network settings might become outdated.
1111

12-
You can create a list of static public IP addresses to use with the VMs in your pool instead. In some cases, you might need to control the list of public IP addresses to make sure they don't change unexpectedly. For example, you might be working with an external service, such as a database, which restricts access to specific IP addresses.
12+
You can create a list of static public IP addresses to use with the VMs in your pool instead. In some cases, you might need to control the list of public IP addresses to make sure they don't change unexpectedly. For example, you might be working with an external service, such as a database, which restricts access to specific IP addresses.
1313

14-
For information about creating pools without public IP addresses, read [Create an Azure Batch pool without public IP addresses](./batch-pool-no-public-ip-address.md).
14+
For information about creating pools without public IP addresses, read [Create an Azure Batch pool without public IP addresses](./simplified-node-communication-pool-no-public-ip.md).
1515

1616
## Prerequisites
1717

@@ -27,19 +27,19 @@ For information about creating pools without public IP addresses, read [Create a
2727
Create one or more public IP addresses through one of these methods:
2828
- Use the [Azure portal](../virtual-network/ip-services/virtual-network-public-ip-address.md#create-a-public-ip-address)
2929
- Use the [Azure Command-Line Interface (Azure CLI)](/cli/azure/network/public-ip#az-network-public-ip-create)
30-
- Use [Azure PowerShell](/powershell/module/az.network/new-azpublicipaddress).
30+
- Use [Azure PowerShell](/powershell/module/az.network/new-azpublicipaddress).
3131

3232
Make sure your public IP addresses meet the following requirements:
3333

3434
- Create the public IP addresses in the same subscription and region as the account for the Batch pool.
3535
- Set the **IP address assignment** to **Static**.
3636
- Set the **SKU** to **Standard**.
3737
- Specify a DNS name.
38-
- Make sure no other resources use these public IP addresses, or the pool might experience allocation failures. Only use these public IP addresses for the VM configuration pools.
38+
- Make sure no other resources use these public IP addresses, or the pool might experience allocation failures. Only use these public IP addresses for the VM configuration pools.
3939
- Make sure that no security policies or resource locks restrict user access to the public IP address.
40-
- Create enough public IP addresses for the pool to accommodate the number of target VMs.
41-
- This number must equal at least the sum of the **targetDedicatedNodes** and **targetLowPriorityNodes** properties of the pool.
42-
- If you don't create enough IP addresses, the pool partially allocates the compute nodes, and a resize error happens.
40+
- Create enough public IP addresses for the pool to accommodate the number of target VMs.
41+
- This number must equal at least the sum of the **targetDedicatedNodes** and **targetLowPriorityNodes** properties of the pool.
42+
- If you don't create enough IP addresses, the pool partially allocates the compute nodes, and a resize error happens.
4343
- Currently, Batch uses one public IP address for every 100 VMs.
4444
- Also create a buffer of public IP addresses. A buffer helps Batch with internal optimization for scaling down. A buffer also allows quicker scaling up after an unsuccessful scale up or scale down. We recommend adding one of the following amounts of buffer IP addresses; choose whichever number is greater.
4545
- Add at least one more IP address.
@@ -69,9 +69,9 @@ Request body:
6969
"imageReference": {
7070
"publisher": "Canonical",
7171
"offer": "UbuntuServer",
72-
"sku": "16.04.0-LTS"
72+
"sku": "18.04-LTS"
7373
},
74-
"nodeAgentSKUId": "batch.node.ubuntu 16.04"
74+
"nodeAgentSKUId": "batch.node.ubuntu 18.04"
7575
},
7676
"networkConfiguration": {
7777
"subnetId": "/subscriptions/<subId>/resourceGroups/<rgId>/providers/Microsoft.Network/virtualNetworks/<vNetId>/subnets/<subnetId>",
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: Manage private endpoint connections with Azure Batch accounts
3+
description: Learn how to manage private endpoint connections with Azure Batch accounts, including list, approve, reject and remove.
4+
ms.topic: how-to
5+
ms.date: 05/26/2022
6+
---
7+
8+
# Manage private endpoint connections with Azure Batch accounts
9+
10+
You can query and manage all existing private endpoint connections for your Batch account. Supported management operations include:
11+
12+
- Approve a pending connection.
13+
- Reject a connection (either in pending or approved state).
14+
- Remove a connection, which will remove the connection from Batch account and mark the associated private endpoint resource as Disconnected state.
15+
16+
## Azure portal
17+
18+
1. Go to your Batch account in Azure portal.
19+
1. In **Settings**, select **Networking** and go to tab **Private Access**.
20+
1. Select the private connection, then perform the Approve/Reject/Remove operation.
21+
22+
:::image type="content" source="media/private-connectivity/manage-private-connections.png" alt-text="Screenshot of managing private endpoint connections.":::
23+
24+
## Az PowerShell module
25+
26+
Examples using Az PowerShell module [`Az.Network`](/powershell/module/az.network#networking):
27+
28+
```PowerShell
29+
$accountResourceId = "/subscriptions/<subscription>/resourceGroups/<rg>/providers/Microsoft.Batch/batchAccounts/<account>"
30+
$pecResourceId = "$accountResourceId/privateEndpointConnections/<pe-connection-name>"
31+
32+
# List all private endpoint connections for Batch account
33+
Get-AzPrivateEndpointConnection -PrivateLinkResourceId $accountResourceId
34+
35+
# Show the specified private endpoint connection
36+
Get-AzPrivateEndpointConnection -ResourceId $pecResourceId
37+
38+
# Approve connection
39+
Approve-AzPrivateEndpointConnection -Description "Approved!" -ResourceId $pecResourceId
40+
41+
# Reject connection
42+
Deny-AzPrivateEndpointConnection -Description "Rejected!" -ResourceId $pecResourceId
43+
44+
# Remove connection
45+
Remove-AzPrivateEndpointConnection -ResourceId $pecResourceId
46+
```
47+
48+
## Azure CLI
49+
50+
Examples using Azure CLI ([`az network private-endpoint`](/cli/azure/network/private-endpoint)):
51+
52+
```sh
53+
accountResourceId="/subscriptions/<subscription>/resourceGroups/<rg>/providers/Microsoft.Batch/batchAccounts/<account>"
54+
pecResourceId="$accountResourceId/privateEndpointConnections/<pe-connection-name>"
55+
56+
# List all private endpoint connections for Batch account
57+
az network private-endpoint-connection list --id $accountResourceId
58+
59+
# Show the specified private endpoint connection
60+
az network private-endpoint-connection show --id $pecResourceId
61+
62+
# Approve connection
63+
az network private-endpoint-connection approve --description "Approved!" --id $pecResourceId
64+
65+
# Reject connection
66+
az network private-endpoint-connection reject --description "Rejected!" --id $pecResourceId
67+
68+
# Remove connection
69+
az network private-endpoint-connection delete --id $pecResourceId
70+
```
-15.4 KB
Loading
22.4 KB
Loading

0 commit comments

Comments
 (0)