Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Update-MgPolicyAuthenticationMethodPolicy

Update the properties of an authenticationMethodsPolicy object.

Note

To view the beta release of this cmdlet, view Update-MgBetaPolicyAuthenticationMethodPolicy

Syntax

UpdateExpanded (Default)

Update-MgPolicyAuthenticationMethodPolicy
 [-ResponseHeadersVariable <string>]
 [-AdditionalProperties <hashtable>]
 [-AuthenticationMethodConfigurations <IMicrosoftGraphAuthenticationMethodConfiguration[]>]
 [-Description <string>]
 [-DisplayName <string>]
 [-Id <string>]
 [-LastModifiedDateTime <datetime>]
 [-PolicyMigrationState <string>]
 [-PolicyVersion <string>]
 [-ReconfirmationInDays <int>]
 [-RegistrationEnforcement <IMicrosoftGraphRegistrationEnforcement>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Update

Update-MgPolicyAuthenticationMethodPolicy

 -BodyParameter <IMicrosoftGraphAuthenticationMethodsPolicy>
 [-ResponseHeadersVariable <string>]
 [-Break]
 [-Headers <IDictionary>]
 [-HttpPipelineAppend <SendAsyncStep[]>]
 [-HttpPipelinePrepend <SendAsyncStep[]>]
 [-Proxy <uri>]
 [-ProxyCredential <pscredential>]
 [-ProxyUseDefaultCredentials]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Update the properties of an authenticationMethodsPolicy object.

Permissions

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

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	registrationEnforcement = @{
		authenticationMethodsRegistrationCampaign = @{
			snoozeDurationInDays = 1
			state = "enabled"
			excludeTargets = @(
			)
			includeTargets = @(
				@{
					id = "3ee3a9de-0a86-4e12-a287-9769accf1ba2"
					targetType = "group"
					targetedAuthenticationMethod = "microsoftAuthenticator"
				}
			)
		}
	}
}

Update-MgPolicyAuthenticationMethodPolicy -BodyParameter $params

This example shows how to use the Update-MgPolicyAuthenticationMethodPolicy Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

-AuthenticationMethodConfigurations

Represents the settings for each authentication method. Automatically expanded on GET /policies/authenticationMethodsPolicy. To construct, see NOTES section for AUTHENTICATIONMETHODCONFIGURATIONS properties and create a hash table.

Parameter properties

Type:

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAuthenticationMethodConfiguration[]

Supports wildcards:False
DontShow:False

Parameter sets

-BodyParameter

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAuthenticationMethodsPolicy
Supports wildcards:False
DontShow:False

Parameter sets

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-Description

A description of the policy. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-DisplayName

The name of the policy. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-LastModifiedDateTime

The date and time of the last update to the policy. Read-only.

Parameter properties

Type:System.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

-PolicyMigrationState

authenticationMethodsPolicyMigrationState

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-PolicyVersion

The version of the policy in use. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

-ReconfirmationInDays

Update the properties of an authenticationMethodsPolicy object.

Permissions

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

Parameter properties

Type:System.Int32
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

-RegistrationEnforcement

registrationEnforcement To construct, see NOTES section for REGISTRATIONENFORCEMENT properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphRegistrationEnforcement
Supports wildcards:False
DontShow:False

Parameter sets

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

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.PowerShell.Models.IMicrosoftGraphAuthenticationMethodsPolicy

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAuthenticationMethodsPolicy

{{ Fill in the Description }}

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.

AUTHENTICATIONMETHODCONFIGURATIONS <IMicrosoftGraphAuthenticationMethodConfiguration[]>: Represents the settings for each authentication method. Automatically expanded on GET /policies/authenticationMethodsPolicy. [Id <String>]: The unique identifier for an entity. Read-only. [ExcludeTargets <IMicrosoftGraphExcludeTarget[]>]: Groups of users that are excluded from a policy. [Id <String>]: The object identifier of a Microsoft Entra user or group. [TargetType <String>]: authenticationMethodTargetType [State <String>]: authenticationMethodState

