Share via

Get-MgSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule

Module:
Microsoft.Graph.BackupRestore

Get a protection rule that's associated with a protection policy. You can use this operation to get mailbox, drive, and site protection rules. An inclusion rule indicates that a protection policy should contain protection units that match the specified rule criteria. The initial status of a protection rule upon creation is active. After the rule is applied, the state is either completed or completedWithErrors.

Note

To view the beta release of this cmdlet, view Get-MgBetaSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule

Syntax

Get-MgSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule
   -SharePointProtectionPolicyId <String>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-Filter <String>]
   [-Search <String>]
   [-Skip <Int32>]
   [-Sort <String[]>]
   [-Top <Int32>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-PageSize <Int32>]
   [-All]
   [-CountVariable <String>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-MgSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule
   -SharePointProtectionPolicyId <String>
   -SiteProtectionRuleId <String>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]
Get-MgSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule
   -InputObject <IBackupRestoreIdentity>
   [-ExpandProperty <String[]>]
   [-Property <String[]>]
   [-ResponseHeadersVariable <String>]
   [-Headers <IDictionary>]
   [-ProgressAction <ActionPreference>]
   [<CommonParameters>]

Description

Get a protection rule that's associated with a protection policy. You can use this operation to get mailbox, drive, and site protection rules. An inclusion rule indicates that a protection policy should contain protection units that match the specified rule criteria. The initial status of a protection rule upon creation is active. After the rule is applied, the state is either completed or completedWithErrors.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) BackupRestore-Configuration.Read.All, BackupRestore-Configuration.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application BackupRestore-Configuration.Read.All, BackupRestore-Configuration.ReadWrite.All,

Parameters

-All

List all pages.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CountVariable

Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.

Type:String
Aliases:CV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExpandProperty

Expand related entities

Type:String[]
Aliases:Expand
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Filter items by property values

Type:String
Position:Named
Default value:None
Required:False
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:IBackupRestoreIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PageSize

Sets the page size of results.

Type:Int32
Position:Named
Default value:0
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

-Property

Select properties to be returned

Type:String[]
Aliases:Select
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

-Search

Search items by search phrases

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

-SharePointProtectionPolicyId

The unique identifier of sharePointProtectionPolicy

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

-SiteProtectionRuleId

The unique identifier of siteProtectionRule

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

-Skip

Skip the first n items

Type:Int32
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Sort

Order items by property values

Type:String[]
Aliases:OrderBy
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

Show only the first n items

Type:Int32
Aliases:Limit
Position:Named
Default value:0
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.PowerShell.Models.IBackupRestoreIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphSiteProtectionRule

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 <IBackupRestoreIdentity>: Identity Parameter

  • [DriveProtectionRuleId <String>]: The unique identifier of driveProtectionRule
  • [DriveProtectionUnitId <String>]: The unique identifier of driveProtectionUnit
  • [DriveRestoreArtifactId <String>]: The unique identifier of driveRestoreArtifact
  • [ExchangeProtectionPolicyId <String>]: The unique identifier of exchangeProtectionPolicy
  • [ExchangeRestoreSessionId <String>]: The unique identifier of exchangeRestoreSession
  • [GranularMailboxRestoreArtifactId <String>]: The unique identifier of granularMailboxRestoreArtifact
  • [MailboxProtectionRuleId <String>]: The unique identifier of mailboxProtectionRule
  • [MailboxProtectionUnitId <String>]: The unique identifier of mailboxProtectionUnit
  • [MailboxRestoreArtifactId <String>]: The unique identifier of mailboxRestoreArtifact
  • [OneDriveForBusinessProtectionPolicyId <String>]: The unique identifier of oneDriveForBusinessProtectionPolicy
  • [OneDriveForBusinessRestoreSessionId <String>]: The unique identifier of oneDriveForBusinessRestoreSession
  • [ProtectionPolicyBaseId <String>]: The unique identifier of protectionPolicyBase
  • [ProtectionUnitBaseId <String>]: The unique identifier of protectionUnitBase
  • [RestorePointId <String>]: The unique identifier of restorePoint
  • [RestoreSessionBaseId <String>]: The unique identifier of restoreSessionBase
  • [ServiceAppId <String>]: The unique identifier of serviceApp
  • [SharePointProtectionPolicyId <String>]: The unique identifier of sharePointProtectionPolicy
  • [SharePointRestoreSessionId <String>]: The unique identifier of sharePointRestoreSession
  • [SiteProtectionRuleId <String>]: The unique identifier of siteProtectionRule
  • [SiteProtectionUnitId <String>]: The unique identifier of siteProtectionUnit
  • [SiteRestoreArtifactId <String>]: The unique identifier of siteRestoreArtifact