New-MgBetaRoleManagementEntitlementManagementRoleAssignmentScheduleInstance
Create new navigation property to roleAssignmentScheduleInstances for roleManagement
Note
To view the v1.0 release of this cmdlet, view New-MgRoleManagementEntitlementManagementRoleAssignmentScheduleInstance
Syntax
New-MgBetaRoleManagementEntitlementManagementRoleAssignmentScheduleInstance
[-ResponseHeadersVariable <String>]
[-ActivatedUsing <IMicrosoftGraphUnifiedRoleEligibilityScheduleInstance>]
[-AdditionalProperties <Hashtable>]
[-AppScope <IMicrosoftGraphAppScope>]
[-AppScopeId <String>]
[-AssignmentType <String>]
[-DirectoryScope <IMicrosoftGraphDirectoryObject>]
[-DirectoryScopeId <String>]
[-EndDateTime <DateTime>]
[-Id <String>]
[-MemberType <String>]
[-Principal <IMicrosoftGraphDirectoryObject>]
[-PrincipalId <String>]
[-RoleAssignmentOriginId <String>]
[-RoleAssignmentScheduleId <String>]
[-RoleDefinition <IMicrosoftGraphUnifiedRoleDefinition>]
[-RoleDefinitionId <String>]
[-StartDateTime <DateTime>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] New-MgBetaRoleManagementEntitlementManagementRoleAssignmentScheduleInstance
-BodyParameter <IMicrosoftGraphUnifiedRoleAssignmentScheduleInstance>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-ProgressAction <ActionPreference>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Create new navigation property to roleAssignmentScheduleInstances for roleManagement
Parameters
-ActivatedUsing
unifiedRoleEligibilityScheduleInstance To construct, see NOTES section for ACTIVATEDUSING properties and create a hash table.
| Type: | IMicrosoftGraphUnifiedRoleEligibilityScheduleInstance |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-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 or role eligibility is scoped to an app. The scope of an assignment or role eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AssignmentType
The type of the assignment that can either be Assigned or Activated. Supports $filter (eq, ne).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BodyParameter
unifiedRoleAssignmentScheduleInstance To construct, see NOTES section for BODYPARAMETER properties and create a hash table.
| Type: | IMicrosoftGraphUnifiedRoleAssignmentScheduleInstance |
| 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 |
-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 or role eligibility. The scope of an assignment or role eligibility 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. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndDateTime
The end date of the schedule instance.
| Type: | DateTime |
| 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 |
-MemberType
How the assignment is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleAssignmentSchedule can be managed by the caller. Supports $filter (eq, ne).
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 that has been granted the role assignment or that's eligible for a role.
| 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 |
-RoleAssignmentOriginId
The identifier of the role assignment in Microsoft Entra ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RoleAssignmentScheduleId
The identifier of the unifiedRoleAssignmentSchedule object from which this instance was created.
| Type: | String |
| 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 object that is being assigned to the principal or that the principal is eligible for.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartDateTime
When this instance starts.
| Type: | DateTime |
| 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.IMicrosoftGraphUnifiedRoleAssignmentScheduleInstance
System.Collections.IDictionary
Outputs
Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphUnifiedRoleAssignmentScheduleInstance
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.
ACTIVATEDUSING <IMicrosoftGraphUnifiedRoleEligibilityScheduleInstance>: unifiedRoleEligibilityScheduleInstance
[(Any) <Object>]: This indicates any property can be added to this object.[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. This property is 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. This property is read only.
[AppScopeId <String>]: Identifier of the app-specific scope when the assignment or role eligibility is scoped to an app. The scope of an assignment or role eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.[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 or role eligibility. The scope of an assignment or role eligibility 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. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.[Principal <IMicrosoftGraphDirectoryObject>]: directoryObject[PrincipalId <String>]: Identifier of the principal that has been granted the role assignment or that's eligible for a role.[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.[AllowedPrincipalTypes <String>]: allowedRolePrincipalTypes[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 and startsWith).[InheritsPermissionsFrom <IMicrosoftGraphUnifiedRoleDefinition-[]>]: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles support this attribute.[IsBuiltIn <Boolean?>]: Flag indicating if the unifiedRoleDefinition is part of the default set included with the product or custom. Read-only. Supports $filter (eq).[IsEnabled <Boolean?>]: Flag indicating if the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true.[IsPrivileged <Boolean?>]: Flag indicating if the role is privileged. Microsoft Entra ID defines a role as privileged if it contains at least one sensitive resource action in the rolePermissions and allowedResourceActions objects. Applies only for actions in the microsoft.directory resource namespace. Read-only. Supports $filter (eq).[ResourceScopes <String-[]>]: List of scopes permissions granted by the role definition apply 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.[Condition <String>]: Optional constraints that must be met for the permission to be effective. Not supported for custom roles.[ExcludedResourceActions <String-[]>]:
[TemplateId <String>]: Custom template identifier that can be set when isBuiltIn is false. This identifier is typically used if one needs an identifier to be the same across different directories. Read-only when isBuiltIn is true.[Version <String>]: Indicates the version of the unifiedRoleDefinition object. Read-only when isBuiltIn is true.
[RoleDefinitionId <String>]: Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that the principal is eligible for.[Id <String>]: The unique identifier for an entity. Read-only.[EndDateTime <DateTime?>]: Time that the roleEligibilityScheduleInstance will expire.[MemberType <String>]: Membership type of the assignment. It can either be Inherited, Direct, or Group.[RoleEligibilityScheduleId <String>]: Identifier of the parent roleEligibilitySchedule for this instance.[StartDateTime <DateTime?>]: Time that the roleEligibilityScheduleInstance will start.
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. This property is 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. This property is read only.
BODYPARAMETER <IMicrosoftGraphUnifiedRoleAssignmentScheduleInstance>: unifiedRoleAssignmentScheduleInstance
[(Any) <Object>]: This indicates any property can be added to this object.[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. This property is 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. This property is read only.
[AppScopeId <String>]: Identifier of the app-specific scope when the assignment or role eligibility is scoped to an app. The scope of an assignment or role eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.[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 or role eligibility. The scope of an assignment or role eligibility 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. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.[Principal <IMicrosoftGraphDirectoryObject>]: directoryObject[PrincipalId <String>]: Identifier of the principal that has been granted the role assignment or that's eligible for a role.[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.[AllowedPrincipalTypes <String>]: allowedRolePrincipalTypes[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 and startsWith).[InheritsPermissionsFrom <IMicrosoftGraphUnifiedRoleDefinition-[]>]: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles support this attribute.[IsBuiltIn <Boolean?>]: Flag indicating if the unifiedRoleDefinition is part of the default set included with the product or custom. Read-only. Supports $filter (eq).[IsEnabled <Boolean?>]: Flag indicating if the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true.[IsPrivileged <Boolean?>]: Flag indicating if the role is privileged. Microsoft Entra ID defines a role as privileged if it contains at least one sensitive resource action in the rolePermissions and allowedResourceActions objects. Applies only for actions in the microsoft.directory resource namespace. Read-only. Supports $filter (eq).[ResourceScopes <String-[]>]: List of scopes permissions granted by the role definition apply 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.[Condition <String>]: Optional constraints that must be met for the permission to be effective. Not supported for custom roles.[ExcludedResourceActions <String-[]>]:
[TemplateId <String>]: Custom template identifier that can be set when isBuiltIn is false. This identifier is typically used if one needs an identifier to be the same across different directories. Read-only when isBuiltIn is true.[Version <String>]: Indicates the version of the unifiedRoleDefinition object. Read-only when isBuiltIn is true.
[RoleDefinitionId <String>]: Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that the principal is eligible for.[Id <String>]: The unique identifier for an entity. Read-only.[ActivatedUsing <IMicrosoftGraphUnifiedRoleEligibilityScheduleInstance>]: unifiedRoleEligibilityScheduleInstance[(Any) <Object>]: This indicates any property can be added to this object.[AppScope <IMicrosoftGraphAppScope>]: appScope[AppScopeId <String>]: Identifier of the app-specific scope when the assignment or role eligibility is scoped to an app. The scope of an assignment or role eligibility determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.[DirectoryScope <IMicrosoftGraphDirectoryObject>]: directoryObject[DirectoryScopeId <String>]: Identifier of the directory object representing the scope of the assignment or role eligibility. The scope of an assignment or role eligibility 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. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.[Principal <IMicrosoftGraphDirectoryObject>]: directoryObject[PrincipalId <String>]: Identifier of the principal that has been granted the role assignment or that's eligible for a role.[RoleDefinition <IMicrosoftGraphUnifiedRoleDefinition>]: unifiedRoleDefinition[RoleDefinitionId <String>]: Identifier of the unifiedRoleDefinition object that is being assigned to the principal or that the principal is eligible for.[Id <String>]: The unique identifier for an entity. Read-only.[EndDateTime <DateTime?>]: Time that the roleEligibilityScheduleInstance will expire.[MemberType <String>]: Membership type of the assignment. It can either be Inherited, Direct, or Group.[RoleEligibilityScheduleId <String>]: Identifier of the parent roleEligibilitySchedule for this instance.[StartDateTime <DateTime?>]: Time that the roleEligibilityScheduleInstance will start.
[AssignmentType <String>]: The type of the assignment that can either be Assigned or Activated. Supports $filter (eq, ne).[EndDateTime <DateTime?>]: The end date of the schedule instance.[MemberType <String>]: How the assignment is inherited. It can either be Inherited, Direct, or Group. It can further imply whether the unifiedRoleAssignmentSchedule can be managed by the caller. Supports $filter (eq, ne).[RoleAssignmentOriginId <String>]: The identifier of the role assignment in Microsoft Entra ID.[RoleAssignmentScheduleId <String>]: The identifier of the unifiedRoleAssignmentSchedule object from which this instance was created.[StartDateTime <DateTime?>]: When this instance starts.
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.
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.[AllowedPrincipalTypes <String>]: allowedRolePrincipalTypes[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 and startsWith).[InheritsPermissionsFrom <IMicrosoftGraphUnifiedRoleDefinition-[]>]: Read-only collection of role definitions that the given role definition inherits from. Only Microsoft Entra built-in roles support this attribute.[IsBuiltIn <Boolean?>]: Flag indicating if the unifiedRoleDefinition is part of the default set included with the product or custom. Read-only. Supports $filter (eq).[IsEnabled <Boolean?>]: Flag indicating if the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true.[IsPrivileged <Boolean?>]: Flag indicating if the role is privileged. Microsoft Entra ID defines a role as privileged if it contains at least one sensitive resource action in the rolePermissions and allowedResourceActions objects. Applies only for actions in the microsoft.directory resource namespace. Read-only. Supports $filter (eq).[ResourceScopes <String-[]>]: List of scopes permissions granted by the role definition apply 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.[Condition <String>]: Optional constraints that must be met for the permission to be effective. Not supported for custom roles.[ExcludedResourceActions <String-[]>]:
[TemplateId <String>]: Custom template identifier that can be set when isBuiltIn is false. This identifier is typically used if one needs an identifier to be the same across different directories. Read-only when isBuiltIn is true.[Version <String>]: Indicates the version of the unifiedRoleDefinition object. Read-only when isBuiltIn is true.