Adds spo site alert get command. Closes #6862
#6998
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| import Global from '/docs/cmd/_global.mdx'; | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| # spo site alert get | ||
|
|
||
| Retrieves details of a specific alert from a SharePoint list | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| m365 spo site alert get [options] | ||
| ``` | ||
|
|
||
| ## Options | ||
|
|
||
| ```md definition-list | ||
| `-u, --webUrl <webUrl>` | ||
| : The URL of the SharePoint site | ||
|
|
||
| `--id <id>` | ||
| : The ID of the alert | ||
| ``` | ||
|
|
||
| <Global /> | ||
|
|
||
| ## Permissions | ||
|
|
||
| <Tabs> | ||
| <TabItem value="Delegated"> | ||
|
|
||
| | Resource | Permissions | | ||
| |------------|----------------------| | ||
| | SharePoint | AllSites.FullControl | | ||
|
|
||
| </TabItem> | ||
| <TabItem value="Application"> | ||
|
|
||
| | Resource | Permissions | | ||
| |------------|-----------------------| | ||
| | SharePoint | Sites.FullControl.All | | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ## Examples | ||
|
|
||
| Get details of an alert by ID | ||
|
|
||
| ```sh | ||
| m365 spo site alert get --webUrl https://contoso.sharepoint.com/sites/Marketing --id 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e | ||
| ``` | ||
|
|
||
| ## Response | ||
|
|
||
| <Tabs> | ||
| <TabItem value="JSON"> | ||
|
|
||
| ```json | ||
| { | ||
| "AlertFrequency": 0, | ||
| "AlertTemplateName": "SPAlertTemplateType.DocumentLibrary", | ||
| "AlertType": 0, | ||
| "AlwaysNotify": false, | ||
| "DeliveryChannels": 1, | ||
| "EventType": -1, | ||
| "Filter": "", | ||
| "ID": "a188ee89-72e2-4327-9802-8d0c408ec129", | ||
| "List": { | ||
| "Id": "1ec04825-b082-46f8-9a1c-b6b54d83bc46", | ||
| "RootFolder": { | ||
| "ServerRelativeUrl": "/sites/Marketing/Documents" | ||
| }, | ||
| "Title": "Documents" | ||
| }, | ||
| "Properties": [ | ||
| { | ||
| "Key": "dispformurl", | ||
| "Value": "Documents/Forms/DispForm.aspx", | ||
| "ValueType": "Edm.String" | ||
| }, | ||
| { | ||
| "Key": "filterindex", | ||
| "Value": "0", | ||
| "ValueType": "Edm.String" | ||
| }, | ||
| { | ||
| "Key": "defaultitemopen", | ||
| "Value": "Browser", | ||
| "ValueType": "Edm.String" | ||
| }, | ||
| { | ||
| "Key": "sendurlinsms", | ||
| "Value": "False", | ||
| "ValueType": "Edm.String" | ||
| }, | ||
| { | ||
|
Comment on lines
+76
to
+97
There was a problem hiding this comment. For a list, we require to only show 1 item of the list to reduce cluttering the docs. Let's update this for other response types as well. |
||
| "Key": "mobileurl", | ||
| "Value": "https://contoso.sharepoint.com/_layouts/15/mobile/", | ||
| "ValueType": "Edm.String" | ||
| }, | ||
| { | ||
| "Key": "eventtypeindex", | ||
| "Value": "0", | ||
| "ValueType": "Edm.String" | ||
| }, | ||
| { | ||
| "Key": "siteurl", | ||
| "Value": "https://contoso.sharepoint.com", | ||
| "ValueType": "Edm.String" | ||
| } | ||
| ], | ||
| "Status": 0, | ||
| "Title": "Documents", | ||
| "User": { | ||
| "Email": "[email protected]", | ||
| "Expiration": "", | ||
| "Id": 10, | ||
| "IsEmailAuthenticationGuestUser": false, | ||
| "IsHiddenInUI": false, | ||
| "IsShareByEmailGuestUser": false, | ||
| "IsSiteAdmin": true, | ||
| "LoginName": "i:0#.f|membership|[email protected]", | ||
| "PrincipalType": 1, | ||
| "Title": "Admin User", | ||
| "UserId": { | ||
| "NameId": "100320009d8267fc", | ||
| "NameIdIssuer": "urn:federation:microsoftonline" | ||
| }, | ||
| "UserPrincipalName": "[email protected]" | ||
| }, | ||
| "UserId": 10 | ||
| } | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| <TabItem value="Text"> | ||
|
|
||
| ```text | ||
| AlertFrequency : 0 | ||
| AlertTemplateName: SPAlertTemplateType.DocumentLibrary | ||
| AlertType : 0 | ||
| AlwaysNotify : false | ||
| DeliveryChannels : 1 | ||
| EventType : -1 | ||
| Filter : | ||
| ID : a188ee89-72e2-4327-9802-8d0c408ec129 | ||
| List : {"RootFolder":{"ServerRelativeUrl":"/FlowTest"},"Id":"1ec04825-b082-46f8-9a1c-b6b54d83bc46","Title":"FlowTest"} | ||
| Properties : [{"Key":"dispformurl","Value":"FlowTest/Forms/DispForm.aspx","ValueType":"Edm.String"},{"Key":"filterindex","Value":"0","ValueType":"Edm.String"},{"Key":"defaultitemopen","Value":"Browser","ValueType":"Edm.String"},{"Key":"sendurlinsms","Value":"False","ValueType":"Edm.String"},{"Key":"mobileurl","Value":"https://contoso.sharepoint.com/_layouts/15/mobile/","ValueType":"Edm.String"},{"Key":"eventtypeindex","Value":"0","ValueType":"Edm.String"},{"Key":"siteurl","Value":"https://contoso.sharepoint.com","ValueType":"Edm.String"}] | ||
| Status : 0 | ||
| Title : FlowTest | ||
milanholemans marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| User : {"Id":10,"IsHiddenInUI":false,"LoginName":"i:0#.f|membership|[email protected]","Title":"Admin","PrincipalType":1,"Email":"[email protected]","Expiration":"","IsEmailAuthenticationGuestUser":false,"IsShareByEmailGuestUser":false,"IsSiteAdmin":true,"UserId":{"NameId":"100320009d8267fc","NameIdIssuer":"urn:federation:microsoftonline"},"UserPrincipalName":"[email protected]"} | ||
milanholemans marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| UserId : 10 | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| <TabItem value="CSV"> | ||
|
|
||
| ```csv | ||
| AlertFrequency,AlertTemplateName,AlertType,AlwaysNotify,DeliveryChannels,EventType,Filter,ID,Status,Title,UserId | ||
| 0,SPAlertTemplateType.DocumentLibrary,0,false,1,-1,,a188ee89-72e2-4327-9802-8d0c408ec129,0,Documents,10 | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| <TabItem value="Markdown"> | ||
|
|
||
| ```md | ||
| # spo site alert get --webUrl "https://contoso.sharepoint.com/sites/Marketing" --id "7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e" | ||
|
|
||
| Date: 10/1/2025 | ||
|
|
||
| Property | Value | ||
| ---------|------- | ||
| AlertFrequency | 0 | ||
| AlertTemplateName | SPAlertTemplateType.DocumentLibrary | ||
| AlertType | 0 | ||
| AlwaysNotify | false | ||
| DeliveryChannels | 1 | ||
| EventType | -1 | ||
| Filter | | ||
| ID | a188ee89-72e2-4327-9802-8d0c408ec129 | ||
| Status | 0 | ||
| Title | Documents | ||
| UserId | 10 | ||
| ``` | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
|
There was a problem hiding this comment. Let's remove one empty line at the end of the file. |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.