Skip to content

Commit 25e2cfb

Browse files
committed
revise the private endpoint article for AMR
1 parent b8917e7 commit 25e2cfb

File tree

2 files changed

+7
-83
lines changed

2 files changed

+7
-83
lines changed

articles/azure-cache-for-redis/managed-redis/managed-redis-private-link.md

Lines changed: 7 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -16,36 +16,13 @@ In this article, you learn how to create a virtual network and an Azure Managed
1616

1717
Azure Private Endpoint is a network interface that connects you privately and securely to Azure Managed Redis powered by Azure Private Link.
1818

19-
<!-- cawa - PublicNetworkAccess flag does not exist in AMR -->
20-
You can restrict public access to the private endpoint of your cache by disabling the `PublicNetworkAccess` flag.
21-
2219
>[!Important]
23-
> There is a `publicNetworkAccess` flag which is `Disabled` by default.
24-
> You can set the value to `Disabled` or `Enabled`. When set to enabled, this flag allows both public and private endpoint access to the cache. When set to `Disabled`, it allows only private endpoint access. Neither the Enterprise nor Enterprise Flash tier supports the `publicNetworkAccess` flag. For more information on how to change the value, see the [FAQ](#how-can-i-change-my-private-endpoint-to-be-disabled-or-enabled-from-public-network-access).
25-
26-
>[!Important]
27-
> Private endpoint is supported on cache tiers Basic, Standard, Premium, Enterprise, and Azure Managed Redis (Preview). We recommend using private endpoint instead of VNet Injection method. Private endpoints are easy to set up or remove, are supported on all tiers, and can connect your cache to multiple different VNets at once.
28-
>
29-
> When using the Basic tier, you might experience data loss when you delete and recreate a private endpoint.
30-
31-
## Scope of availability
32-
33-
|Tier | Basic, Standard, Premium |Enterprise, Enterprise Flash | Azure Managed Redis (Preview)
34-
|--------- |:------------------:|:---------:|:-------------:|
35-
|Available | Yes | Yes | Yes
20+
> Using private endpoint to connect to a Virtual Network is the recommended solution for securing your Azure Managed Redis (Preview) resource at the networking layer.
3621
3722
## Prerequisites
3823

3924
- Azure subscription - [create one for free](https://azure.microsoft.com/free/)
4025

41-
> [!IMPORTANT]
42-
> Currently, the [portal-based redis console](managed-redis-configure.md#redis-console) is not supported with private link.
43-
>
44-
45-
> [!IMPORTANT]
46-
> When using private link, you cannot export or import data to a to a storage account that has firewall enabled unless you're using a Premium tier cache with [managed identity to authenticate to the storage account](../cache-managed-identity.md).
47-
> For more information, see [What if I have firewall enabled on my storage account?](managed-redis-how-to-import-export-data.md#what-if-i-have-firewall-enabled-on-my-storage-account)
48-
>
4926

5027
## Create a private endpoint with a new Azure Managed Redis instance
5128

@@ -98,7 +75,7 @@ To create a cache instance, follow these steps:
9875

9976
| Setting | Suggested value | Description |
10077
| ------------ | ------- | -------------------------------------------------- |
101-
| **DNS name** | Enter a globally unique name. | The cache name must be a string between 1 and 63 characters. The string must contain only numbers, letters, or hyphens. The name must start and end with a number or letter, and can't contain consecutive hyphens. Your cache instance's *host name* is *\<DNS name>.redis.cache.windows.net*. |
78+
| **DNS name** | Enter a globally unique name. | The cache name must be a string between 1 and 63 characters. The string must contain only numbers, letters, or hyphens. The name must start and end with a number or letter, and can't contain consecutive hyphens. Your cache instance's *host name* is *\<DNS name>.\<region>.redis.azure.net*. |
10279
| **Subscription** | Drop down and select your subscription. | The subscription under which to create this new Azure Managed Redis instance. |
10380
| **Resource group** | Drop down and select a resource group, or select **Create new** and enter a new resource group name. | Name for the resource group in which to create your cache and other resources. By putting all your app resources in one resource group, you can easily manage or delete them together. |
10481
| **Location** | Drop down and select a location. | Select a [region](https://azure.microsoft.com/regions/) near other services that use your cache. |
@@ -130,11 +107,6 @@ To create a cache instance, follow these steps:
130107

131108
It takes a while for the cache to create. You can monitor progress on the Azure Managed Redis **Overview** page. When **Status** shows as **Running**, the cache is ready to use.
132109

133-
> [!IMPORTANT]
134-
> There is a `publicNetworkAccess` flag which is `Disabled` by default.
135-
> You can set the value to `Disabled` or `Enabled`. When set to `Enabled`, this flag allows both public and private endpoint access to the cache. When set to `Disabled`, it allows only private endpoint access. For more information on how to change the value, see the [FAQ](#how-can-i-change-my-private-endpoint-to-be-disabled-or-enabled-from-public-network-access).
136-
>
137-
>
138110

139111
## Create a private endpoint with an existing Azure Managed Redis instance
140112

@@ -200,7 +172,7 @@ To create a private endpoint, follow these steps:
200172

201173
1. Select the **Next: Resource** button at the bottom of the page.
202174

203-
1. In the **Resource** tab, select your subscription, choose the resource type as `Microsoft.Cache/Redis`, and then select the cache you want to connect the private endpoint to.
175+
1. In the **Resource** tab, select your subscription, choose the resource type as `Microsoft.Cache/redisEnterprise`, and then select the cache you want to connect the private endpoint to.
204176

205177
1. Select the **Next: Configuration** button at the bottom of the page.
206178

@@ -313,8 +285,8 @@ az network private-endpoint create \
313285
--resource-group $ResourceGroupName \
314286
--vnet-name $VNetName \
315287
--subnet $SubnetName \
316-
--private-connection-resource-id "/subscriptions/$SubscriptionId/resourceGroups/$ResourceGroupName/providers/Microsoft.Cache/Redis/$redisCacheName" \
317-
--group-ids "redisCache" \
288+
--private-connection-resource-id "/subscriptions/$SubscriptionId/resourceGroups/$ResourceGroupName/providers/Microsoft.Cache/redisEnterprise/$redisCacheName" \
289+
--group-ids "redisEnterprise" \
318290
--connection-name $PrivateConnectionName
319291
```
320292

@@ -349,78 +321,30 @@ az network private-endpoint delete --name MyPrivateEndpoint --resource-group MyR
349321

350322
### How do I connect to my cache with private endpoint?
351323

352-
For **Basic, Standard, and Premium tier** caches, your application should connect to `<cachename>.redis.cache.windows.net` on port `6380`. A private DNS zone, named `*.privatelink.redis.cache.windows.net`, is automatically created in your subscription. The private DNS zone is vital for establishing the TLS connection with the private endpoint. We recommend avoiding the use of `<cachename>.privatelink.redis.cache.windows.net` in configuration or connection string.
353-
354-
For **Enterprise and Enterprise Flash** tier caches, your application should connect to `<cachename>.<region>.redisenterprise.cache.azure.net` on port `10000`.
324+
Your application should connect to `<cachename>.<region>.redis.azure.net` on port `10000`. A private DNS zone, named `*.privatelink.redis.azure.net`, is automatically created in your subscription. The private DNS zone is vital for establishing the TLS connection with the private endpoint. We recommend avoiding the use of `<cachename>.privatelink.redis.azure.net` in configuration for client connection.
355325

356326
For more information, see [Azure services DNS zone configuration](/azure/private-link/private-endpoint-dns).
357327

358328
### Why can't I connect to a private endpoint?
359329

360330
- Private endpoints can't be used with your cache instance if your cache is already a VNet injected cache.
361331

362-
- For Basic, Standard, and Premium tier caches, you are limited to 100 private links.
363-
364-
- On Premium tier caches using clustering, you are limited to one private link.
365-
366-
- Enterprise and Enterprise Flash tier caches are limited to 84 private links.
332+
- Azure Managed Redis caches are limited to 84 private links.
367333

368334
- You try to [persist data to storage account](managed-redis-how-to-persistence.md) where firewall rules are applied might prevent you from creating the Private Link.
369335

370336
- You might not connect to your private endpoint if your cache instance is using an [unsupported feature](#what-features-arent-supported-with-private-endpoints).
371337

372-
### What features aren't supported with private endpoints?
373-
374-
- Trying to connect from the Azure portal console is an unsupported scenario where you see a connection failure.
375-
376-
- Private links can't be added to caches that are already using [passive geo-replication](../cache-how-to-geo-replication.md) in the Premium tier. To add a private link to a geo-replicated cache: 1. Unlink the geo-replication. 2. Add a Private Link. 3. Last, relink the geo-replication. (Enterprise tier caches using [active geo-replication](managed-redis-how-to-active-geo-replication.md) do not have this restriction.)
377-
378338
### How do I verify if my private endpoint is configured correctly?
379339

380340
Go to **Overview** in the Resource menu on the portal. You see the **Host name** for your cache in the working pane. Run a command like `nslookup <hostname>` from within the VNet that is linked to the private endpoint to verify that the command resolves to the private IP address for the cache.
381341

382342
:::image type="content" source="media/managed-redis-private-link/managed-redis-private-ip-address.png" alt-text="In the Azure portal, private endpoint D N S settings.":::
383343

384-
### How can I change my private endpoint to be disabled or enabled from public network access?
385-
386-
There's a `publicNetworkAccess` flag that is `Disabled` by default.
387-
When set to `Enabled`, this flag is allows both public and private endpoint access to the cache. When set to `Disabled`, it allows only private endpoint access. You can set the value to `Disabled` or `Enabled` in the Azure portal or with a RESTful API PATCH request.
388-
389-
To change the value in the Azure portal, follow these steps:
390-
391-
1. In the Azure portal, search for **Azure Managed Redis**. Then, press enter or select it from the search suggestions.
392-
393-
1. Select the cache instance you want to change the public network access value.
394-
395-
1. On the left side of the screen, select **Private Endpoint**.
396-
397-
1. Select the **Enable public network access** button.
398-
399-
You can also change the value through a RESTful API PATCH request. For example, use the following code for a Basic, Standard, or Premium tier cache and edit the value to reflect the flag you want for your cache.
400-
401-
```http
402-
PATCH https://management.azure.com/subscriptions/{subscription}/resourceGroups/{resourcegroup}/providers/Microsoft.Cache/Redis/{cache}?api-version=2020-06-01
403-
{ "properties": {
404-
"publicNetworkAccess":"Disabled"
405-
}
406-
}
407-
408-
```
409-
410-
For more information, see [Redis - Update](/rest/api/redis/Redis/Update?tabs=HTTP).
411-
412-
### How can I migrate my VNet injected cache to a Private Link cache?
413-
414-
Refer to our [migration guide](../cache-vnet-migration.md) for different approaches on how to migrate your VNet injected caches to Private Link caches.
415-
416344
### How can I have multiple endpoints in different virtual networks?
417345

418346
To have multiple private endpoints in different virtual networks, the private DNS zone must be manually configured to the multiple virtual networks *before* creating the private endpoint. For more information, see [Azure Private Endpoint DNS configuration](/azure/private-link/private-endpoint-dns).
419347

420-
### What happens if I delete all the private endpoints on my cache?
421-
422-
Once you delete the private endpoints on your cache, your cache instance can become unreachable until: you explicitly enable public network access, or you add another private endpoint. You can change the `publicNetworkAccess` flag on either the Azure portal or through a RESTful API PATCH request. For more information on how to change the value, see the [FAQ](#how-can-i-change-my-private-endpoint-to-be-disabled-or-enabled-from-public-network-access)
423-
424348
### Are network security groups (NSG) enabled for private endpoints?
425349

426350
No, they're disabled for private endpoints. While subnets containing the private endpoint can have NSG associated with it, the rules aren't effective on traffic processed by the private endpoint. You must have [network policies enforcement disabled](/azure/private-link/disable-private-endpoint-network-policy) to deploy private endpoints in a subnet. NSG is still enforced on other workloads hosted on the same subnet. Routes on any client subnet will be using an /32 prefix, changing the default routing behavior requires a similar UDR.
24.8 KB
Loading

0 commit comments

Comments
 (0)