Skip to content

Commit 279109f

Browse files
authored
Merge pull request #218531 from lilinvictorms/npipv2-ga
Update Batch documents for NPIPv2 GA
2 parents d811592 + 8e54b2f commit 279109f

File tree

4 files changed

+43
-46
lines changed

4 files changed

+43
-46
lines changed

articles/batch/batch-pools-without-public-ip-addresses-classic-retirement-migration-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.date: 09/01/2022
1010

1111
# Migrate pools without public IP addresses (classic) in Batch
1212

13-
The Azure Batch feature pools without public IP addresses (classic) will be retired on *March 31, 2023*. Learn how to migrate eligible pools to simplified compute node communication (preview) pools without public IP addresses. You must opt in to migrate your Batch pools.
13+
The Azure Batch feature pools without public IP addresses (classic) will be retired on *March 31, 2023*. Learn how to migrate eligible pools to simplified compute node communication pools without public IP addresses. You must opt in to migrate your Batch pools.
1414

1515
## About the feature
1616

@@ -44,7 +44,7 @@ When the Batch pools without public IP addresses (classic) feature retires on Ma
4444

4545
:::image type="content" source="media/certificates/scale-down-pool.png" alt-text="Screenshot that shows how to scale down a pool.":::
4646

47-
1. Scale out the pool again. The pool is then automatically migrated to the new version of the preview.
47+
1. Scale out the pool again. The pool is then automatically migrated to the new version.
4848

4949
:::image type="content" source="media/certificates/scale-out-pool.png" alt-text="Screenshot that shows how to scale out a pool.":::
5050

articles/batch/private-connectivity.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Use private endpoints with Azure Batch accounts
33
description: Learn how to connect privately to an Azure Batch account by using private endpoints.
44
ms.topic: how-to
5-
ms.date: 05/26/2022
5+
ms.date: 12/16/2022
66
ms.custom: references_regions
77
---
88

@@ -22,14 +22,13 @@ Batch account resource has two endpoints supported to access with private endpoi
2222

2323
- Account endpoint (sub-resource: **batchAccount**): this endpoint is used for accessing [Batch Service REST API](/rest/api/batchservice/) (data plane), for example managing pools, compute nodes, jobs, tasks, etc.
2424

25-
- Node management endpoint (sub-resource: **nodeManagement**): used by Batch pool nodes to access Batch node management service. This endpoint is only applicable when using [simplified compute node communication](simplified-compute-node-communication.md). This feature is in preview.
26-
27-
> [!IMPORTANT]
28-
> - This preview sub-resource 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.
29-
> - For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
25+
- Node management endpoint (sub-resource: **nodeManagement**): used by Batch pool nodes to access Batch node management service. This endpoint is only applicable when using [simplified compute node communication](simplified-compute-node-communication.md).
3026

3127
:::image type="content" source="media/private-connectivity/private-endpoint-sub-resources.png" alt-text="Diagram that shows sub-resources for Batch private endpoints.":::
3228

29+
> [!TIP]
30+
> You can create private endpoint for one of them or both within your virtual network, depending on the actual usage for your Batch account. For example, if you run Batch pool within the virtual network, but call Batch service REST API from somewhere else, you will only need to create the **nodeManagement** private endpoint in the virtual network.
31+
3332
## Azure portal
3433

3534
Use the following steps to create a private endpoint with your Batch account using the Azure portal:
@@ -60,14 +59,17 @@ Use the following steps to create a private endpoint with your Batch account usi
6059
6160
## Use the private endpoint
6261

63-
After the private endpoint is provisioned, you can access the Batch account from within the same virtual network using the private endpoint.
62+
After the private endpoint is provisioned, you can access the Batch account using the private IP address within the virtual network:
6463

6564
- Private endpoint for **batchAccount**: can access Batch account data plane to manage pools/jobs/tasks.
6665

6766
- Private endpoint for **nodeManagement**: Batch pool's compute nodes can connect to and be managed by Batch node management service.
6867

68+
> [!TIP]
69+
> It's recommended to also disable the [public network access](public-network-access.md) with your Batch account when you're using private endpoints, which will restrict the access to private network only.
70+
6971
> [!IMPORTANT]
70-
> If [public network access](public-network-access.md) is disabled with Batch account, performing account operations (for example pools, jobs) outside of the virtual network where the private endpoint is provisioned will result in an "AuthorizationFailure" message for Batch account in the Azure portal.
72+
> If public network access is disabled with Batch account, performing account operations (for example pools, jobs) outside of the virtual network where the private endpoint is provisioned will result in an "AuthorizationFailure" message for Batch account in the Azure portal.
7173
7274
To view the IP addresses for the private endpoint from the Azure portal:
7375

