From 042d1f7681d14273775b4172600197cf52821699 Mon Sep 17 00:00:00 2001
From: Nathan Turinski <naturins@microsoft.com>
Date: Tue, 23 Jul 2024 10:26:19 -0700
Subject: [PATCH] Better comments

---
 azure/index.d.ts | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/azure/index.d.ts b/azure/index.d.ts
index f4f601fd7f..a8f0bf720a 100644
--- a/azure/index.d.ts
+++ b/azure/index.d.ts
@@ -376,9 +376,12 @@ export declare class RoleAssignmentExecuteStep<T extends IResourceGroupWizardCon
      */
     public priority: number;
     /**
-    * @param getScopeId A function that returns the scope id for the role assignment. This typically won't exist until _after_ the resource is created,
-    * which is why it's a function that returns a string. If the scope id is undefined, the step will throw an error.
-    * @param roleDefinitionId The id of the role definition to assign. Use RoleDefinitionId enum for common role definitions
+    * @param getScopeId A function that returns the scope id for the role assignment.
+    * The scope ID is the Azure id of the resource that we are granting access to such as a storage account.
+    * Example: `/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx/resourceGroups/rgName/providers/Microsoft.Storage/storageAccounts/resourceName`
+    * This typically won't exist until _after_ the resource is created, which is why it's a function that returns a string.
+    * If the scope ID is undefined, the step will throw an error.
+    * @param roleDefinition The ARM role definition to assign. Use CommonRoleDefinition constant for role defintions that don't require user input.
     * */
     public constructor(getScopeId: () => string | undefined, roleDefinition: RoleDefinition);