New module: avm/ptn/authrization/resource-role-assignment

peterbud · May 9, 2024 · 72246e3 · 72246e3
1 parent 0ded575
commit 72246e3
Show file tree

Hide file tree

Showing 11 changed files with 840 additions and 0 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -4,6 +4,7 @@
 /avm/ @Azure/avm-core-team-technical-bicep
 /avm/utilities/ @Azure/avm-core-team-technical-bicep
 /avm/ptn/authorization/policy-assignment/ @Azure/avm-ptn-authorization-policyassignment-module-owners-bicep @Azure/avm-core-team-technical-bicep
+/avm/ptn/authorization/resource-role-assignment/ @Azure/avm-ptn-authorization-resourceroleassignment-module-owners-bicep @Azure/avm-core-team-technical-bicep
 /avm/ptn/authorization/role-assignment/ @Azure/avm-ptn-authorization-roleassignment-module-owners-bicep @Azure/avm-core-team-technical-bicep
 /avm/ptn/security/security-center/ @Azure/avm-ptn-security-securitycenter-module-owners-bicep @Azure/avm-core-team-technical-bicep
 /avm/res/aad/domain-service/ @Azure/avm-res-aad-domainservice-module-owners-bicep @Azure/avm-core-team-technical-bicep

diff --git a/.github/ISSUE_TEMPLATE/avm_module_issue.yml b/.github/ISSUE_TEMPLATE/avm_module_issue.yml
@@ -39,6 +39,7 @@ body:
       options:
         - ""
         - "avm/ptn/authorization/policy-assignment"
+        - "avm/ptn/authorization/resource-role-assignment"
         - "avm/ptn/authorization/role-assignment"
         # - "avm/ptn/avd-lza/insights"
         # - "avm/ptn/avd-lza/management-plane"

