Skip to content

Commit 807bc21

Browse files
Merge pull request #289421 from aybatra/roles-permissions
New article: Roles and Permissions
2 parents 56d634f + 0a2efc5 commit 807bc21

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

articles/vpn-gateway/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
href: vpn-gateway-highlyavailable.md
3232
- name: About VPN Gateway settings
3333
href: vpn-gateway-about-vpn-gateway-settings.md
34+
- name: Roles and permissions
35+
href: roles-permissions.md
3436
- name: About gateway SKUs
3537
href: about-gateway-skus.md
3638
- name: About gateway SKU consolidation
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
title: About VPN Gateway roles and permissions
3+
titleSuffix: VPN Gateway
4+
description: Learn about roles and permissions for VPN Gateway.
5+
author: aybatra
6+
ms.service: azure-vpn-gateway
7+
ms.topic: conceptual
8+
ms.date: 10/29/2024
9+
ms.author: cherylmc
10+
11+
---
12+
# About roles and permissions for VPN Gateway
13+
14+
The VPN Gateway utilizes multiple resources, such as virtual networks and IP addresses, during both creation and management operations.
15+
Because of this, it's essential to verify permissions on all involved resources during these operations.
16+
17+
## Azure built-in roles
18+
19+
You can choose to assign [Azure built-in roles](../role-based-access-control/built-in-roles.md) to a user, group, service principal, or managed identity such as [Network contributor](../role-based-access-control/built-in-roles.md#network-contributor), which support all the required permissions for creating the gateway.
20+
For more information, see [Steps to assign an Azure role](../role-based-access-control/role-assignments-steps.md).
21+
22+
## Custom roles
23+
24+
If the [Azure built-in roles](../role-based-access-control/built-in-roles.md) don't meet the specific needs of your organization, you can create your own custom roles.
25+
Just like built-in roles, you can assign custom roles to users, groups, and service principals at management group, subscription, and resource group scopes.
26+
For more information, see [Steps to create a custom role](../role-based-access-control/custom-roles.md#steps-to-create-a-custom-role) .
27+
28+
To ensure proper functionality, check your custom role permissions to confirm user service principals, and managed identities operating the VPN gateway have the necessary permissions.
29+
To add any missing permissions listed here, see [Update a custom role](../role-based-access-control/custom-roles-portal.md#update-a-custom-role).
30+
31+
## Permissions
32+
33+
Depending on whether you're creating new resources or using existing ones, add the appropriate permissions from the following list:
34+
35+
|Resource | Resource status | Required Azure permissions |
36+
|---|---|---|
37+
| Subnet | Create new| Microsoft.Network/virtualNetworks/subnets/write |
38+
| Subnet | Use existing| Microsoft.Network/virtualNetworks/subnets/join/action<br>Microsoft.Network/virtualNetworks/subnets/read |
39+
| IP addresses| Create new| Microsoft.Network/publicIPAddresses/write |
40+
| IP addresses | Use existing| Microsoft.Network/publicIPAddresses/join/action<br>Microsoft.Network/publicIPAddresses/read |
41+
42+
For more information, see [Azure permissions for Networking](../role-based-access-control/permissions/networking.md) and [Virtual network permissions](../virtual-network/virtual-network-manage-subnet.md#permissions).
43+
44+
## Roles scope
45+
46+
In the process of custom role definition, you can specify a role assignment scope at four levels: management group, subscription, resource group, and resources. To grant access, you assign roles to users, groups, service principals, or managed identities at a particular scope.
47+
48+
These scopes are structured in a parent-child relationship, with each level of hierarchy making the scope more specific. You can assign roles at any of these levels of scope, and the level you select determines how widely the role is applied.
49+
50+
For example, a role assigned at the subscription level can cascade down to all resources within that subscription, while a role assigned at the resource group level will only apply to resources within that specific group. Learn more about scope level
51+
For more information, see [Scope levels](../role-based-access-control/scope-overview.md#scope-levels).
52+
53+
> [!NOTE]
54+
> Allow sufficient time for [Azure Resource Manager cache](../role-based-access-control/troubleshooting.md) to refresh after role assignment changes.
55+
56+
## Next steps
57+
58+
[What is Azure Role Based Access](../role-based-access-control/overview.md)
59+
[Azure Role Based Access Control](../role-based-access-control/role-assignments-list-portal.yml)

0 commit comments

Comments
 (0)