Share via


New-MgBetaPrivilegedRoleAssignmentRequest

Add new entity to privilegedRoleAssignmentRequests

Syntax

CreateExpanded (Default)

New-MgBetaPrivilegedRoleAssignmentRequest
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AssignmentState <String>]
    [-Duration <String>]
    [-Id <String>]
    [-Reason <String>]
    [-RequestedDateTime <DateTime>]
    [-RoleId <String>]
    [-RoleInfo <IMicrosoftGraphPrivilegedRole>]
    [-Schedule <IMicrosoftGraphGovernanceSchedule>]
    [-Status <String>]
    [-TicketNumber <String>]
    [-TicketSystem <String>]
    [-Type <String>]
    [-UserId <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create

New-MgBetaPrivilegedRoleAssignmentRequest
    -BodyParameter <IMicrosoftGraphPrivilegedRoleAssignmentRequest>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Add new entity to privilegedRoleAssignmentRequests

Examples

Example 1: Using the New-MgBetaPrivilegedRoleAssignmentRequest Cmdlet

Import-Module Microsoft.Graph.Beta.Identity.Governance
$params = @{
	Duration = "2"
	Reason = "Activate the role for business purpose"
	TicketNumber = "234"
	TicketSystem = "system"
	Schedule = @{
		StartDateTime = [System.DateTime]::Parse("2018-02-08T02:35:17.903Z")
	}
	Type = "UserAdd"
	AssignmentState = "Active"
	RoleId = "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
}
New-MgBetaPrivilegedRoleAssignmentRequest -BodyParameter $params

This example shows how to use the New-MgBetaPrivilegedRoleAssignmentRequest Cmdlet. To learn about permissions for this resource, see the permissions reference.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AssignmentState

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

privilegedRoleAssignmentRequest To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphPrivilegedRoleAssignmentRequest
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Create
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Duration

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:IDictionary
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Reason

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestedDateTime

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RoleId

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RoleInfo

privilegedRole To construct, see NOTES section for ROLEINFO properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphPrivilegedRole
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Schedule

governanceSchedule To construct, see NOTES section for SCHEDULE properties and create a hash table.

Parameter properties

Type:IMicrosoftGraphGovernanceSchedule
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Status

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TicketNumber

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TicketSystem

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Type

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserId

Add new entity to privilegedRoleAssignmentRequests

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphPrivilegedRoleAssignmentRequest

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphPrivilegedRoleAssignmentRequest

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.

BODYPARAMETER <IMicrosoftGraphPrivilegedRoleAssignmentRequest>: privilegedRoleAssignmentRequest

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [AssignmentState <String>]:
  • [Duration <String>]:
  • [Reason <String>]:
  • [RequestedDateTime <DateTime?>]:
  • [RoleId <String>]:
  • [RoleInfo <IMicrosoftGraphPrivilegedRole>]: privilegedRole
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Assignments <IMicrosoftGraphPrivilegedRoleAssignment- []>]:
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [ExpirationDateTime <DateTime?>]:
      • [IsElevated <Boolean?>]:
      • [ResultMessage <String>]:
      • [RoleId <String>]:
      • [RoleInfo <IMicrosoftGraphPrivilegedRole>]: privilegedRole
      • [UserId <String>]:
    • [Name <String>]:
    • [Settings <IMicrosoftGraphPrivilegedRoleSettings>]: privilegedRoleSettings
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [ApprovalOnElevation <Boolean?>]:
      • [ApproverIds <String- []>]:
      • [ElevationDuration <TimeSpan?>]:
      • [IsMfaOnElevationConfigurable <Boolean?>]:
      • [LastGlobalAdmin <Boolean?>]:
      • [MaxElavationDuration <TimeSpan?>]:
      • [MfaOnElevation <Boolean?>]:
      • [MinElevationDuration <TimeSpan?>]:
      • [NotificationToUserOnElevation <Boolean?>]:
      • [TicketingInfoOnElevation <Boolean?>]:
    • [Summary <IMicrosoftGraphPrivilegedRoleSummary>]: privilegedRoleSummary
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [Id <String>]: The unique identifier for an entity. Read-only.
      • [ElevatedCount <Int32?>]:
      • [ManagedCount <Int32?>]:
      • [MfaEnabled <Boolean?>]:
      • [Status <String>]: roleSummaryStatus
      • [UsersCount <Int32?>]:
  • [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 <String>]:
  • [TicketNumber <String>]:
  • [TicketSystem <String>]:
  • [Type <String>]:
  • [UserId <String>]:

ROLEINFO <IMicrosoftGraphPrivilegedRole>: privilegedRole

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Assignments <IMicrosoftGraphPrivilegedRoleAssignment- []>]:
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ExpirationDateTime <DateTime?>]:
    • [IsElevated <Boolean?>]:
    • [ResultMessage <String>]:
    • [RoleId <String>]:
    • [RoleInfo <IMicrosoftGraphPrivilegedRole>]: privilegedRole
    • [UserId <String>]:
  • [Name <String>]:
  • [Settings <IMicrosoftGraphPrivilegedRoleSettings>]: privilegedRoleSettings
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ApprovalOnElevation <Boolean?>]:
    • [ApproverIds <String- []>]:
    • [ElevationDuration <TimeSpan?>]:
    • [IsMfaOnElevationConfigurable <Boolean?>]:
    • [LastGlobalAdmin <Boolean?>]:
    • [MaxElavationDuration <TimeSpan?>]:
    • [MfaOnElevation <Boolean?>]:
    • [MinElevationDuration <TimeSpan?>]:
    • [NotificationToUserOnElevation <Boolean?>]:
    • [TicketingInfoOnElevation <Boolean?>]:
  • [Summary <IMicrosoftGraphPrivilegedRoleSummary>]: privilegedRoleSummary
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ElevatedCount <Int32?>]:
    • [ManagedCount <Int32?>]:
    • [MfaEnabled <Boolean?>]:
    • [Status <String>]: roleSummaryStatus
    • [UsersCount <Int32?>]:

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.