diff --git a/avm/ptn/authorization/resource-role-assignment/README.md b/avm/ptn/authorization/resource-role-assignment/README.md
@@ -0,0 +1,274 @@
+# ResourceRole Assignments (All scopes) `[Microsoft.Authorization/resourceroleassignment]`
+
+This module deploys a Role Assignment for a specific resource.
+
+## Navigation
+
+- [Resource Types](#Resource-Types)
+- [Usage examples](#Usage-examples)
+- [Parameters](#Parameters)
+- [Outputs](#Outputs)
+- [Cross-referenced modules](#Cross-referenced-modules)
+- [Data Collection](#Data-Collection)
+
+## Resource Types
+
+| Resource Type | API Version |
+| :-- | :-- |
+
+## Usage examples
+
+The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.
+
+>**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
+
+>**Note**: To reference the module, please use the following syntax `br/public:avm/ptn/authorization/resource-role-assignment:<version>`.
+
+- [Resource Role Assignments](#example-1-resource-role-assignments)
+- [Resource Role Assignments](#example-2-resource-role-assignments)
+
+### Example 1: _Resource Role Assignments_
+
+This module deploys a Role Assignment at a Resource scope using minimal parameters.
+
+
+<details>
+
+<summary>via Bicep module</summary>
+
+```bicep
+module resourceRoleAssignment 'br/public:avm/ptn/authorization/resource-role-assignment:<version>' = {
+  name: 'resourceRoleAssignmentDeployment'
+  params: {
+    // Required parameters
+    name: 'arramin001'
+    principalId: '<principalId>'
+    resourceId: '<resourceId>'
+    roleDefinitionId: '2a2b9908-6ea1-4ae2-8e65-a410df84e7d1'
+    // Non-required parameters
+    location: '<location>'
+    principalType: 'ServicePrincipal'
+  }
+}
+```
+
+</details>
+<p>
+
+<details>
+
+<summary>via JSON Parameter file</summary>
+
+```json
+{
+  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
+  "contentVersion": "1.0.0.0",
+  "parameters": {
+    // Required parameters
+    "name": {
+      "value": "arramin001"
+    },
+    "principalId": {
+      "value": "<principalId>"
+    },
+    "resourceId": {
+      "value": "<resourceId>"
+    },
+    "roleDefinitionId": {
+      "value": "2a2b9908-6ea1-4ae2-8e65-a410df84e7d1"
+    },
+    // Non-required parameters
+    "location": {
+      "value": "<location>"
+    },
+    "principalType": {
+      "value": "ServicePrincipal"
+    }
+  }
+}
+```
+
+</details>
+<p>
+
+### Example 2: _Resource Role Assignments_
+
+This module deploys a Role Assignment at a Resource scope using common parameters.
+
+
+<details>
+
+<summary>via Bicep module</summary>
+
+```bicep
+module resourceRoleAssignment 'br/public:avm/ptn/authorization/resource-role-assignment:<version>' = {
+  name: 'resourceRoleAssignmentDeployment'
+  params: {
+    // Required parameters
+    name: 'arrawaf001'
+    principalId: '<principalId>'
+    resourceId: ''
+    roleDefinitionId: '2a2b9908-6ea1-4ae2-8e65-a410df84e7d1'
+    // Non-required parameters
+    location: '<location>'
+    principalType: 'ServicePrincipal'
+  }
+}
+```
+
+</details>
+<p>
+
+<details>
+
+<summary>via JSON Parameter file</summary>
+
+```json
+{
+  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
+  "contentVersion": "1.0.0.0",
+  "parameters": {
+    // Required parameters
+    "name": {
+      "value": "arrawaf001"
+    },
+    "principalId": {
+      "value": "<principalId>"
+    },
+    "resourceId": {
+      "value": ""
+    },
+    "roleDefinitionId": {
+      "value": "2a2b9908-6ea1-4ae2-8e65-a410df84e7d1"
+    },
+    // Non-required parameters
+    "location": {
+      "value": "<location>"
+    },
+    "principalType": {
+      "value": "ServicePrincipal"
+    }
+  }
+}
+```
+
+</details>
+<p>
+
+
+## Parameters
+
+**Required parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`name`](#parameter-name) | string | The unique guid name for the role assignment. |
+| [`principalId`](#parameter-principalid) | string | The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity). |
+| [`resourceId`](#parameter-resourceid) | string | The scope for the role assignment, fully qualified resourceId. |
+| [`roleDefinitionId`](#parameter-roledefinitionid) | string | You can provide the role definition as a fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. |
+
+**Optional parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`description`](#parameter-description) | string | The Description of role assignment. |
+| [`enableTelemetry`](#parameter-enabletelemetry) | bool | Enable/Disable usage telemetry for module. |
+| [`location`](#parameter-location) | string | Location deployment metadata. |
+| [`principalType`](#parameter-principaltype) | string | The principal type of the assigned principal ID. |
+| [`roleName`](#parameter-rolename) | string | The name for the role, used for logging. |
+
+### Parameter: `name`
+
+The unique guid name for the role assignment.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `principalId`
+
+The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity).
+
+- Required: Yes
+- Type: string
+
+### Parameter: `resourceId`
+
+The scope for the role assignment, fully qualified resourceId.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `roleDefinitionId`
+
+You can provide the role definition as a fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `description`
+
+The Description of role assignment.
+
+- Required: No
+- Type: string
+- Default: `''`
+
+### Parameter: `enableTelemetry`
+
+Enable/Disable usage telemetry for module.
+
+- Required: No
+- Type: bool
+- Default: `True`
+
+### Parameter: `location`
+
+Location deployment metadata.
+
+- Required: No
+- Type: string
+- Default: `[deployment().location]`
+
+### Parameter: `principalType`
+
+The principal type of the assigned principal ID.
+
+- Required: No
+- Type: string
+- Default: `''`
+- Allowed:
+  ```Bicep
+  [
+    ''
+    'Device'
+    'ForeignGroup'
+    'Group'
+    'ServicePrincipal'
+    'User'
+  ]
+  ```
+
+### Parameter: `roleName`
+
+The name for the role, used for logging.
+
+- Required: No
+- Type: string
+- Default: `''`
+
+
+## Outputs
+
+| Output | Type | Description |
+| :-- | :-- | :-- |
+| `name` | string | The GUID of the Role Assignment. |
+| `resourceId` | string | The resource ID of the Role Assignment. |
+| `roleName` | string | The name for the role, used for logging. |
+
+## Cross-referenced modules
+
+_None_
+
+## Data Collection
+
+The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the [repository](https://aka.ms/avm/telemetry). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at <https://go.microsoft.com/fwlink/?LinkID=824704>. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
diff --git a/avm/ptn/authorization/resource-role-assignment/main.bicep b/avm/ptn/authorization/resource-role-assignment/main.bicep
@@ -0,0 +1,106 @@
+metadata name = 'ResourceRole Assignments (All scopes)'
+metadata description = 'This module deploys a Role Assignment for a specific resource.'
+metadata owner = 'Azure/module-maintainers'
+
+targetScope = 'subscription'
+
+// TODO: maybe a multiple roles assigned to a single principal?
+
+@sys.description('Required. The scope for the role assignment, fully qualified resourceId.')
+param resourceId string
+
+@sys.description('Required. The unique guid name for the role assignment.')
+param name string
+
+@sys.description('Required. You can provide the role definition as a fully qualified ID in the following format: \'/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11\'.')
+param roleDefinitionId string
+
+@sys.description('Optional. The name for the role, used for logging.')
+param roleName string = ''
+
+@sys.description('Required. The Principal or Object ID of the Security Principal (User, Group, Service Principal, Managed Identity).')
+param principalId string
+
+@sys.description('Optional. The principal type of the assigned principal ID.')
+@allowed([
+  'ServicePrincipal'
+  'Group'
+  'User'
+  'ForeignGroup'
+  'Device'
+  ''
+])
+param principalType string = ''
+
+@sys.description('Optional. The Description of role assignment.')
+param description string = ''
+
+@sys.description('Optional. Location deployment metadata.')
+param location string = deployment().location
+
+@sys.description('Optional. Enable/Disable usage telemetry for module.')
+param enableTelemetry bool = true
+
+// =============== //
+//   Definitions   //
+// =============== //
+
+resource avmTelemetry 'Microsoft.Resources/deployments@2023-07-01' =
+  if (enableTelemetry) {
+    name: '46d3xbcp.ptn.authorization-resourceroleassignment.${replace('-..--..-', '.', '-')}.${substring(uniqueString(deployment().name, location), 0, 4)}'
+    properties: {
+      mode: 'Incremental'
+      template: {
+        '$schema': 'https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#'
+        contentVersion: '#_moduleVersion_#.0'
+        resources: []
+        outputs: {
+          telemetry: {
+            type: 'String'
+            value: 'For more information, see https://aka.ms/avm/TelemetryInfo'
+          }
+        }
+      }
+    }
+    location: location
+  }
+
+resource resourceRoleAssignment 'Microsoft.Resources/deployments@2023-07-01' = {
+  name: take('rra-${name}-${last(split(resourceId,'/'))}', 64)
+  properties: {
+    mode: 'Incremental'
+    expressionEvaluationOptions: {
+      scope: 'Outer'
+    }
+    template: loadJsonContent('modules/generic-role-assignment.json')
+    parameters: {
+      scope: {
+        value: resourceId
+      }
+      name: {
+        value: name
+      }
+      roleDefinitionId: {
+        value: roleDefinitionId
+      }
+      principalId: {
+        value: principalId
+      }
+      principalType: {
+        value: principalType
+      }
+      description: {
+        value: description
+      }
+    }
+  }
+}
+
+@sys.description('The GUID of the Role Assignment.')
+output name string = name
+
+@sys.description('The name for the role, used for logging.')
+output roleName string = roleName
+
+@sys.description('The resource ID of the Role Assignment.')
+output resourceId string = resourceRoleAssignment.properties.outputs.roleAssignmentId.value