Share via

New-MgBetaPolicyPermissionGrantPolicy

Module:
Microsoft.Graph.Beta.Identity.SignIns Module

Creates a permissionGrantPolicy. A permission grant policy is used to describe the conditions under which permissions can be granted (for example, during application consent). After creating the permission grant policy, you can add include condition sets to add matching rules, and add exclude condition sets to add exclusion rules.

Note

To view the v1.0 release of this cmdlet, view New-MgPolicyPermissionGrantPolicy

Syntax

CreateExpanded (Default) 

New-MgBetaPolicyPermissionGrantPolicy
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-DeletedDateTime <DateTime>]
    [-Description <String>]
    [-DisplayName <String>]
    [-Excludes <IMicrosoftGraphPermissionGrantConditionSet[]>]
    [-Id <String>]
    [-IncludeAllPreApprovedApplications]
    [-Includes <IMicrosoftGraphPermissionGrantConditionSet[]>]
    [-ResourceScopeType <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create 

New-MgBetaPolicyPermissionGrantPolicy
    -BodyParameter <IMicrosoftGraphPermissionGrantPolicy>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Creates a permissionGrantPolicy. A permission grant policy is used to describe the conditions under which permissions can be granted (for example, during application consent). After creating the permission grant policy, you can add include condition sets to add matching rules, and add exclude condition sets to add exclusion rules.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Policy.ReadWrite.PermissionGrant,
Delegated (personal Microsoft account) Not supported
Application Policy.ReadWrite.PermissionGrant,

Examples

Example 1: Create a permission grant policy

Connect-MgGraph -Scopes "Policy.Read.PermissionGrant,Policy.ReadWrite.PermissionGrant"
New-MgBetaPolicyPermissionGrantPolicy -Id "testtenant-sampleapp-permissions" -Description "Permissions for sample app in test tenant" -DisplayName "Sample app permissions" | fl

DeletedDateTime      :
Description          : Permissions for sample app in test tenant
DisplayName          : Sample app permissions
Excludes             :
Id                   : testtenant-sampleapp-permissions
Includes             :
AdditionalProperties : {[@odata.context, https://graph.microsoft.com/v1.0/$metadata#policies/permissionGrantPolicies/$entity]}

This command creates a new permission grant policy in Azure AD. Specific include and exclude configurations can be created using the New-MgBetaPolicyPermissionGrantPolicyInclude and New-MgBetaPolicyPermissionGrantPolicyExclude cmdlets.

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

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

Parameter properties

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

-DeletedDateTime

Date and time when this object was deleted. Always null when the object hasn't been deleted.

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

-Description

Description for this policy. Required.

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

Display name for this policy. Required.

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

-Excludes

Condition sets that are excluded in this permission grant policy. Automatically expanded on GET. To construct, see NOTES section for EXCLUDES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphPermissionGrantConditionSet[]

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

-IncludeAllPreApprovedApplications

Set to true to create all pre-approval policies in the tenant. Set to false to disable all pre-approval policies in the tenant. The default is false.

Parameter properties

Type:SwitchParameter
Default value:False
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

-Includes

Condition sets that are included in this permission grant policy. Automatically expanded on GET. To construct, see NOTES section for INCLUDES properties and create a hash table.

Parameter properties

Type:

IMicrosoftGraphPermissionGrantConditionSet[]

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

-ResourceScopeType

resourceScopeType

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

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphPermissionGrantPolicy

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 <IMicrosoftGraphPermissionGrantPolicy>: permissionGrantPolicy

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Description <String>]: Description for this policy. Required.
  • [DisplayName <String>]: Display name for this policy. Required.
  • [DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted.
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Excludes <IMicrosoftGraphPermissionGrantConditionSet- []>]: Condition sets that are excluded in this permission grant policy. Automatically expanded on GET.
    • [Id <String>]: The unique identifier for an entity. Read-only.
    • [CertifiedClientApplicationsOnly <Boolean?>]: Set to true to only match on client applications that are Microsoft 365 certified. Set to false to match on any other client app. Default is false.
    • [ClientApplicationIds <String- []>]: A list of appId values for the client applications to match with, or a list with the single value all to match any client application. Default is the single value all.
    • [ClientApplicationPublisherIds <String- []>]: A list of Microsoft Partner Network (MPN) IDs for verified publishers of the client application, or a list with the single value all to match with client apps from any publisher. Default is the single value all.
    • [ClientApplicationTenantIds <String- []>]: A list of Microsoft Entra tenant IDs in which the client application is registered, or a list with the single value all to match with client apps registered in any tenant. Default is the single value all.
    • [ClientApplicationsFromVerifiedPublisherOnly <Boolean?>]: Set to true to only match on client applications with a verified publisher. Set to false to match on any client app, even if it does not have a verified publisher. Default is false.
    • [PermissionClassification <String>]: The permission classification for the permission being granted, or all to match with any permission classification (including permissions which are not classified). Default is all.
    • [PermissionType <String>]: permissionType
    • [Permissions <String- []>]: The list of id values for the specific permissions to match with, or a list with the single value all to match with any permission. The id of delegated permissions can be found in the publishedPermissionScopes property of the API's servicePrincipal object. The id of application permissions can be found in the appRoles property of the API's servicePrincipal object. The id of resource-specific application permissions can be found in the resourceSpecificApplicationPermissions property of the API's servicePrincipal object. Default is the single value all.
    • [ResourceApplication <String>]: The appId of the resource application (e.g. the API) for which a permission is being granted, or any to match with any resource application or API. Default is any.
    • [ScopeSensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]: scopeSensitivityLabels
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [LabelKind <String>]: labelKind
  • [IncludeAllPreApprovedApplications <Boolean?>]: Set to true to create all pre-approval policies in the tenant. Set to false to disable all pre-approval policies in the tenant. The default is false.
  • [Includes <IMicrosoftGraphPermissionGrantConditionSet- []>]: Condition sets that are included in this permission grant policy. Automatically expanded on GET.
  • [ResourceScopeType <String>]: resourceScopeType

EXCLUDES <IMicrosoftGraphPermissionGrantConditionSet- []>: Condition sets that are excluded in this permission grant policy. Automatically expanded on GET.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [CertifiedClientApplicationsOnly <Boolean?>]: Set to true to only match on client applications that are Microsoft 365 certified. Set to false to match on any other client app. Default is false.
  • [ClientApplicationIds <String- []>]: A list of appId values for the client applications to match with, or a list with the single value all to match any client application. Default is the single value all.
  • [ClientApplicationPublisherIds <String- []>]: A list of Microsoft Partner Network (MPN) IDs for verified publishers of the client application, or a list with the single value all to match with client apps from any publisher. Default is the single value all.
  • [ClientApplicationTenantIds <String- []>]: A list of Microsoft Entra tenant IDs in which the client application is registered, or a list with the single value all to match with client apps registered in any tenant. Default is the single value all.
  • [ClientApplicationsFromVerifiedPublisherOnly <Boolean?>]: Set to true to only match on client applications with a verified publisher. Set to false to match on any client app, even if it does not have a verified publisher. Default is false.
  • [PermissionClassification <String>]: The permission classification for the permission being granted, or all to match with any permission classification (including permissions which are not classified). Default is all.
  • [PermissionType <String>]: permissionType
  • [Permissions <String- []>]: The list of id values for the specific permissions to match with, or a list with the single value all to match with any permission. The id of delegated permissions can be found in the publishedPermissionScopes property of the API's servicePrincipal object. The id of application permissions can be found in the appRoles property of the API's servicePrincipal object. The id of resource-specific application permissions can be found in the resourceSpecificApplicationPermissions property of the API's servicePrincipal object. Default is the single value all.
  • [ResourceApplication <String>]: The appId of the resource application (e.g. the API) for which a permission is being granted, or any to match with any resource application or API. Default is any.
  • [ScopeSensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]: scopeSensitivityLabels
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [LabelKind <String>]: labelKind

INCLUDES <IMicrosoftGraphPermissionGrantConditionSet- []>: Condition sets that are included in this permission grant policy. Automatically expanded on GET.

  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [CertifiedClientApplicationsOnly <Boolean?>]: Set to true to only match on client applications that are Microsoft 365 certified. Set to false to match on any other client app. Default is false.
  • [ClientApplicationIds <String- []>]: A list of appId values for the client applications to match with, or a list with the single value all to match any client application. Default is the single value all.
  • [ClientApplicationPublisherIds <String- []>]: A list of Microsoft Partner Network (MPN) IDs for verified publishers of the client application, or a list with the single value all to match with client apps from any publisher. Default is the single value all.
  • [ClientApplicationTenantIds <String- []>]: A list of Microsoft Entra tenant IDs in which the client application is registered, or a list with the single value all to match with client apps registered in any tenant. Default is the single value all.
  • [ClientApplicationsFromVerifiedPublisherOnly <Boolean?>]: Set to true to only match on client applications with a verified publisher. Set to false to match on any client app, even if it does not have a verified publisher. Default is false.
  • [PermissionClassification <String>]: The permission classification for the permission being granted, or all to match with any permission classification (including permissions which are not classified). Default is all.
  • [PermissionType <String>]: permissionType
  • [Permissions <String- []>]: The list of id values for the specific permissions to match with, or a list with the single value all to match with any permission. The id of delegated permissions can be found in the publishedPermissionScopes property of the API's servicePrincipal object. The id of application permissions can be found in the appRoles property of the API's servicePrincipal object. The id of resource-specific application permissions can be found in the resourceSpecificApplicationPermissions property of the API's servicePrincipal object. Default is the single value all.
  • [ResourceApplication <String>]: The appId of the resource application (e.g. the API) for which a permission is being granted, or any to match with any resource application or API. Default is any.
  • [ScopeSensitivityLabels <IMicrosoftGraphScopeSensitivityLabels>]: scopeSensitivityLabels
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [LabelKind <String>]: labelKind