spo web rule get

Retrieves information about a specific alert from a SharePoint list

Usage

m365 spo web rule get [options]

Options

-u, --webUrl <webUrl>

The URL of the SharePoint site.

--id <id>

The ID of the rule.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, permissions, response, full. Default is options.

--query [query]

JMESPath query string. See http://jmespath.org/ for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.

--verbose

Runs command with verbose logging.

--debug

Runs command with debug logging.

Permissions

Delegated

Resource	Permissions
SharePoint	AllSites.FullControl
Microsoft Graph	User.ReadBasic.All

Application

Resource	Permissions
SharePoint	Sites.FullControl.All
Microsoft Graph	User.ReadBasic.All

Examples

Retrieve a rule by ID

m365 spo web rule get --webUrl https://contoso.sharepoint.com/sites/Marketing --id 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e

Response

JSON

{
  "AlertFrequency": 0,
  "AlertTemplateName": "SPAlertTemplateType.DocumentLibrary",
  "AlertType": 0,
  "AlwaysNotify": false,
  "DeliveryChannels": 1,
  "EventType": -1,
  "Filter": "",
  "ID": "7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e",
  "Status": 0,
  "Title": "Marketing documents",
  "UserId": 8,
  "List": {
    "Id": "39d9e102-9e8f-4e74-8f17-84a92f972fcf",
    "Title": "Documents",
    "RootFolder": {
      "ServerRelativeUrl": "/sites/Marketing/Shared Documents"
    }
  },
  "User": {
    "Id": 8,
    "UserPrincipalName": "jane.doe@contoso.com"
  }
}

Text

AlertFrequency   : 0
AlertTemplateName: SPAlertTemplateType.DocumentLibrary
AlertType        : 0
AlwaysNotify     : false
DeliveryChannels : 1
EventType        : -1
Filter           : 
ID               : 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e
Status           : 0
Title            : Marketing documents
UserId           : 8
List             : {"Id":"39d9e102-9e8f-4e74-8f17-84a92f972fcf","Title":"Documents","RootFolder":{"ServerRelativeUrl":"/sites/Marketing/Shared Documents"}}
User             : {"Id":8,"UserPrincipalName":"jane.doe@contoso.com"}