articles/batch/simplified-node-communication-pool-no-public-ip.md

Lines changed: 29 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
---
2-
title: Create a simplified node communication pool without public IP addresses (preview)
2+
title: Create a simplified node communication pool without public IP addresses
33
description: Learn how to create an Azure Batch simplified node communication pool without public IP addresses.
44
ms.topic: how-to
5-
ms.date: 11/18/2022
5+
ms.date: 12/16/2022
66
ms.custom: references_regions
77
---
88

9-
# Create a simplified node communication pool without public IP addresses (preview)
9+
# Create a simplified node communication pool without public IP addresses
1010

1111
> [!NOTE]
1212
> This replaces the previous preview version of [Azure Batch pool without public IP addresses](batch-pool-no-public-ip-address.md). This new version requires [using simplified compute node communication](simplified-compute-node-communication.md).
1313
1414
> [!IMPORTANT]
15-
> - Support for pools without public IP addresses in Azure Batch is currently in public preview for [selected regions](simplified-compute-node-communication.md#supported-regions).
16-
> - 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.
17-
> - For more information, see [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
15+
> Support for pools without public IP addresses in Azure Batch is currently available for [select regions](simplified-compute-node-communication.md#supported-regions).
1816
1917
When you create an Azure Batch pool, you can provision the virtual machine (VM) configuration pool without a public IP address. This article explains how to set up a Batch pool without public IP addresses.
2018

@@ -27,7 +25,7 @@ To restrict access to these nodes and reduce the discoverability of these nodes
2725
## Prerequisites
2826

2927
> [!IMPORTANT]
30-
> The prerequisites have changed from the previous version of this preview. Make sure to review each item for changes before proceeding.
28+
> The prerequisites have changed from the previous preview version of this feature. Make sure to review each item for changes before proceeding.
3129
3230
- Use simplified compute node communication. For more information, see [Use simplified compute node communication](simplified-compute-node-communication.md).
3331

@@ -39,24 +37,16 @@ To restrict access to these nodes and reduce the discoverability of these nodes
3937

4038
- The subnet specified for the pool must have enough unassigned IP addresses to accommodate the number of VMs targeted for the pool; that is, the sum of the `targetDedicatedNodes` and `targetLowPriorityNodes` properties of the pool. If the subnet doesn't have enough unassigned IP addresses, the pool partially allocates the compute nodes, and a resize error occurs.
4139

42-
- If you plan to use a [private endpoint with Batch accounts](private-connectivity.md), you must disable private endpoint network policies. Run the following Azure CLI command:
43-
44-
```azurecli-interactive
45-
az network vnet subnet update \
46-
--vnet-name <vnetname> \
47-
-n <subnetname> \
48-
--resource-group <resourcegroup> \
49-
--disable-private-endpoint-network-policies
50-
```
40+
- If you plan to use private endpoint, and your virtual network has [private endpoint network policy](../private-link/disable-private-endpoint-network-policy.md) enabled, make sure the inbound connection with TCP/443 to the subnet hosting the private endpoint must be allowed from Batch pool's subnet.
5141

5242
- Enable outbound access for Batch node management. A pool with no public IP addresses doesn't have internet outbound access enabled by default. Choose one of the following options to allow compute nodes to access the Batch node management service (see [Use simplified compute node communication](simplified-compute-node-communication.md)):
5343

54-
- Use [**nodeManagement**](private-connectivity.md) private endpoint with Batch accounts, which provides private access to Batch node management service from the virtual network. This solution is the preferred method.
44+
- Use [**nodeManagement private endpoint**](private-connectivity.md) with Batch accounts, which provides private access to Batch node management service from the virtual network. This solution is the preferred method.
5545

5646
- Alternatively, provide your own internet outbound access support (see [Outbound access to the internet](#outbound-access-to-the-internet)).
5747

5848
> [!IMPORTANT]
59-
> There are two sub-resources for private endpoints with Batch accounts. Please use the **nodeManagement** private endpoint for the Batch pool without public IP addresses.
49+
> There are two sub-resources for private endpoints with Batch accounts. Please use the **nodeManagement** private endpoint for the Batch pool without public IP addresses. For more details please check [Use private endpoints with Azure Batch accounts](private-connectivity.md).
6050
6151
## Current limitations
6252

@@ -73,18 +63,18 @@ az network vnet subnet update \
7363
1. On the **Add Pool** window, select the option you intend to use from the **Image Type** dropdown.
7464
1. Select the correct **Publisher/Offer/Sku** of your image.
7565
1. Specify the remaining required settings, including the **Node size**, **Target dedicated nodes**, and **Target Spot/low-priority nodes**.
76-
1. For **Node communication mode**, select **simplified** under Optional Settings.
66+
1. For **Node communication mode**, select **Simplified** under Optional Settings.
7767
1. Select a virtual network and subnet you wish to use. This virtual network must be in the same location as the pool you're creating.
7868
1. In **IP address provisioning type**, select **NoPublicIPAddresses**.
7969

80-
The following screenshot shows the elements that are required to be modified to enable a pool without public
81-
IP addresses as specified above.
70+
The following screenshot shows the elements that's required to be modified to create a pool without public
71+
IP addresses.
8272

8373
![Screenshot of the Add pool screen with NoPublicIPAddresses selected.](./media/simplified-compute-node-communication/add-pool-simplified-mode-no-public-ip.png)
8474

8575
## Use the Batch REST API to create a pool without public IP addresses
8676

87-
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.
77+
The following example shows how to use the [Batch Service REST API](/rest/api/batchservice/pool/add) to create a pool that uses public IP addresses.
8878

8979
### REST API URI
9080

@@ -143,7 +133,7 @@ If you're familiar with using ARM templates, select the **Deploy to Azure** butt
143133
[![Deploy to Azure](../media/template-deployments/deploy-to-azure.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.batch%2Fbatch-pool-no-public-ip%2Fazuredeploy.json)
144134

145135
> [!NOTE]
146-
> If the private endpoint deployment failed due to invalid groupId "nodeManagement", please check if the region is in the supported list, and your pool is using [Simplified compute node communication](simplified-compute-node-communication.md). Choose the right region, specify `simplified` node communiction mode for the pool, and then retry the deployment.
136+
> If the private endpoint deployment failed due to invalid groupId "nodeManagement", please check if the region is in the supported list for [Simplified compute node communication](simplified-compute-node-communication.md). Choose the right region, and then retry the deployment.
147137
148138
## Outbound access to the internet
149139

@@ -160,11 +150,17 @@ Another way to provide outbound connectivity is to use a user-defined route (UDR
160150

161151
If compute nodes run into unusable state in a Batch pool without public IP addresses, the first and most important check is to verify the outbound access to the Batch node management service. It must be configured correctly so that compute nodes are able to connect to service from your virtual network.
162152

163-
If you're using **nodeManagement** private endpoint:
153+
#### Using **nodeManagement** private endpoint
154+
155+
If you created node management private endpoint in the virtual network for your Batch account:
164156

165-
- Check if the private endpoint is in provisioning succeeded state, and also in **Approved** status.
166-
- Check if the DNS configuration is set up correctly for the node management endpoint of your Batch account. You can confirm it by running `nslookup <nodeManagementEndpoint>` from within your virtual network, and the DNS name should be resolved to the private endpoint IP address.
167-
- Run TCP ping with the node management endpoint using default HTTPS port (443). This probe can tell if the private link connection is working as expected.
157+
- Check if the private endpoint is created in the right virtual network, in provisioning **Succeeded** state, and also in **Approved** status.
158+
- Check if the DNS configuration is set up correctly for the node management endpoint of your Batch account:
159+
- If your private endpoint is created with automatic private DNS zone integration, check the DNS A record is configured correctly in the private DNS zone `privatelink.batch.azure.com`, and the zone is linked to your virtual network.
160+
- If you're using your own DNS solution, make sure the DNS record for your Batch node management endpoint is configured correctly and point to the private endpoint IP address.
161+
- Check the DNS resolution for [Batch node management endpoint](batch-account-create-portal.md#view-batch-account-properties) of your account. You can confirm it by running `nslookup <nodeManagementEndpoint>` from within your virtual network, and the DNS name should be resolved to the private endpoint IP address.
162+
- If your virtual network has [private endpoint network policy](../private-link/disable-private-endpoint-network-policy.md) enabled, check NSG and UDR for subnets of both the Batch pool and the private endpoint. The inbound connection with TCP/443 to the subnet hosting the private endpoint must be allowed from Batch pool's subnet.
163+
- From the Batch pool's subnet, run TCP ping to the node management endpoint using default HTTPS port (443). This probe can tell if the private link connection is working as expected.
168164

169165
```
170166
# Windows
@@ -173,21 +169,20 @@ Test-TcpConnection -ComputeName <nodeManagementEndpoint> -Port 443
173169
nc -v <nodeManagementEndpoint> 443
174170
```
175171

176-
> [!TIP]
177-
> You can get the node management endpoint from your [Batch account's properties](batch-account-create-portal.md#view-batch-account-properties).
178-
179172
If the TCP ping fails (for example, timed out), it's typically an issue with the private link connection, and you can raise Azure support ticket with this private endpoint resource. Otherwise, this node unusable issue can be troubleshot as normal Batch pools, and you can raise support ticket with your Batch account.
180173

181-
If you're using your own internet outbound solution instead of private endpoint, run the same TCP ping with node management endpoint as shown above. If it's not working, check if your outbound access is configured correctly by following detailed requirements for [simplified compute node communication](simplified-compute-node-communication.md).
174+
#### Using your own internet outbound solution
175+
176+
If you're using your own internet outbound solution instead of private endpoint, run TCP ping to the node management endpoint. If it's not working, check if your outbound access is configured correctly by following detailed requirements for [simplified compute node communication](simplified-compute-node-communication.md).
182177

183178
### Connect to compute nodes
184179

185180
There's no internet inbound access to compute nodes in the Batch pool without public IP addresses. To access your compute nodes for debugging, you'll need to connect from within the virtual network:
186181

187182
- Use jumpbox machine inside the virtual network, then connect to your compute nodes from there.
188183
- Or, try using other remote connection solutions like [Azure Bastion](../bastion/bastion-overview.md):
189-
- Create Bastion in the virtual network with [IP based connection](../bastion/connect-ip-address.md) enabled.
190-
- Use Bastion to connect to the compute node using its IP address.
184+
- Create Bastion in the virtual network with [IP based connection](../bastion/connect-ip-address.md) enabled.
185+
- Use Bastion to connect to the compute node using its IP address.
191186

192187
You can follow the guide [Connect to compute nodes](error-handling.md#connect-to-compute-nodes) to get user credential and IP address for the target compute node in your Batch pool.
193188

@@ -198,7 +193,7 @@ For existing pools that use the [previous preview version of Azure Batch No Publ
198193
1. Create a [private endpoint for Batch node management](private-connectivity.md) in the virtual network.
199194
1. Update the pool's node communication mode to [simplified](simplified-compute-node-communication.md).
200195
1. Scale down the pool to zero nodes.
201-
1. Scale out the pool again. The pool is then automatically migrated to the new version of the preview.
196+
1. Scale out the pool again. The pool is then automatically migrated to the new version.
202197

203198
## Next steps
204199

articles/private-link/availability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ The following tables list the Private Link services and the regions where they'r
4646
|Supported services |Available regions | Other considerations | Status |
4747
|:-------------------|:-----------------|:----------------|:--------|
4848
|Azure-managed Disks | All public regions<br/> All Government regions<br/>All China regions | [Select for known limitations](../virtual-machines/disks-enable-private-links-for-import-export-portal.md#limitations) | GA <br/> [Learn how to create a private endpoint for Azure Managed Disks.](../virtual-machines/disks-enable-private-links-for-import-export-portal.md) |
49-
| Azure Batch (batchAccount) | All public regions<br/> All Government regions | | GA <br/> [Learn how to create a private endpoint for Azure Batch.](../batch/private-connectivity.md) |
50-
| Azure Batch (nodeManagement) | [Selected regions](../batch/simplified-compute-node-communication.md#supported-regions) | Supported for [simplified compute node communication](../batch/simplified-compute-node-communication.md) | Preview <br/> [Learn how to create a private endpoint for Azure Batch.](../batch/private-connectivity.md) |
49+
| Azure Batch (batchAccount) | All public regions<br/> All Government regions<br/>All China regions | | GA <br/> [Learn how to create a private endpoint for Azure Batch.](../batch/private-connectivity.md) |
50+
| Azure Batch (nodeManagement) | [Selected regions](../batch/simplified-compute-node-communication.md#supported-regions) | Supported for [simplified compute node communication](../batch/simplified-compute-node-communication.md) | GA <br/> [Learn how to create a private endpoint for Azure Batch.](../batch/private-connectivity.md) |
5151
| Azure Functions | All public regions | | GA </br> [Learn how to create a private endpoint for Azure Functions.](../azure-functions/functions-create-vnet.md) |
5252

5353
### Containers

0 commit comments

Comments
 (0)