Share via

Suspend-MgBetaEducationSynchronizationProfile

  • Reference
Module:
Microsoft.Graph.Beta.Education

Pause the sync of a specific school data synchronization profile in the tenant.

Syntax

Suspend-MgBetaEducationSynchronizationProfile
       -EducationSynchronizationProfileId <String>
       [-ResponseHeadersVariable <String>]
       [-Headers <IDictionary>]
       [-PassThru]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Suspend-MgBetaEducationSynchronizationProfile
       -InputObject <IEducationIdentity>
       [-ResponseHeadersVariable <String>]
       [-Headers <IDictionary>]
       [-PassThru]
       [-ProgressAction <ActionPreference>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

Pause the sync of a specific school data synchronization profile in the tenant.

Permissions

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) EduAdministration.ReadWrite Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application EduAdministration.ReadWrite.All Not available.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.Education

Suspend-MgBetaEducationSynchronizationProfile -EducationSynchronizationProfileId $educationSynchronizationProfileId

This example shows how to use the Suspend-MgBetaEducationSynchronizationProfile Cmdlet.

Parameters

-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

-EducationSynchronizationProfileId

The unique identifier of educationSynchronizationProfile

Type:String
Position:Named
Default value:None
Required:True
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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IEducationIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Returns true when the command succeeds

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

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

System.Collections.IDictionary

Outputs

System.Boolean

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.

INPUTOBJECT <IEducationIdentity>: Identity Parameter

  • [EducationAssignmentId <String>]: The unique identifier of educationAssignment
  • [EducationAssignmentResourceId <String>]: The unique identifier of educationAssignmentResource
  • [EducationAssignmentResourceId1 <String>]: The unique identifier of educationAssignmentResource
  • [EducationCategoryId <String>]: The unique identifier of educationCategory
  • [EducationClassId <String>]: The unique identifier of educationClass
  • [EducationGradingCategoryId <String>]: The unique identifier of educationGradingCategory
  • [EducationGradingSchemeId <String>]: The unique identifier of educationGradingScheme
  • [EducationModuleId <String>]: The unique identifier of educationModule
  • [EducationModuleResourceId <String>]: The unique identifier of educationModuleResource
  • [EducationOutcomeId <String>]: The unique identifier of educationOutcome
  • [EducationRubricId <String>]: The unique identifier of educationRubric
  • [EducationSchoolId <String>]: The unique identifier of educationSchool
  • [EducationSubmissionId <String>]: The unique identifier of educationSubmission
  • [EducationSubmissionResourceId <String>]: The unique identifier of educationSubmissionResource
  • [EducationSubmissionResourceId1 <String>]: The unique identifier of educationSubmissionResource
  • [EducationSynchronizationErrorId <String>]: The unique identifier of educationSynchronizationError
  • [EducationSynchronizationProfileId <String>]: The unique identifier of educationSynchronizationProfile
  • [EducationUserId <String>]: The unique identifier of educationUser