Skip to content

Commit

Permalink
Better comments
Browse files Browse the repository at this point in the history
  • Loading branch information
nturinski committed Jul 23, 2024
1 parent 6fd5105 commit 042d1f7
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions azure/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down

0 comments on commit 042d1f7

Please sign in to comment.