Share via

New-MgBetaProgram

Module:
Microsoft.Graph.Beta.Identity.Governance Module

In the Microsoft Entra access reviews feature, create a new program object.

Syntax

CreateExpanded (Default) 

New-MgBetaProgram
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-Controls <IMicrosoftGraphProgramControl[]>]
    [-Description <String>]
    [-DisplayName <String>]
    [-Id <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create 

New-MgBetaProgram
    -BodyParameter <IMicrosoftGraphProgram>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

In the Microsoft Entra access reviews feature, create a new program object.

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.Identity.Governance

$params = @{
	displayName = "testprogram3"
	description = "test description"
}

New-MgBetaProgram -BodyParameter $params

This example shows how to use the New-MgBetaProgram Cmdlet.

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

-BodyParameter

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

Parameter properties

Type:IMicrosoftGraphProgram
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

-Controls

Controls associated with the program. To construct, see NOTES section for CONTROLS properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphProgramControl[]

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

-Description

The description of the program.

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

-DisplayName

The name of the program. Required on create.

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

-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

-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.IMicrosoftGraphProgram

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphProgram

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 <IMicrosoftGraphProgram>: program

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Controls <IMicrosoftGraphProgramControl- []>]: Controls associated with the program.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [ControlId <String>]: The controlId of the control, in particular the identifier of an access review. Required on create.
    • [ControlTypeId <String>]: The programControlType identifies the type of program control - for example, a control linking to guest access reviews. Required on create.
    • [CreatedDateTime <DateTime?>]: The creation date and time of the program control.
    • [DisplayName <String>]: The name of the control.
    • [Owner <IMicrosoftGraphUserIdentity>]: userIdentity
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: The display name of the identity. This property is read-only.
      • [Id <String>]: The identifier of the identity. This property is read-only.
      • [IPAddress <String>]: Indicates the client IP address associated with the user performing the activity (audit log only).
      • [UserPrincipalName <String>]: The userPrincipalName attribute of the user.
    • [Program <IMicrosoftGraphProgram>]: program
    • [ProgramId <String>]: The programId of the program this control is a part of. Required on create.
    • [Resource <IMicrosoftGraphProgramResource>]: programResource
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: The display name of the identity. This property is read-only.
      • [Id <String>]: The identifier of the identity. This property is read-only.
      • [Type <String>]: Type of the resource, indicating whether it is a group or an app.
    • [Status <String>]: The life cycle status of the control.
  • [Description <String>]: The description of the program.
  • [DisplayName <String>]: The name of the program. Required on create.

CONTROLS <IMicrosoftGraphProgramControl- []>: Controls associated with the program.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [ControlId <String>]: The controlId of the control, in particular the identifier of an access review. Required on create.
  • [ControlTypeId <String>]: The programControlType identifies the type of program control - for example, a control linking to guest access reviews. Required on create.
  • [CreatedDateTime <DateTime?>]: The creation date and time of the program control.
  • [DisplayName <String>]: The name of the control.
  • [Owner <IMicrosoftGraphUserIdentity>]: userIdentity
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: The display name of the identity. This property is read-only.
    • [Id <String>]: The identifier of the identity. This property is read-only.
    • [IPAddress <String>]: Indicates the client IP address associated with the user performing the activity (audit log only).
    • [UserPrincipalName <String>]: The userPrincipalName attribute of the user.
  • [Program <IMicrosoftGraphProgram>]: program
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [Controls <IMicrosoftGraphProgramControl- []>]: Controls associated with the program.
    • [Description <String>]: The description of the program.
    • [DisplayName <String>]: The name of the program. Required on create.
  • [ProgramId <String>]: The programId of the program this control is a part of. Required on create.
  • [Resource <IMicrosoftGraphProgramResource>]: programResource
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: The display name of the identity. This property is read-only.
    • [Id <String>]: The identifier of the identity. This property is read-only.
    • [Type <String>]: Type of the resource, indicating whether it is a group or an app.
  • [Status <String>]: The life cycle status of the control.