New-MgBetaPrivilegedAccessRoleSetting
Create new navigation property to roleSettings for privilegedAccess
Syntax
New-MgBetaPrivilegedAccessRoleSetting
-PrivilegedAccessId <String>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AdminEligibleSettings <IMicrosoftGraphGovernanceRuleSetting[]>]
[-AdminMemberSettings <IMicrosoftGraphGovernanceRuleSetting[]>]
[-Id <String>]
[-IsDefault]
[-LastUpdatedBy <String>]
[-LastUpdatedDateTime <DateTime>]
[-Resource <IMicrosoftGraphGovernanceResource>]
[-ResourceId <String>]
[-RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
[-RoleDefinitionId <String>]
[-UserEligibleSettings <IMicrosoftGraphGovernanceRuleSetting[]>]
[-UserMemberSettings <IMicrosoftGraphGovernanceRuleSetting[]>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgBetaPrivilegedAccessRoleSetting
-PrivilegedAccessId <String>
-BodyParameter <IMicrosoftGraphGovernanceRoleSetting>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgBetaPrivilegedAccessRoleSetting
-InputObject <IIdentityGovernanceIdentity>
[-ResponseHeadersVariable <String>]
[-AdditionalProperties <Hashtable>]
[-AdminEligibleSettings <IMicrosoftGraphGovernanceRuleSetting[]>]
[-AdminMemberSettings <IMicrosoftGraphGovernanceRuleSetting[]>]
[-Id <String>]
[-IsDefault]
[-LastUpdatedBy <String>]
[-LastUpdatedDateTime <DateTime>]
[-Resource <IMicrosoftGraphGovernanceResource>]
[-ResourceId <String>]
[-RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
[-RoleDefinitionId <String>]
[-UserEligibleSettings <IMicrosoftGraphGovernanceRuleSetting[]>]
[-UserMemberSettings <IMicrosoftGraphGovernanceRuleSetting[]>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-MgBetaPrivilegedAccessRoleSetting
-InputObject <IIdentityGovernanceIdentity>
-BodyParameter <IMicrosoftGraphGovernanceRoleSetting>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Create new navigation property to roleSettings for privilegedAccess
Parameters
-AdditionalProperties
Additional Parameters
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AdminEligibleSettings
The rule settings that are evaluated when an administrator tries to add an eligible role assignment. To construct, see NOTES section for ADMINELIGIBLESETTINGS properties and create a hash table.
Type: | IMicrosoftGraphGovernanceRuleSetting[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AdminMemberSettings
The rule settings that are evaluated when an administrator tries to add a direct member role assignment. To construct, see NOTES section for ADMINMEMBERSETTINGS properties and create a hash table.
Type: | IMicrosoftGraphGovernanceRuleSetting[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BodyParameter
governanceRoleSetting To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
Type: | IMicrosoftGraphGovernanceRoleSetting |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
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 |
-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 |
-IsDefault
Read-only. Indicate if the roleSetting is a default roleSetting
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LastUpdatedBy
Read-only. The display name of the administrator who last updated the roleSetting.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-LastUpdatedDateTime
Read-only. The time when the role setting was last updated. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PrivilegedAccessId
The unique identifier of privilegedAccess
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
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 |
-Resource
governanceResource To construct, see NOTES section for RESOURCE properties and create a hash table.
Type: | IMicrosoftGraphGovernanceResource |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
Required. The id of the resource that the role setting is associated with.
Type: | String |
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
governanceRoleDefinition To construct, see NOTES section for ROLEDEFINITION properties and create a hash table.
Type: | IMicrosoftGraphGovernanceRoleDefinition |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RoleDefinitionId
Required. The id of the role definition that the role setting is associated with.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserEligibleSettings
The rule settings that are evaluated when a user tries to add an eligible role assignment. The setting is not supported for now. To construct, see NOTES section for USERELIGIBLESETTINGS properties and create a hash table.
Type: | IMicrosoftGraphGovernanceRuleSetting[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserMemberSettings
The rule settings that are evaluated when a user tries to activate his role assignment. To construct, see NOTES section for USERMEMBERSETTINGS properties and create a hash table.
Type: | IMicrosoftGraphGovernanceRuleSetting[] |
Position: | Named |
Default value: | None |
Required: | False |
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.Beta.PowerShell.Models.IIdentityGovernanceIdentity
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphGovernanceRoleSetting
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphGovernanceRoleSetting
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.
ADMINELIGIBLESETTINGS <IMicrosoftGraphGovernanceRuleSetting- []
>: The rule settings that are evaluated when an administrator tries to add an eligible role assignment.
[RuleIdentifier <String>]
: The id of the rule. For example, ExpirationRule and MfaRule.[Setting <String>]
: The settings of the rule. The value is a JSON string with a list of pairs in the format of ParameterName:ParameterValue. For example, {'permanentAssignment':false,'maximumGrantPeriodInMinutes':129600}
ADMINMEMBERSETTINGS <IMicrosoftGraphGovernanceRuleSetting- []
>: The rule settings that are evaluated when an administrator tries to add a direct member role assignment.
[RuleIdentifier <String>]
: The id of the rule. For example, ExpirationRule and MfaRule.[Setting <String>]
: The settings of the rule. The value is a JSON string with a list of pairs in the format of ParameterName:ParameterValue. For example, {'permanentAssignment':false,'maximumGrantPeriodInMinutes':129600}
BODYPARAMETER <IMicrosoftGraphGovernanceRoleSetting>
: governanceRoleSetting
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AdminEligibleSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when an administrator tries to add an eligible role assignment.[RuleIdentifier <String>]
: The id of the rule. For example, ExpirationRule and MfaRule.[Setting <String>]
: The settings of the rule. The value is a JSON string with a list of pairs in the format of ParameterName:ParameterValue. For example, {'permanentAssignment':false,'maximumGrantPeriodInMinutes':129600}
[AdminMemberSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when an administrator tries to add a direct member role assignment.[IsDefault <Boolean?>]
: Read-only. Indicate if the roleSetting is a default roleSetting[LastUpdatedBy <String>]
: Read-only. The display name of the administrator who last updated the roleSetting.[LastUpdatedDateTime <DateTime?>]
: Read-only. The time when the role setting was last updated. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the resource.[ExternalId <String>]
: The external id of the resource, representing its original id in the external system. For example, a subscription resource's external id can be '/subscriptions/c14ae696-5e0c-4e5d-88cc-bef6637737ac'.[Parent <IMicrosoftGraphGovernanceResource>]
: governanceResource[RegisteredDateTime <DateTime?>]
: Represents the date time when the resource is registered in PIM.[RegisteredRoot <String>]
: The externalId of the resource's root scope that is registered in PIM. The root scope can be the parent, grandparent, or higher ancestor resources.[RoleAssignmentRequests <IMicrosoftGraphGovernanceRoleAssignmentRequest-
[]>]
: The collection of role assignment requests for the resource.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignmentState <String>]
: Required. The state of the assignment. The possible values are: Eligible (for eligible assignment), Active (if it is directly assigned), Active (by administrators, or activated on an eligible assignment by the users).[LinkedEligibleRoleAssignmentId <String>]
: If this is a request for role activation, it represents the id of the eligible assignment being referred; Otherwise, the value is null.[Reason <String>]
: A message provided by users and administrators when create the request about why it is needed.[RequestedDateTime <DateTime?>]
: Read-only. The request create time. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The unique identifier of the Azure resource that is associated with the role assignment request. Azure resources can include subscriptions, resource groups, virtual machines, and SQL databases.[RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
: governanceRoleDefinition[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the role definition.[ExternalId <String>]
: The external ID of the role definition.[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The ID of the resource associated with the role definition.[RoleSetting <IMicrosoftGraphGovernanceRoleSetting>]
: governanceRoleSetting[TemplateId <String>]
: The unique identifier for the template.
[RoleDefinitionId <String>]
: Required. The identifier of the Azure role definition that the role assignment request is associated with.[Schedule <IMicrosoftGraphGovernanceSchedule>]
: governanceSchedule[(Any) <Object>]
: This indicates any property can be added to this object.[Duration <TimeSpan?>]
: The duration of a role assignment. It is in format of a TimeSpan.[EndDateTime <DateTime?>]
: The end time of the role assignment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Note: if the value is null, it indicates a permanent assignment.[StartDateTime <DateTime?>]
: The start time of the role assignment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Type <String>]
: The role assignment schedule type. Only Once is supported for now.
[Status <IMicrosoftGraphGovernanceRoleAssignmentRequestStatus>]
: governanceRoleAssignmentRequestStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Status <String>]
: The status of the role assignment request. The value can be InProgress or Closed.[StatusDetails <IMicrosoftGraphKeyValue-
[]>]
: The details of the status of the role assignment request. It represents the evaluation results of different rules.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[SubStatus <String>]
: The sub status of the role assignment request. The values can be Accepted, PendingEvaluation, Granted, Denied, PendingProvisioning, Provisioned, PendingRevocation, Revoked, Canceled, Failed, PendingApprovalProvisioning, PendingApproval, FailedAsResourceIsLocked, PendingAdminDecision, AdminApproved, AdminDenied, TimedOut, and ProvisioningStarted.
[Subject <IMicrosoftGraphGovernanceSubject>]
: governanceSubject[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the subject.[Email <String>]
: The email address of the user subject. If the subject is in other types, it's empty.[PrincipalName <String>]
: The principal name of the user subject. If the subject is in other types, it's empty.[Type <String>]
: The type of the subject. The value can be User, Group, and ServicePrincipal.
[SubjectId <String>]
: Required. The unique identifier of the principal or subject that the role assignment request is associated with. Principals can be users, groups, or service principals.[Type <String>]
: Required. Representing the type of the operation on the role assignment. The possible values are: AdminAdd , UserAdd , AdminUpdate , AdminRemove , UserRemove , UserExtend , AdminExtend , UserRenew , AdminRenew.
[RoleAssignments <IMicrosoftGraphGovernanceRoleAssignment-
[]>]
: The collection of role assignments for the resource.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignmentState <String>]
: The state of the assignment. The value can be Eligible for eligible assignment or Active if it's directly assigned Active by administrators, or activated on an eligible assignment by the users.[EndDateTime <DateTime?>]
: For a non-permanent role assignment, this is the time when the role assignment is expired. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[ExternalId <String>]
: The external ID the resource that is used to identify the role assignment in the provider.[LinkedEligibleRoleAssignment <IMicrosoftGraphGovernanceRoleAssignment>]
: governanceRoleAssignment[LinkedEligibleRoleAssignmentId <String>]
: If this is an active assignment and created due to activation on an eligible assignment, it represents the ID of that eligible assignment; Otherwise, the value is null.[MemberType <String>]
: The type of member. The value can be: Inherited (if the role assignment is inherited from a parent resource scope), Group (if the role assignment isn't inherited, but comes from the membership of a group assignment), or User (if the role assignment isn't inherited or from a group assignment).[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The ID of the resource that the role assignment is associated with.[RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
: governanceRoleDefinition[RoleDefinitionId <String>]
: Required. The ID of the role definition that the role assignment is associated with.[StartDateTime <DateTime?>]
: The start time of the role assignment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Status <String>]
:[Subject <IMicrosoftGraphGovernanceSubject>]
: governanceSubject[SubjectId <String>]
: Required. The ID of the subject that the role assignment is associated with.
[RoleDefinitions <IMicrosoftGraphGovernanceRoleDefinition-
[]>]
: The collection of role definitions for the resource.[RoleSettings <IMicrosoftGraphGovernanceRoleSetting-
[]>]
: The collection of role settings for the resource.[Status <String>]
: The status of a given resource. For example, it could represent whether the resource is locked or not (values: Active/Locked). Note: This property may be extended in the future to support more scenarios.[Type <String>]
: Required. Resource type. For example, for Azure resources, the type could be 'Subscription', 'ResourceGroup', 'Microsoft.Sql/server', etc.
[ResourceId <String>]
: Required. The id of the resource that the role setting is associated with.[RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
: governanceRoleDefinition[RoleDefinitionId <String>]
: Required. The id of the role definition that the role setting is associated with.[UserEligibleSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when a user tries to add an eligible role assignment. The setting is not supported for now.[UserMemberSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when a user tries to activate his role assignment.
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[AccessPackageAssignmentResourceRoleId <String>]
: The unique identifier of accessPackageAssignmentResourceRole[AccessPackageCatalogId <String>]
: The unique identifier of accessPackageCatalog[AccessPackageId <String>]
: The unique identifier of accessPackage[AccessPackageId1 <String>]
: The unique identifier of accessPackage[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[AccessPackageResourceRoleScopeId <String>]
: The unique identifier of accessPackageResourceRoleScope[AccessPackageResourceScopeId <String>]
: The unique identifier of accessPackageResourceScope[AccessPackageSubjectId <String>]
: The unique identifier of accessPackageSubject[AccessReviewDecisionId <String>]
: The unique identifier of accessReviewDecision[AccessReviewHistoryDefinitionId <String>]
: The unique identifier of accessReviewHistoryDefinition[AccessReviewHistoryInstanceId <String>]
: The unique identifier of accessReviewHistoryInstance[AccessReviewId <String>]
: The unique identifier of accessReview[AccessReviewId1 <String>]
: The unique identifier of accessReview[AccessReviewInstanceDecisionItemId <String>]
: The unique identifier of accessReviewInstanceDecisionItem[AccessReviewInstanceDecisionItemId1 <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[ApprovalStepId <String>]
: The unique identifier of approvalStep[BusinessFlowTemplateId <String>]
: The unique identifier of businessFlowTemplate[ConnectedOrganizationId <String>]
: The unique identifier of connectedOrganization[CustomAccessPackageWorkflowExtensionId <String>]
: The unique identifier of customAccessPackageWorkflowExtension[CustomCalloutExtensionId <String>]
: The unique identifier of customCalloutExtension[CustomExtensionHandlerId <String>]
: The unique identifier of customExtensionHandler[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}[FindingId <String>]
: The unique identifier of finding[GovernanceInsightId <String>]
: The unique identifier of governanceInsight[GovernanceResourceId <String>]
: The unique identifier of governanceResource[GovernanceRoleAssignmentId <String>]
: The unique identifier of governanceRoleAssignment[GovernanceRoleAssignmentRequestId <String>]
: The unique identifier of governanceRoleAssignmentRequest[GovernanceRoleDefinitionId <String>]
: The unique identifier of governanceRoleDefinition[GovernanceRoleSettingId <String>]
: The unique identifier of governanceRoleSetting[IncompatibleAccessPackageId <String>]
: Usage: incompatibleAccessPackageId='{incompatibleAccessPackageId}'[LongRunningOperationId <String>]
: The unique identifier of longRunningOperation[ObjectId <String>]
: Alternate key of accessPackageSubject[On <String>]
: Usage: on='{on}'[PermissionsCreepIndexDistributionId <String>]
: The unique identifier of permissionsCreepIndexDistribution[PermissionsRequestChangeId <String>]
: The unique identifier of permissionsRequestChange[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[PrivilegedAccessId <String>]
: The unique identifier of privilegedAccess[PrivilegedApprovalId <String>]
: The unique identifier of privilegedApproval[PrivilegedOperationEventId <String>]
: The unique identifier of privilegedOperationEvent[PrivilegedRoleAssignmentId <String>]
: The unique identifier of privilegedRoleAssignment[PrivilegedRoleAssignmentId1 <String>]
: The unique identifier of privilegedRoleAssignment[PrivilegedRoleAssignmentRequestId <String>]
: The unique identifier of privilegedRoleAssignmentRequest[PrivilegedRoleId <String>]
: The unique identifier of privilegedRole[ProgramControlId <String>]
: The unique identifier of programControl[ProgramControlId1 <String>]
: The unique identifier of programControl[ProgramControlTypeId <String>]
: The unique identifier of programControlType[ProgramId <String>]
: The unique identifier of program[RbacApplicationId <String>]
: The unique identifier of rbacApplication[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[UnifiedRoleManagementAlertConfigurationId <String>]
: The unique identifier of unifiedRoleManagementAlertConfiguration[UnifiedRoleManagementAlertDefinitionId <String>]
: The unique identifier of unifiedRoleManagementAlertDefinition[UnifiedRoleManagementAlertId <String>]
: The unique identifier of unifiedRoleManagementAlert[UnifiedRoleManagementAlertIncidentId <String>]
: The unique identifier of unifiedRoleManagementAlertIncident[UniqueName <String>]
: Alternate key of accessPackageCatalog[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
RESOURCE <IMicrosoftGraphGovernanceResource>
: governanceResource
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the resource.[ExternalId <String>]
: The external id of the resource, representing its original id in the external system. For example, a subscription resource's external id can be '/subscriptions/c14ae696-5e0c-4e5d-88cc-bef6637737ac'.[Parent <IMicrosoftGraphGovernanceResource>]
: governanceResource[RegisteredDateTime <DateTime?>]
: Represents the date time when the resource is registered in PIM.[RegisteredRoot <String>]
: The externalId of the resource's root scope that is registered in PIM. The root scope can be the parent, grandparent, or higher ancestor resources.[RoleAssignmentRequests <IMicrosoftGraphGovernanceRoleAssignmentRequest-
[]>]
: The collection of role assignment requests for the resource.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignmentState <String>]
: Required. The state of the assignment. The possible values are: Eligible (for eligible assignment), Active (if it is directly assigned), Active (by administrators, or activated on an eligible assignment by the users).[LinkedEligibleRoleAssignmentId <String>]
: If this is a request for role activation, it represents the id of the eligible assignment being referred; Otherwise, the value is null.[Reason <String>]
: A message provided by users and administrators when create the request about why it is needed.[RequestedDateTime <DateTime?>]
: Read-only. The request create time. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The unique identifier of the Azure resource that is associated with the role assignment request. Azure resources can include subscriptions, resource groups, virtual machines, and SQL databases.[RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
: governanceRoleDefinition[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the role definition.[ExternalId <String>]
: The external ID of the role definition.[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The ID of the resource associated with the role definition.[RoleSetting <IMicrosoftGraphGovernanceRoleSetting>]
: governanceRoleSetting[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[AdminEligibleSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when an administrator tries to add an eligible role assignment.[RuleIdentifier <String>]
: The id of the rule. For example, ExpirationRule and MfaRule.[Setting <String>]
: The settings of the rule. The value is a JSON string with a list of pairs in the format of ParameterName:ParameterValue. For example, {'permanentAssignment':false,'maximumGrantPeriodInMinutes':129600}
[AdminMemberSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when an administrator tries to add a direct member role assignment.[IsDefault <Boolean?>]
: Read-only. Indicate if the roleSetting is a default roleSetting[LastUpdatedBy <String>]
: Read-only. The display name of the administrator who last updated the roleSetting.[LastUpdatedDateTime <DateTime?>]
: Read-only. The time when the role setting was last updated. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The id of the resource that the role setting is associated with.[RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
: governanceRoleDefinition[RoleDefinitionId <String>]
: Required. The id of the role definition that the role setting is associated with.[UserEligibleSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when a user tries to add an eligible role assignment. The setting is not supported for now.[UserMemberSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when a user tries to activate his role assignment.
[TemplateId <String>]
: The unique identifier for the template.
[RoleDefinitionId <String>]
: Required. The identifier of the Azure role definition that the role assignment request is associated with.[Schedule <IMicrosoftGraphGovernanceSchedule>]
: governanceSchedule[(Any) <Object>]
: This indicates any property can be added to this object.[Duration <TimeSpan?>]
: The duration of a role assignment. It is in format of a TimeSpan.[EndDateTime <DateTime?>]
: The end time of the role assignment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Note: if the value is null, it indicates a permanent assignment.[StartDateTime <DateTime?>]
: The start time of the role assignment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Type <String>]
: The role assignment schedule type. Only Once is supported for now.
[Status <IMicrosoftGraphGovernanceRoleAssignmentRequestStatus>]
: governanceRoleAssignmentRequestStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Status <String>]
: The status of the role assignment request. The value can be InProgress or Closed.[StatusDetails <IMicrosoftGraphKeyValue-
[]>]
: The details of the status of the role assignment request. It represents the evaluation results of different rules.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[SubStatus <String>]
: The sub status of the role assignment request. The values can be Accepted, PendingEvaluation, Granted, Denied, PendingProvisioning, Provisioned, PendingRevocation, Revoked, Canceled, Failed, PendingApprovalProvisioning, PendingApproval, FailedAsResourceIsLocked, PendingAdminDecision, AdminApproved, AdminDenied, TimedOut, and ProvisioningStarted.
[Subject <IMicrosoftGraphGovernanceSubject>]
: governanceSubject[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the subject.[Email <String>]
: The email address of the user subject. If the subject is in other types, it's empty.[PrincipalName <String>]
: The principal name of the user subject. If the subject is in other types, it's empty.[Type <String>]
: The type of the subject. The value can be User, Group, and ServicePrincipal.
[SubjectId <String>]
: Required. The unique identifier of the principal or subject that the role assignment request is associated with. Principals can be users, groups, or service principals.[Type <String>]
: Required. Representing the type of the operation on the role assignment. The possible values are: AdminAdd , UserAdd , AdminUpdate , AdminRemove , UserRemove , UserExtend , AdminExtend , UserRenew , AdminRenew.
[RoleAssignments <IMicrosoftGraphGovernanceRoleAssignment-
[]>]
: The collection of role assignments for the resource.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignmentState <String>]
: The state of the assignment. The value can be Eligible for eligible assignment or Active if it's directly assigned Active by administrators, or activated on an eligible assignment by the users.[EndDateTime <DateTime?>]
: For a non-permanent role assignment, this is the time when the role assignment is expired. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[ExternalId <String>]
: The external ID the resource that is used to identify the role assignment in the provider.[LinkedEligibleRoleAssignment <IMicrosoftGraphGovernanceRoleAssignment>]
: governanceRoleAssignment[LinkedEligibleRoleAssignmentId <String>]
: If this is an active assignment and created due to activation on an eligible assignment, it represents the ID of that eligible assignment; Otherwise, the value is null.[MemberType <String>]
: The type of member. The value can be: Inherited (if the role assignment is inherited from a parent resource scope), Group (if the role assignment isn't inherited, but comes from the membership of a group assignment), or User (if the role assignment isn't inherited or from a group assignment).[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The ID of the resource that the role assignment is associated with.[RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
: governanceRoleDefinition[RoleDefinitionId <String>]
: Required. The ID of the role definition that the role assignment is associated with.[StartDateTime <DateTime?>]
: The start time of the role assignment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Status <String>]
:[Subject <IMicrosoftGraphGovernanceSubject>]
: governanceSubject[SubjectId <String>]
: Required. The ID of the subject that the role assignment is associated with.
[RoleDefinitions <IMicrosoftGraphGovernanceRoleDefinition-
[]>]
: The collection of role definitions for the resource.[RoleSettings <IMicrosoftGraphGovernanceRoleSetting-
[]>]
: The collection of role settings for the resource.[Status <String>]
: The status of a given resource. For example, it could represent whether the resource is locked or not (values: Active/Locked). Note: This property may be extended in the future to support more scenarios.[Type <String>]
: Required. Resource type. For example, for Azure resources, the type could be 'Subscription', 'ResourceGroup', 'Microsoft.Sql/server', etc.
ROLEDEFINITION <IMicrosoftGraphGovernanceRoleDefinition>
: governanceRoleDefinition
[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the role definition.[ExternalId <String>]
: The external ID of the role definition.[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the resource.[ExternalId <String>]
: The external id of the resource, representing its original id in the external system. For example, a subscription resource's external id can be '/subscriptions/c14ae696-5e0c-4e5d-88cc-bef6637737ac'.[Parent <IMicrosoftGraphGovernanceResource>]
: governanceResource[RegisteredDateTime <DateTime?>]
: Represents the date time when the resource is registered in PIM.[RegisteredRoot <String>]
: The externalId of the resource's root scope that is registered in PIM. The root scope can be the parent, grandparent, or higher ancestor resources.[RoleAssignmentRequests <IMicrosoftGraphGovernanceRoleAssignmentRequest-
[]>]
: The collection of role assignment requests for the resource.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignmentState <String>]
: Required. The state of the assignment. The possible values are: Eligible (for eligible assignment), Active (if it is directly assigned), Active (by administrators, or activated on an eligible assignment by the users).[LinkedEligibleRoleAssignmentId <String>]
: If this is a request for role activation, it represents the id of the eligible assignment being referred; Otherwise, the value is null.[Reason <String>]
: A message provided by users and administrators when create the request about why it is needed.[RequestedDateTime <DateTime?>]
: Read-only. The request create time. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The unique identifier of the Azure resource that is associated with the role assignment request. Azure resources can include subscriptions, resource groups, virtual machines, and SQL databases.[RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
: governanceRoleDefinition[RoleDefinitionId <String>]
: Required. The identifier of the Azure role definition that the role assignment request is associated with.[Schedule <IMicrosoftGraphGovernanceSchedule>]
: governanceSchedule[(Any) <Object>]
: This indicates any property can be added to this object.[Duration <TimeSpan?>]
: The duration of a role assignment. It is in format of a TimeSpan.[EndDateTime <DateTime?>]
: The end time of the role assignment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Note: if the value is null, it indicates a permanent assignment.[StartDateTime <DateTime?>]
: The start time of the role assignment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Type <String>]
: The role assignment schedule type. Only Once is supported for now.
[Status <IMicrosoftGraphGovernanceRoleAssignmentRequestStatus>]
: governanceRoleAssignmentRequestStatus[(Any) <Object>]
: This indicates any property can be added to this object.[Status <String>]
: The status of the role assignment request. The value can be InProgress or Closed.[StatusDetails <IMicrosoftGraphKeyValue-
[]>]
: The details of the status of the role assignment request. It represents the evaluation results of different rules.[Key <String>]
: Contains the name of the field that a value is associated with.[Value <String>]
: Contains the corresponding value for the specified key.
[SubStatus <String>]
: The sub status of the role assignment request. The values can be Accepted, PendingEvaluation, Granted, Denied, PendingProvisioning, Provisioned, PendingRevocation, Revoked, Canceled, Failed, PendingApprovalProvisioning, PendingApproval, FailedAsResourceIsLocked, PendingAdminDecision, AdminApproved, AdminDenied, TimedOut, and ProvisioningStarted.
[Subject <IMicrosoftGraphGovernanceSubject>]
: governanceSubject[(Any) <Object>]
: This indicates any property can be added to this object.[Id <String>]
: The unique identifier for an entity. Read-only.[DisplayName <String>]
: The display name of the subject.[Email <String>]
: The email address of the user subject. If the subject is in other types, it's empty.[PrincipalName <String>]
: The principal name of the user subject. If the subject is in other types, it's empty.[Type <String>]
: The type of the subject. The value can be User, Group, and ServicePrincipal.
[SubjectId <String>]
: Required. The unique identifier of the principal or subject that the role assignment request is associated with. Principals can be users, groups, or service principals.[Type <String>]
: Required. Representing the type of the operation on the role assignment. The possible values are: AdminAdd , UserAdd , AdminUpdate , AdminRemove , UserRemove , UserExtend , AdminExtend , UserRenew , AdminRenew.
[RoleAssignments <IMicrosoftGraphGovernanceRoleAssignment-
[]>]
: The collection of role assignments for the resource.[Id <String>]
: The unique identifier for an entity. Read-only.[AssignmentState <String>]
: The state of the assignment. The value can be Eligible for eligible assignment or Active if it's directly assigned Active by administrators, or activated on an eligible assignment by the users.[EndDateTime <DateTime?>]
: For a non-permanent role assignment, this is the time when the role assignment is expired. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[ExternalId <String>]
: The external ID the resource that is used to identify the role assignment in the provider.[LinkedEligibleRoleAssignment <IMicrosoftGraphGovernanceRoleAssignment>]
: governanceRoleAssignment[LinkedEligibleRoleAssignmentId <String>]
: If this is an active assignment and created due to activation on an eligible assignment, it represents the ID of that eligible assignment; Otherwise, the value is null.[MemberType <String>]
: The type of member. The value can be: Inherited (if the role assignment is inherited from a parent resource scope), Group (if the role assignment isn't inherited, but comes from the membership of a group assignment), or User (if the role assignment isn't inherited or from a group assignment).[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The ID of the resource that the role assignment is associated with.[RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
: governanceRoleDefinition[RoleDefinitionId <String>]
: Required. The ID of the role definition that the role assignment is associated with.[StartDateTime <DateTime?>]
: The start time of the role assignment. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Status <String>]
:[Subject <IMicrosoftGraphGovernanceSubject>]
: governanceSubject[SubjectId <String>]
: Required. The ID of the subject that the role assignment is associated with.
[RoleDefinitions <IMicrosoftGraphGovernanceRoleDefinition-
[]>]
: The collection of role definitions for the resource.[RoleSettings <IMicrosoftGraphGovernanceRoleSetting-
[]>]
: The collection of role settings for the resource.[Id <String>]
: The unique identifier for an entity. Read-only.[AdminEligibleSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when an administrator tries to add an eligible role assignment.[RuleIdentifier <String>]
: The id of the rule. For example, ExpirationRule and MfaRule.[Setting <String>]
: The settings of the rule. The value is a JSON string with a list of pairs in the format of ParameterName:ParameterValue. For example, {'permanentAssignment':false,'maximumGrantPeriodInMinutes':129600}
[AdminMemberSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when an administrator tries to add a direct member role assignment.[IsDefault <Boolean?>]
: Read-only. Indicate if the roleSetting is a default roleSetting[LastUpdatedBy <String>]
: Read-only. The display name of the administrator who last updated the roleSetting.[LastUpdatedDateTime <DateTime?>]
: Read-only. The time when the role setting was last updated. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z[Resource <IMicrosoftGraphGovernanceResource>]
: governanceResource[ResourceId <String>]
: Required. The id of the resource that the role setting is associated with.[RoleDefinition <IMicrosoftGraphGovernanceRoleDefinition>]
: governanceRoleDefinition[RoleDefinitionId <String>]
: Required. The id of the role definition that the role setting is associated with.[UserEligibleSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when a user tries to add an eligible role assignment. The setting is not supported for now.[UserMemberSettings <IMicrosoftGraphGovernanceRuleSetting-
[]>]
: The rule settings that are evaluated when a user tries to activate his role assignment.
[Status <String>]
: The status of a given resource. For example, it could represent whether the resource is locked or not (values: Active/Locked). Note: This property may be extended in the future to support more scenarios.[Type <String>]
: Required. Resource type. For example, for Azure resources, the type could be 'Subscription', 'ResourceGroup', 'Microsoft.Sql/server', etc.
[ResourceId <String>]
: Required. The ID of the resource associated with the role definition.[RoleSetting <IMicrosoftGraphGovernanceRoleSetting>]
: governanceRoleSetting[TemplateId <String>]
: The unique identifier for the template.
USERELIGIBLESETTINGS <IMicrosoftGraphGovernanceRuleSetting- []
>: The rule settings that are evaluated when a user tries to add an eligible role assignment.
The setting is not supported for now.
[RuleIdentifier <String>]
: The id of the rule. For example, ExpirationRule and MfaRule.[Setting <String>]
: The settings of the rule. The value is a JSON string with a list of pairs in the format of ParameterName:ParameterValue. For example, {'permanentAssignment':false,'maximumGrantPeriodInMinutes':129600}
USERMEMBERSETTINGS <IMicrosoftGraphGovernanceRuleSetting- []
>: The rule settings that are evaluated when a user tries to activate his role assignment.
[RuleIdentifier <String>]
: The id of the rule. For example, ExpirationRule and MfaRule.[Setting <String>]
: The settings of the rule. The value is a JSON string with a list of pairs in the format of ParameterName:ParameterValue. For example, {'permanentAssignment':false,'maximumGrantPeriodInMinutes':129600}