BODYPARAMETER <IMicrosoftGraphAuthenticationMethodsPolicy>: authenticationMethodsPolicy [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [AuthenticationMethodConfigurations <IMicrosoftGraphAuthenticationMethodConfiguration[]>]: Represents the settings for each authentication method. Automatically expanded on GET /policies/authenticationMethodsPolicy. [Id <String>]: The unique identifier for an entity. Read-only. [ExcludeTargets <IMicrosoftGraphExcludeTarget[]>]: Groups of users that are excluded from a policy. [Id <String>]: The object identifier of a Microsoft Entra user or group. [TargetType <String>]: authenticationMethodTargetType [State <String>]: authenticationMethodState [Description <String>]: A description of the policy. Read-only. [DisplayName <String>]: The name of the policy. Read-only. [LastModifiedDateTime <DateTime?>]: The date and time of the last update to the policy. Read-only. [PolicyMigrationState <String>]: authenticationMethodsPolicyMigrationState [PolicyVersion <String>]: The version of the policy in use. Read-only. [ReconfirmationInDays <Int32?>]: [RegistrationEnforcement <IMicrosoftGraphRegistrationEnforcement>]: registrationEnforcement [(Any) <Object>]: This indicates any property can be added to this object. [AuthenticationMethodsRegistrationCampaign <IMicrosoftGraphAuthenticationMethodsRegistrationCampaign>]: authenticationMethodsRegistrationCampaign [(Any) <Object>]: This indicates any property can be added to this object. [ExcludeTargets <IMicrosoftGraphExcludeTarget[]>]: Users and groups of users that are excluded from being prompted to set up the authentication method. [IncludeTargets <IMicrosoftGraphAuthenticationMethodsRegistrationCampaignIncludeTarget[]>]: Users and groups of users that are prompted to set up the authentication method. [Id <String>]: The object identifier of a Microsoft Entra user or group. [TargetType <String>]: authenticationMethodTargetType [TargetedAuthenticationMethod <String>]: The authentication method that the user is prompted to register. The value must be microsoftAuthenticator. [SnoozeDurationInDays <Int32?>]: Specifies the number of days that the user sees a prompt again if they select 'Not now' and snoozes the prompt. Minimum: 0 days. Maximum: 14 days. If the value is '0', the user is prompted during every MFA attempt. [State <String>]: advancedConfigState

REGISTRATIONENFORCEMENT <IMicrosoftGraphRegistrationEnforcement>: registrationEnforcement [(Any) <Object>]: This indicates any property can be added to this object. [AuthenticationMethodsRegistrationCampaign <IMicrosoftGraphAuthenticationMethodsRegistrationCampaign>]: authenticationMethodsRegistrationCampaign [(Any) <Object>]: This indicates any property can be added to this object. [ExcludeTargets <IMicrosoftGraphExcludeTarget[]>]: Users and groups of users that are excluded from being prompted to set up the authentication method. [Id <String>]: The object identifier of a Microsoft Entra user or group. [TargetType <String>]: authenticationMethodTargetType [IncludeTargets <IMicrosoftGraphAuthenticationMethodsRegistrationCampaignIncludeTarget[]>]: Users and groups of users that are prompted to set up the authentication method. [Id <String>]: The object identifier of a Microsoft Entra user or group. [TargetType <String>]: authenticationMethodTargetType [TargetedAuthenticationMethod <String>]: The authentication method that the user is prompted to register. The value must be microsoftAuthenticator. [SnoozeDurationInDays <Int32?>]: Specifies the number of days that the user sees a prompt again if they select 'Not now' and snoozes the prompt. Minimum: 0 days. Maximum: 14 days. If the value is '0', the user is prompted during every MFA attempt. [State <String>]: advancedConfigState

Related Links