Update-MgRoleManagementDirectoryRoleAssignment
Update the navigation property roleAssignments in roleManagement
Note
To view the beta release of this cmdlet, view Update-MgBetaRoleManagementDirectoryRoleAssignment
Syntax
Update-MgRoleManagementDirectoryRoleAssignment
-UnifiedRoleAssignmentId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AppScope <IMicrosoftGraphAppScope>]
[-AppScopeId <String>]
[-Condition <String>]
[-DirectoryScope <IMicrosoftGraphDirectoryObject>]
[-DirectoryScopeId <String>]
[-Id <String>]
[-Principal <IMicrosoftGraphDirectoryObject>]
[-PrincipalId <String>]
[-RoleDefinition <IMicrosoftGraphUnifiedRoleDefinition>]
[-RoleDefinitionId <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgRoleManagementDirectoryRoleAssignment
-UnifiedRoleAssignmentId <String>
-BodyParameter <IMicrosoftGraphUnifiedRoleAssignment>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgRoleManagementDirectoryRoleAssignment
-InputObject <IIdentityGovernanceIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AppScope <IMicrosoftGraphAppScope>]
[-AppScopeId <String>]
[-Condition <String>]
[-DirectoryScope <IMicrosoftGraphDirectoryObject>]
[-DirectoryScopeId <String>]
[-Id <String>]
[-Principal <IMicrosoftGraphDirectoryObject>]
[-PrincipalId <String>]
[-RoleDefinition <IMicrosoftGraphUnifiedRoleDefinition>]
[-RoleDefinitionId <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-MgRoleManagementDirectoryRoleAssignment
-InputObject <IIdentityGovernanceIdentity>
-BodyParameter <IMicrosoftGraphUnifiedRoleAssignment>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Update the navigation property roleAssignments in roleManagement
Parameters
-AdditionalProperties
Additional Parameters
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AppScope
appScope To construct, see NOTES section for APPSCOPE properties and create a hash table.
| Type: | IMicrosoftGraphAppScope |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AppScopeId
Identifier of the app specific scope when the assignment scope is app specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by a resource application only. For the entitlement management provider, use this property to specify a catalog. For example, /AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997. Supports $filter (eq, in). For example, /roleManagement/entitlementManagement/roleAssignments$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}'.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
unifiedRoleAssignment To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphUnifiedRoleAssignment |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Condition
.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectoryScope
directoryObject To construct, see NOTES section for DIRECTORYSCOPE properties and create a hash table.
| Type: | IMicrosoftGraphDirectoryObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DirectoryScopeId
Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications, unlike app scopes that are defined and understood by a resource application only. Supports $filter (eq, in).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Headers
Optional headers that will be added to the request.
| Type: | IDictionary |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Id
The unique identifier for an entity. Read-only.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IIdentityGovernanceIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Principal
directoryObject To construct, see NOTES section for PRINCIPAL properties and create a hash table.
| Type: | IMicrosoftGraphDirectoryObject |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrincipalId
Identifier of the principal to which the assignment is granted. Supported principals are users, role-assignable groups, and service principals. Supports $filter (eq, in).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgressAction
{{ Fill ProgressAction Description }}
| Type: | ActionPreference |
| Aliases: | proga |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
| Type: | String |
| Aliases: | RHV |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RoleDefinition
unifiedRoleDefinition To construct, see NOTES section for ROLEDEFINITION properties and create a hash table.
| Type: | IMicrosoftGraphUnifiedRoleDefinition |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RoleDefinitionId
Identifier of the unifiedRoleDefinition the assignment is for. Read-only. Supports $filter (eq, in).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UnifiedRoleAssignmentId
The unique identifier of unifiedRoleAssignment
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.Graph.PowerShell.Models.IIdentityGovernanceIdentity
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphUnifiedRoleAssignment
System.Collections.IDictionary
Outputs
Microsoft.Graph.PowerShell.Models.IMicrosoftGraphUnifiedRoleAssignment
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
APPSCOPE <IMicrosoftGraphAppScope>: appScope
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[DisplayName <String>]: Provides the display name of the app-specific resource represented by the app scope. Provided for display purposes since appScopeId is often an immutable, non-human-readable id. Read-only.[Type <String>]: Describes the type of app-specific resource represented by the app scope and is provided for display purposes, so a user interface can convey to the user the kind of app specific resource represented by the app scope. Read-only.
BODYPARAMETER <IMicrosoftGraphUnifiedRoleAssignment>: unifiedRoleAssignment
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[AppScope <IMicrosoftGraphAppScope>]: appScope[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[DisplayName <String>]: Provides the display name of the app-specific resource represented by the app scope. Provided for display purposes since appScopeId is often an immutable, non-human-readable id. Read-only.[Type <String>]: Describes the type of app-specific resource represented by the app scope and is provided for display purposes, so a user interface can convey to the user the kind of app specific resource represented by the app scope. Read-only.
[AppScopeId <String>]: Identifier of the app specific scope when the assignment scope is app specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by a resource application only. For the entitlement management provider, use this property to specify a catalog. For example, /AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997. Supports $filter (eq, in). For example, /roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}'.[Condition <String>]:[DirectoryScope <IMicrosoftGraphDirectoryObject>]: directoryObject[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted.
[DirectoryScopeId <String>]: Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications, unlike app scopes that are defined and understood by a resource application only. Supports $filter (eq, in).[Principal <IMicrosoftGraphDirectoryObject>]: directoryObject[PrincipalId <String>]: Identifier of the principal to which the assignment is granted. Supported principals are users, role-assignable groups, and service principals. Supports $filter (eq, in).[RoleDefinition <IMicrosoftGraphUnifiedRoleDefinition>]: unifiedRoleDefinition[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[Description <String>]: The description for the unifiedRoleDefinition. Read-only when isBuiltIn is true.[DisplayName <String>]: The display name for the unifiedRoleDefinition. Read-only when isBuiltIn is true. Required. Supports $filter (eq, in).[InheritsPermissionsFrom <IMicrosoftGraphUnifiedRoleDefinition-[]>]: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles (isBuiltIn is true) support this attribute. Supports $expand.[IsBuiltIn <Boolean?>]: Flag indicating whether the role definition is part of the default set included in Microsoft Entra or a custom definition. Read-only. Supports $filter (eq, in).[IsEnabled <Boolean?>]: Flag indicating whether the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true.[ResourceScopes <String-[]>]: List of the scopes or permissions the role definition applies to. Currently only / is supported. Read-only when isBuiltIn is true. DO NOT USE. This will be deprecated soon. Attach scope to role assignment.[RolePermissions <IMicrosoftGraphUnifiedRolePermission-[]>]: List of permissions included in the role. Read-only when isBuiltIn is true. Required.[AllowedResourceActions <String-[]>]: Set of tasks that can be performed on a resource. Required.[Condition <String>]: Optional constraints that must be met for the permission to be effective. Not supported for custom roles.[ExcludedResourceActions <String-[]>]: Set of tasks that may not be performed on a resource. Not yet supported.
[TemplateId <String>]: Custom template identifier that can be set when isBuiltIn is false but is read-only when isBuiltIn is true. This identifier is typically used if one needs an identifier to be the same across different directories.[Version <String>]: Indicates version of the role definition. Read-only when isBuiltIn is true.
[RoleDefinitionId <String>]: Identifier of the unifiedRoleDefinition the assignment is for. Read-only. Supports $filter (eq, in).
DIRECTORYSCOPE <IMicrosoftGraphDirectoryObject>: directoryObject
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted.
INPUTOBJECT <IIdentityGovernanceIdentity>: Identity Parameter
[AccessPackageAssignmentId <String>]: The unique identifier of accessPackageAssignment[AccessPackageAssignmentPolicyId <String>]: The unique identifier of accessPackageAssignmentPolicy[AccessPackageAssignmentRequestId <String>]: The unique identifier of accessPackageAssignmentRequest[AccessPackageCatalogId <String>]: The unique identifier of accessPackageCatalog[AccessPackageId <String>]: The unique identifier of accessPackage[AccessPackageId1 <String>]: The unique identifier of accessPackage[AccessPackageQuestionId <String>]: The unique identifier of accessPackageQuestion[AccessPackageResourceEnvironmentId <String>]: The unique identifier of accessPackageResourceEnvironment[AccessPackageResourceId <String>]: The unique identifier of accessPackageResource[AccessPackageResourceRequestId <String>]: The unique identifier of accessPackageResourceRequest[AccessPackageResourceRoleId <String>]: The unique identifier of accessPackageResourceRole[AccessPackageResourceRoleId1 <String>]: The unique identifier of accessPackageResourceRole[AccessPackageResourceRoleScopeId <String>]: The unique identifier of accessPackageResourceRoleScope[AccessPackageResourceScopeId <String>]: The unique identifier of accessPackageResourceScope[AccessPackageResourceScopeId1 <String>]: The unique identifier of accessPackageResourceScope[AccessReviewHistoryDefinitionId <String>]: The unique identifier of accessReviewHistoryDefinition[AccessReviewHistoryInstanceId <String>]: The unique identifier of accessReviewHistoryInstance[AccessReviewInstanceDecisionItemId <String>]: The unique identifier of accessReviewInstanceDecisionItem[AccessReviewInstanceId <String>]: The unique identifier of accessReviewInstance[AccessReviewReviewerId <String>]: The unique identifier of accessReviewReviewer[AccessReviewScheduleDefinitionId <String>]: The unique identifier of accessReviewScheduleDefinition[AccessReviewStageId <String>]: The unique identifier of accessReviewStage[AgreementAcceptanceId <String>]: The unique identifier of agreementAcceptance[AgreementFileLocalizationId <String>]: The unique identifier of agreementFileLocalization[AgreementFileVersionId <String>]: The unique identifier of agreementFileVersion[AgreementId <String>]: The unique identifier of agreement[AppConsentRequestId <String>]: The unique identifier of appConsentRequest[ApprovalId <String>]: The unique identifier of approval[ApprovalStageId <String>]: The unique identifier of approvalStage[ConnectedOrganizationId <String>]: The unique identifier of connectedOrganization[CustomCalloutExtensionId <String>]: The unique identifier of customCalloutExtension[CustomExtensionStageSettingId <String>]: The unique identifier of customExtensionStageSetting[CustomTaskExtensionId <String>]: The unique identifier of customTaskExtension[DirectoryObjectId <String>]: The unique identifier of directoryObject[EndDateTime <DateTime?>]: Usage: endDateTime={endDateTime}[GovernanceInsightId <String>]: The unique identifier of governanceInsight[IncompatibleAccessPackageId <String>]: Usage: incompatibleAccessPackageId='{incompatibleAccessPackageId}'[On <String>]: Usage: on='{on}'[PrivilegedAccessGroupAssignmentScheduleId <String>]: The unique identifier of privilegedAccessGroupAssignmentSchedule[PrivilegedAccessGroupAssignmentScheduleInstanceId <String>]: The unique identifier of privilegedAccessGroupAssignmentScheduleInstance[PrivilegedAccessGroupAssignmentScheduleRequestId <String>]: The unique identifier of privilegedAccessGroupAssignmentScheduleRequest[PrivilegedAccessGroupEligibilityScheduleId <String>]: The unique identifier of privilegedAccessGroupEligibilitySchedule[PrivilegedAccessGroupEligibilityScheduleInstanceId <String>]: The unique identifier of privilegedAccessGroupEligibilityScheduleInstance[PrivilegedAccessGroupEligibilityScheduleRequestId <String>]: The unique identifier of privilegedAccessGroupEligibilityScheduleRequest[RunId <String>]: The unique identifier of run[StartDateTime <DateTime?>]: Usage: startDateTime={startDateTime}[TaskDefinitionId <String>]: The unique identifier of taskDefinition[TaskId <String>]: The unique identifier of task[TaskProcessingResultId <String>]: The unique identifier of taskProcessingResult[TaskReportId <String>]: The unique identifier of taskReport[UnifiedRbacResourceActionId <String>]: The unique identifier of unifiedRbacResourceAction[UnifiedRbacResourceNamespaceId <String>]: The unique identifier of unifiedRbacResourceNamespace[UnifiedRoleAssignmentId <String>]: The unique identifier of unifiedRoleAssignment[UnifiedRoleAssignmentScheduleId <String>]: The unique identifier of unifiedRoleAssignmentSchedule[UnifiedRoleAssignmentScheduleInstanceId <String>]: The unique identifier of unifiedRoleAssignmentScheduleInstance[UnifiedRoleAssignmentScheduleRequestId <String>]: The unique identifier of unifiedRoleAssignmentScheduleRequest[UnifiedRoleDefinitionId <String>]: The unique identifier of unifiedRoleDefinition[UnifiedRoleDefinitionId1 <String>]: The unique identifier of unifiedRoleDefinition[UnifiedRoleEligibilityScheduleId <String>]: The unique identifier of unifiedRoleEligibilitySchedule[UnifiedRoleEligibilityScheduleInstanceId <String>]: The unique identifier of unifiedRoleEligibilityScheduleInstance[UnifiedRoleEligibilityScheduleRequestId <String>]: The unique identifier of unifiedRoleEligibilityScheduleRequest[UserConsentRequestId <String>]: The unique identifier of userConsentRequest[UserId <String>]: The unique identifier of user[UserProcessingResultId <String>]: The unique identifier of userProcessingResult[WorkflowId <String>]: The unique identifier of workflow[WorkflowTemplateId <String>]: The unique identifier of workflowTemplate[WorkflowVersionNumber <Int32?>]: The unique identifier of workflowVersion
PRINCIPAL <IMicrosoftGraphDirectoryObject>: directoryObject
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted.
ROLEDEFINITION <IMicrosoftGraphUnifiedRoleDefinition>: unifiedRoleDefinition
[(Any) <Object>]: This indicates any property can be added to this object.[Id <String>]: The unique identifier for an entity. Read-only.[Description <String>]: The description for the unifiedRoleDefinition. Read-only when isBuiltIn is true.[DisplayName <String>]: The display name for the unifiedRoleDefinition. Read-only when isBuiltIn is true. Required. Supports $filter (eq, in).[InheritsPermissionsFrom <IMicrosoftGraphUnifiedRoleDefinition-[]>]: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles (isBuiltIn is true) support this attribute. Supports $expand.[IsBuiltIn <Boolean?>]: Flag indicating whether the role definition is part of the default set included in Microsoft Entra or a custom definition. Read-only. Supports $filter (eq, in).[IsEnabled <Boolean?>]: Flag indicating whether the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true.[ResourceScopes <String-[]>]: List of the scopes or permissions the role definition applies to. Currently only / is supported. Read-only when isBuiltIn is true. DO NOT USE. This will be deprecated soon. Attach scope to role assignment.[RolePermissions <IMicrosoftGraphUnifiedRolePermission-[]>]: List of permissions included in the role. Read-only when isBuiltIn is true. Required.[AllowedResourceActions <String-[]>]: Set of tasks that can be performed on a resource. Required.[Condition <String>]: Optional constraints that must be met for the permission to be effective. Not supported for custom roles.[ExcludedResourceActions <String-[]>]: Set of tasks that may not be performed on a resource. Not yet supported.
[TemplateId <String>]: Custom template identifier that can be set when isBuiltIn is false but is read-only when isBuiltIn is true. This identifier is typically used if one needs an identifier to be the same across different directories.[Version <String>]: Indicates version of the role definition. Read-only when isBuiltIn is true.