Share via


Get-MgBetaSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule

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 v1.0 release of this cmdlet, view Get-MgSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule

Syntax

List (Default)

Get-MgBetaSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule

    -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>]
    [<CommonParameters>]

Get

Get-MgBetaSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule

    -SharePointProtectionPolicyId <String>
    -SiteProtectionRuleId <String>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<CommonParameters>]

GetViaIdentity

Get-MgBetaSolutionBackupRestoreSharePointProtectionPolicySiteInclusionRule

    -InputObject <IBackupRestoreIdentity>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<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.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CV

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExpandProperty

Expand related entities

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Expand

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Filter

Filter items by property values

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
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

-InputObject

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

Parameter properties

Type:IBackupRestoreIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-PageSize

Sets the page size of results.

Parameter properties

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

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Property

Select properties to be returned

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Select

Parameter sets

(All)
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

Search items by search phrases

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SharePointProtectionPolicyId

The unique identifier of sharePointProtectionPolicy

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SiteProtectionRuleId

The unique identifier of siteProtectionRule

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Skip

Skip the first n items

Parameter properties

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

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Sort

Order items by property values

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:OrderBy

Parameter sets

List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Top

Show only the first n items

Parameter properties

Type:Int32
Default value:0
Supports wildcards:False
DontShow:False
Aliases:Limit

Parameter sets

List
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.IBackupRestoreIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.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
  • [DriveProtectionUnitsBulkAdditionJobId <String>]: The unique identifier of driveProtectionUnitsBulkAdditionJob
  • [DriveRestoreArtifactId <String>]: The unique identifier of driveRestoreArtifact
  • [DriveRestoreArtifactsBulkAdditionRequestId <String>]: The unique identifier of driveRestoreArtifactsBulkAdditionRequest
  • [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
  • [MailboxProtectionUnitsBulkAdditionJobId <String>]: The unique identifier of mailboxProtectionUnitsBulkAdditionJob
  • [MailboxRestoreArtifactId <String>]: The unique identifier of mailboxRestoreArtifact
  • [MailboxRestoreArtifactsBulkAdditionRequestId <String>]: The unique identifier of mailboxRestoreArtifactsBulkAdditionRequest
  • [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
  • [SiteProtectionUnitsBulkAdditionJobId <String>]: The unique identifier of siteProtectionUnitsBulkAdditionJob
  • [SiteRestoreArtifactId <String>]: The unique identifier of siteRestoreArtifact
  • [SiteRestoreArtifactsBulkAdditionRequestId <String>]: The unique identifier of siteRestoreArtifactsBulkAdditionRequest