diff --git a/scripts/cli-for-microsoft365-create-grounding-data.ps1 b/scripts/cli-for-microsoft365-create-grounding-data.ps1 index 3dd83b7..af3ebe6 100644 --- a/scripts/cli-for-microsoft365-create-grounding-data.ps1 +++ b/scripts/cli-for-microsoft365-create-grounding-data.ps1 @@ -78,4 +78,4 @@ foreach ($key in $commandsData.Keys) { $dataArray += $orderedHashtable } -$dataArray | ConvertTo-Json -Depth 3 | Out-File "$workspacePath\vscode-viva\src\chat\cli-for-microsoft365-spo-commands.ts" \ No newline at end of file +$dataArray | ConvertTo-Json -Depth 3 | Out-File "$workspacePath\vscode-viva\src\chat\CliForMicrosoft365SpoCommands.ts" \ No newline at end of file diff --git a/src/chat/cli-for-microsoft365-spo-commands.ts b/src/chat/CliForMicrosoft365SpoCommands.ts similarity index 60% rename from src/chat/cli-for-microsoft365-spo-commands.ts rename to src/chat/CliForMicrosoft365SpoCommands.ts index 7c85621..202f07f 100644 --- a/src/chat/cli-for-microsoft365-spo-commands.ts +++ b/src/chat/CliForMicrosoft365SpoCommands.ts @@ -2,330 +2,498 @@ export const Commands = [ { - "Command": "m365 spo orgnewssite list", - "Description": "Lists all organizational news sites", - "Options": null, + "Command": "m365 spo page template list", + "Description": "Lists all page templates in the given site", + "Options": "`-u, --webUrl `: URL of the site from which to retrieve available pages.", "Examples": [ { - "Example": "List all organizational news sites", - "Description": "m365 spo orgnewssite list" + "Description": "m365 spo page template list --webUrl https://contoso.sharepoint.com/sites/team-a", + "Example": "Lists all page templates in the given site" } ] }, { - "Command": "m365 spo web list", - "Description": "Lists subsites of the specified site", - "Options": "`-u, --url `: URL of the parent site for which to retrieve the list of subsites", + "Command": "m365 spo homesite get", + "Description": "Gets information about the Home Site", + "Options": null, "Examples": [ { - "Example": "Return all subsites from site https://contoso.sharepoint.com/", - "Description": "m365 spo web list --url https://contoso.sharepoint.com" + "Description": "m365 spo homesite get", + "Example": "Get information about the Home Site." } ] }, { - "Command": "m365 spo listitem attachment list", - "Description": "Gets the attachments associated to a list item", - "Options": "`-u, --webUrl `: URL of the site from which the item should be retrieved.`--listId [listId]`: ID of the list where the item should be retrieved. Specify either `listTitle`, `listId` or `listUrl`.`--listTitle [listTitle]`: Title of the list where the item should be retrieved. Specify either `listTitle`, `listId` or `listUrl`.`--listUrl [listUrl]`: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.`--listItemId `: ID of the list item.", + "Command": "m365 spo theme list", + "Description": "Retrieves the list of custom themes", + "Options": null, "Examples": [ { - "Example": "Gets the attachments from list item with the specified listItemId in list with the specified title in the specified site.", - "Description": "m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle \"Demo List\" --listItemId 147" - }, - { - "Example": "Gets the attachments from list item with the specified listItemId in list with the specified id in the specified site.", - "Description": "m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --listItemId 147" - }, - { - "Example": "Gets the attachments from a specific list item in a specific list obtained by server-relative URL in a specific site.", - "Description": "m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/Documents --listItemId 147" + "Description": "m365 spo theme list", + "Example": "List available themes" } ] }, { - "Command": "m365 spo list get", - "Description": "Gets information about the specific list", - "Options": "`-u, --webUrl `: URL of the site where the list to retrieve is located.`-i, --id [id]`: ID of the list to retrieve information for. Specify either `id`, `title`, or `url` but not multiple.`-t, --title [title]`: Title of the list to retrieve information for. Specify either `id`, `title`, or `url` but not multiple.`--url [url]`: Server- or site-relative URL of the list. Specify either `id`, `title`, or `url` but not multiple.`-p, --properties [properties]`: Comma-separated list of properties to retrieve from the list. Will retrieve all properties possible from default response, if not specified.`--withPermissions`: Set if you want to return associated roles and permissions of the list.", + "Command": "m365 spo file sharinginfo get", + "Description": "Generates a sharing information report for the specified file", + "Options": "`-u, --webUrl `: The URL of the site where the file is located`--fileUrl [fileUrl]`: The server- or site-relative decoded URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both`-i, --fileId [fileId]`: The UniqueId (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both", "Examples": [ { - "Example": "Get information about a list with specified ID located in the specified site.", - "Description": "m365 spo list get --id 0cd891ef-afce-4e55-b836-fce03286cccf --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": "`-u, --webUrl `: The URL of the site where the file is located", + "Example": "Get file sharing information report for the file with server-relative url /sites/M365CLI/Shared Documents/SharedFile.docx located in site https://contoso.sharepoint.com/sites/project-x" + }, + { + "Description": ": The server- or site-relative decoded URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both", + "Example": "`--fileUrl [fileUrl]`" }, { - "Example": "Get information about a list with specified title located in the specified site.", - "Description": "m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": ": The UniqueId (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both", + "Example": "`-i, --fileId [fileId]`" }, { - "Example": "Get information about a list with specified server relative url located in the specified site.", - "Description": "m365 spo list get --url 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": ": The URL of the site where the file is located", + "Example": "`-u, --webUrl `" }, { - "Example": "Get information about a list with specified site-relative URL located in the specified site.", - "Description": "m365 spo list get --url 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": "`--fileUrl [fileUrl]`", + "Example": "" }, { - "Example": "Get information about a list returning the specified list properties.", - "Description": "m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --properties \"Title,Id,HasUniqueRoleAssignments,AllowContentTypes\"" + "Description": "", + "Example": ": The server- or site-relative decoded URL of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both" }, { - "Example": "Get information about a list returning the list Id, Title and ServerRelativeUrl properties.", - "Description": "m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --properties \"Title,Id,RootFolder/ServerRelativeUrl\"" + "Description": ": The UniqueId (GUID) of the file for which to build the report. Specify either `fileUrl` or `fileId` but not both", + "Example": "`-i, --fileId [fileId]`" }, { - "Example": "Get information about a list along with the roles and permissions.", - "Description": "m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --withPermissions" + "Description": "Generates a sharing information report for the specified file", + "Example": "m365 spo file sharinginfo get [options]" + }, + { + "Description": "m365 spo file sharinginfo get --webUrl https://contoso.sharepoint.com/sites/project-x --fileId \"b2307a39-e878-458b-bc90-03bc578531d6\"", + "Example": "import Global from '/docs/cmd/_global.mdx';" } ] }, { - "Command": "m365 spo page get", - "Description": "Gets information about the specific modern page", - "Options": "`-n, --name `: Name of the page to retrieve.`-u, --webUrl `: URL of the site where the page to retrieve is located.`--metadataOnly`: Specify to only retrieve the metadata without the section and control information.", + "Command": "m365 spo get", + "Description": "Gets the context URL for the root SharePoint site collection and SharePoint tenant admin site", + "Options": null, "Examples": [ { - "Example": "Get information about the modern page.", - "Description": "m365 spo page get --webUrl https://contoso.sharepoint.com/sites/team-a --name home.aspx" - }, + "Description": "m365 spo get --output json", + "Example": "Get the context URL for the root SharePoint site collection and SharePoint tenant admin site" + } + ] + }, + { + "Command": "m365 spo sitedesign run status get", + "Description": "Gets information about the site scripts executed for the specified site design", + "Options": "`-u, --webUrl `: The URL of the site for which to get the information`-i, --runId `: ID of the site design applied to the site as retrieved using `spo sitedesign run list`", + "Examples": [ { - "Example": "Get all the metadata from the modern page, without the section and control count information.", - "Description": "m365 spo page get --webUrl https://contoso.sharepoint.com/sites/team-a --name home.aspx --metadataOnly" + "Description": "m365 spo sitedesign run status get --webUrl https://contoso.sharepoint.com/sites/team-a --runId b4411557-308b-4545-a3c4-55297d5cd8c8", + "Example": "List information about site scripts executed for the specified site design" } ] }, { - "Command": "m365 spo folder sharinglink list", - "Description": "Lists all the sharing links of a specific folder", - "Options": "`-u, --webUrl `: The URL of the site where the folder is located.`--folderUrl [folderUrl]`: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.`--folderId [folderId]`: The UniqueId (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.`-s, --scope [scope]`: Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.", + "Command": "m365 spo app instance list", + "Description": "Retrieve apps installed in a site", + "Options": "`-u, --siteUrl `: URL of the site collection to retrieve the apps for", "Examples": [ { - "Example": "List sharing links of a folder by id.", - "Description": "m365 spo folder sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --folderId daebb04b-a773-4baa-b1d1-3625418e3234" + "Description": "`-u, --siteUrl `: URL of the site collection to retrieve the apps for", + "Example": "Return a list of installed apps on site https://contoso.sharepoint.com/sites/site1." + }, + { + "Description": ": URL of the site collection to retrieve the apps for", + "Example": "`-u, --siteUrl `" }, { - "Example": "List sharing links of a folder by url.", - "Description": "m365 spo folder sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl \"/sites/demo/shared documents/folder\"" + "Description": "Retrieve apps installed in a site", + "Example": "m365 spo app instance list [options]" }, { - "Example": "List anonymous sharing links of a folder by url.", - "Description": "m365 spo folder sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --folderUrl \"/sites/demo/shared documents/folder\" --scope anonymous" + "Description": "m365 spo app instance list --siteUrl https://contoso.sharepoint.com/sites/site1", + "Example": "import Global from '/docs/cmd/_global.mdx';" } ] }, { - "Command": "m365 spo term set list", - "Description": "Lists taxonomy term sets from the given term group", - "Options": "`-u, --webUrl [webUrl]`: If specified, allows you to list term sets from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.`--termGroupId [termGroupId]`: ID of the term group from which to retrieve term sets. Specify `termGroupName` or `termGroupId` but not both.`--termGroupName [termGroupName]`: Name of the term group from which to retrieve term sets. Specify `termGroupName` or `termGroupId` but not both.", + "Command": "m365 spo page control get", + "Description": "Gets information about the specific control on a modern page", + "Options": "`-i, --id `: ID of the control to retrieve information for.`-n, --pageName `: Name of the page where the control is located.`-u, --webUrl `: URL of the site where the page to retrieve is located.", "Examples": [ { - "Example": "List taxonomy term sets from the term group with the given name.", - "Description": "m365 spo term set list --termGroupName PnPTermSets" - }, + "Description": "m365 spo page control get --id 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1 --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx", + "Example": "Get information about the control with ID 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1 placed on a modern page with name home.aspx" + } + ] + }, + { + "Command": "m365 spo page get", + "Description": "Gets information about the specific modern page", + "Options": "`-n, --name `: Name of the page to retrieve.`-u, --webUrl `: URL of the site where the page to retrieve is located.`--metadataOnly`: Specify to only retrieve the metadata without the section and control information.", + "Examples": [ { - "Example": "List taxonomy term sets from the term group with the given ID.", - "Description": "m365 spo term set list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb" + "Description": "m365 spo page get --webUrl https://contoso.sharepoint.com/sites/team-a --name home.aspx", + "Example": "Get information about the modern page" }, { - "Example": "List taxonomy term sets from the specified sitecollection, from the term group with the given name.", - "Description": "m365 spo term set list --termGroupName PnPTermSets --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": "m365 spo page get --webUrl https://contoso.sharepoint.com/sites/team-a --name home.aspx --metadataOnly", + "Example": "Get all the metadata from the modern page, without the section and control count information" } ] }, { - "Command": "m365 spo page control get", - "Description": "Gets information about the specific control on a modern page", - "Options": "`-i, --id `: ID of the control to retrieve information for.`-n, --pageName `: Name of the page where the control is located.`-u, --webUrl `: URL of the site where the page to retrieve is located.", + "Command": "m365 spo web list", + "Description": "Lists subsites of the specified site", + "Options": "`-u, --url `: URL of the parent site for which to retrieve the list of subsites", "Examples": [ { - "Example": "Get information about the control with ID 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1 placed on a modern page with name home.aspx", - "Description": "m365 spo page control get --id 3ede60d3-dc2c-438b-b5bf-cc40bb2351e1 --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx" + "Description": "m365 spo web list --url https://contoso.sharepoint.com", + "Example": "Return all subsites from site https://contoso.sharepoint.com/" } ] }, { - "Command": "m365 spo term set get", - "Description": "Gets information about the specified taxonomy term set", - "Options": "`-u, --webUrl [webUrl]`: If specified, allows you to get a term set from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.`-i, --id [id]`: ID of the term set to retrieve. Specify `name` or `id` but not both.`-n, --name [name]`: Name of the term set to retrieve. Specify `name` or `id` but not both.`--termGroupId [termGroupId]`: ID of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.`--termGroupName [termGroupName]`: Name of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.", + "Command": "m365 spo listitem get", + "Description": "Gets a list item from the specified list", + "Options": "`-u, --webUrl `: URL of the site where the item is located.`-i, --id [id]`: ID of the item to retrieve. Specify either `id` or `uniqueId` but not both.`--uniqueId [uniqueId]`: The Unique ID (GUID) of the item to retrieve. Specify either `id` or `uniqueId` but not both.`-l, --listId [listId]`: ID of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.`-t, --listTitle [listTitle]`: Title of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.`--listUrl [listUrl]`: Server- or site-relative URL of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.`-p, --properties [properties]`: Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested.`--withPermissions`: Set if you want to return associated roles and permissions.", "Examples": [ { - "Example": "Get information about a taxonomy term set using its ID.", - "Description": "m365 spo term set get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termGroupName PnPTermSets" + "Description": "m365 spo listitem get --listTitle \"Demo List\" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get an item with the ID parameter from a given list in a given site." + }, + { + "Description": "m365 spo listitem get --listTitle \"Demo List\" --uniqueId \"64dc28c4-3c43-45f6-ba66-307d9eb7e6aa\" --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get an item with the Unique ID parameter from a given list in a given site." + }, + { + "Description": "m365 spo listitem get --listTitle \"Demo List\" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties \"Title,Created\"", + "Example": "Get an item columns with the ID parameter from a given list in a given site." }, { - "Example": "Get information about a taxonomy term set using its name.", - "Description": "m365 spo term set get --name PnP-Organizations --termGroupId 0a099ee9-e231-4ae9-a5b6-d7f94a0d241d" + "Description": "m365 spo listitem get --listTitle \"Demo List\" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties \"Title,Created,Company/Title\"", + "Example": "Get an item columns and lookup column with the ID parameter from a given list in a given site." }, { - "Example": "Get information about a taxonomy term set using its ID from the specified sitecollection.", - "Description": "m365 spo term set get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termGroupName PnPTermSets --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": "m365 spo listitem get --listUrl /sites/project-x/documents --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties \"Title,Created,Company/Title\"", + "Example": "Get an item with specific properties from a given list based on the server-relative URL in a specific site." + }, + { + "Description": "m365 spo listitem get --listTitle \"Demo List\" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --withPermissions", + "Example": "Get an item with ID parameter from a given list based on the server-relative URL in a specific site with permissions." } ] }, { - "Command": "m365 spo tenant applicationcustomizer list", - "Description": "Retrieves a list of application customizers that are installed tenant-wide", - "Options": null, + "Command": "m365 spo app list", + "Description": "Lists apps from the specified app catalog", + "Options": "`-s, --appCatalogScope [appCatalogScope]`: Target app catalog. `tenant,sitecollection`. Default `tenant``-u, --appCatalogUrl [appCatalogUrl]`: URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection`", "Examples": [ { - "Example": "Retrieves a list of application customizers.", - "Description": "m365 spo tenant applicationcustomizer list" + "Description": "m365 spo app list", + "Example": "Return the list of available apps from the tenant app catalog. Show the installed version in the site if applicable." + }, + { + "Description": "m365 spo app list --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1", + "Example": "Return the list of available apps from a site collection app catalog of site https://contoso.sharepoint.com/sites/site1." } ] }, { - "Command": "m365 spo file get", - "Description": "Gets information about the specified file", - "Options": "`-u, --webUrl `: The URL of the site where the file is located.`--url [url]`: The server- or site-relative decoded URL of the file to retrieve. Specify either `url` or `id` but not both.`-i, --id [id]`: The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both.`--asString`: Set to retrieve the contents of the specified file as string.`--asListItem`: Set to retrieve the underlying list item.`--asFile`: Set to save the file to the path specified in the path option.`-p, --path [path]`: The local path where to save the retrieved file. Must be specified when the `--asFile` option is used.`--withPermissions`: Set if you want to return associated roles and permissions.", + "Command": "m365 spo contenttype get", + "Description": "Retrieves information about the specified list or site content type", + "Options": "`-u, --webUrl `: Absolute URL of the site where the content type is located`-l, --listTitle [listTitle]`: Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.`--listId [listId]`: ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.`--listUrl [listUrl]`: Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.`-i, --id [id]`: The ID of the content type to retrieve. Specify either id or name but not both`-n, --name [name]`: The name of the content type to retrieve. Specify either id or name but not both", "Examples": [ { - "Example": "Get file properties for a file with id (UniqueId) parameter located in a site.", - "Description": "m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'" + "Description": "If no content type with the specified is found in the site or the list, you will get the Content type with ID 0x010012 not found error.", + "Example": "Retrieve site content type by id" + }, + { + "Description": ": Absolute URL of the site where the content type is located", + "Example": "`-u, --webUrl `" + }, + { + "Description": ": Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.", + "Example": "`-l, --listTitle [listTitle]`" + }, + { + "Description": ": ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.", + "Example": "`--listId [listId]`" + }, + { + "Description": ": Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.", + "Example": "`--listUrl [listUrl]`" + }, + { + "Description": ": The ID of the content type to retrieve. Specify either id or name but not both", + "Example": "`-i, --id [id]`" + }, + { + "Description": ": The name of the content type to retrieve. Specify either id or name but not both", + "Example": "`-n, --name [name]`" + }, + { + "Description": ": Absolute URL of the site where the content type is located", + "Example": "`-u, --webUrl `" + }, + { + "Description": "`-l, --listTitle [listTitle]`", + "Example": "" + }, + { + "Description": "", + "Example": ": Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`." }, { - "Example": "Get contents of the file with id (UniqueId) parameter located in a site.", - "Description": "m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asString" + "Description": ": ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.", + "Example": "`--listId [listId]`" }, { - "Example": "Get list item properties for a file with id (UniqueId) parameter located in a site.", - "Description": "m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asListItem" + "Description": "`--listUrl [listUrl]`", + "Example": "" }, { - "Example": "Saves the file with id (UniqueId) parameter located in a site to a local file.", - "Description": "m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --asFile --path /Users/user/documents/SavedAsTest1.docx" + "Description": "", + "Example": ": Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`." }, { - "Example": "Return file properties for a file with server-relative url located in a site.", - "Description": "m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'" + "Description": ": The ID of the content type to retrieve. Specify either id or name but not both", + "Example": "`-i, --id [id]`" }, { - "Example": "Returns a file as string for a file with server-relative url located in a site.", - "Description": "m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asString" + "Description": "`-n, --name [name]`", + "Example": "" }, { - "Example": "Returns the list item properties for a file with the server-relative url located in a site.", - "Description": "m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asListItem" + "Description": "m365 spo contenttype get [options]", + "Example": ": The name of the content type to retrieve. Specify either id or name but not both" }, { - "Example": "Saves a file with the server-relative url located in a site to a local file.", - "Description": "m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --asFile --path /Users/user/documents/SavedAsTest1.docx" + "Description": "import Global from '/docs/cmd/_global.mdx';", + "Example": "Retrieves information about the specified list or site content type" }, { - "Example": "Gets the file properties for a file with id (UniqueId) parameter located in a site with permissions.", - "Description": "m365 spo file get --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6' --withPermissions" + "Description": null, + "Example": "m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --id 0x0100558D85B7216F6A489A499DB361E1AE2F" } ] }, { - "Command": "m365 spo cdn policy list", - "Description": "Lists CDN policies settings for the current SharePoint Online tenant", - "Options": "`-t, --cdnType [cdnType]`: Type of CDN to manage. Allowed values are: `Public`, `Private`. Default `Public`.", + "Command": "m365 spo storageentity list", + "Description": "Lists tenant properties stored on the specified SharePoint Online app catalog", + "Options": "`-u, --appCatalogUrl `: URL of the app catalog site", "Examples": [ { - "Example": "Show the list of policies configured for the Public CDN.", - "Description": "m365 spo cdn policy list" - }, + "Description": "m365 spo storageentity list -u https://contoso.sharepoint.com/sites/appcatalog", + "Example": "List all tenant properties stored in the https://contoso.sharepoint.com/sites/appcatalog app catalog site" + } + ] + }, + { + "Command": "m365 spo site get", + "Description": "Gets information about the specific site collection", + "Options": "`-u, --url `: URL of the site collection to retrieve information for", + "Examples": [ { - "Example": "Show the list of policies configured for the Private CDN.", - "Description": "m365 spo cdn policy list --cdnType Private" + "Description": "m365 spo site get -u https://contoso.sharepoint.com/sites/project-x", + "Example": "Return information about the https://contoso.sharepoint.com/sites/project-x site collection." } ] }, { - "Command": "m365 spo web retentionlabel list", - "Description": "Get a list of retention labels that are available on a site.", - "Options": "`-u, --webUrl `: URL of the site.", + "Command": "m365 spo web installedlanguage list", + "Description": "Lists all installed languages on site", + "Options": "`-u, --webUrl `: URL of the site for which to retrieve the list of installed languages", "Examples": [ { - "Example": "Get a list of retention labels for the Sales site", - "Description": "m365 spo web retentionlabel list --webUrl 'https://contoso.sharepoint.com/sites/sales'" + "Description": "m365 spo web installedlanguage list --webUrl https://contoso.sharepoint.com", + "Example": "Return all installed languages from site https://contoso.sharepoint.com/" } ] }, { - "Command": "m365 spo sitedesign rights list", - "Description": "Gets a list of principals that have access to a site design", - "Options": "`-i, --siteDesignId `: The ID of the site design to get rights information from", + "Command": "m365 spo field list", + "Description": "Retrieves columns for the specified list or site", + "Options": "`-u, --webUrl `: Absolute URL of the site where fields are located`-t, --listTitle [listTitle]`: Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl``-i --listId [listId]`: ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl``--listUrl [listUrl]`: Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`", "Examples": [ { - "Example": "Get information about rights granted for the site design with ID 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a", - "Description": "m365 spo sitedesign rights list --siteDesignId 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a" + "Description": "`-u, --webUrl `: Absolute URL of the site where fields are located", + "Example": "Retrieves site columns for site https://contoso.sharepoint.com/sites/contoso-sales." + }, + { + "Description": ": Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`", + "Example": "`-t, --listTitle [listTitle]`" + }, + { + "Description": ": ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`", + "Example": "`-i --listId [listId]`" + }, + { + "Description": ": Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`", + "Example": "`--listUrl [listUrl]`" + }, + { + "Description": ": Absolute URL of the site where fields are located", + "Example": "`-u, --webUrl `" + }, + { + "Description": "`-t, --listTitle [listTitle]`", + "Example": "" + }, + { + "Description": "", + "Example": ": Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`" + }, + { + "Description": ": ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`", + "Example": "`-i --listId [listId]`" + }, + { + "Description": "`--listUrl [listUrl]`", + "Example": "" + }, + { + "Description": "m365 spo field list [options]", + "Example": ": Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`" + }, + { + "Description": "import Global from '/docs/cmd/_global.mdx';", + "Example": "Retrieves columns for the specified list or site" + }, + { + "Description": null, + "Example": "m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'" } ] }, { - "Command": "m365 spo page section list", - "Description": "List sections in the specific modern page", - "Options": "`-u, --webUrl `: URL of the site where the page to retrieve is located.`-n, --pageName `: Name of the page to list sections of.", + "Command": "m365 spo list sitescript get", + "Description": "Extracts a site script from a SharePoint list", + "Options": "`-u, --webUrl `: URL of the site where the list to extract the site script from is located.`-l, --listId [listId]`: ID of the list to extract the site script from. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.`-t, --listTitle [listTitle]`: Title of the list to extract the site script from. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.`--listUrl [listUrl]`: Server- or site-relative URL of the list. Specify either `listId`, `listTitle`, or `listUrl` but not multiple.", "Examples": [ { - "Example": "List sections of a modern page", - "Description": "m365 spo page section list --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx" + "Description": "m365 spo list sitescript get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Extract a site script from an existing SharePoint list with specified title located in the specified site." + }, + { + "Description": "m365 spo list sitescript get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Extract a site script from an existing SharePoint list with specified id located in the specified site." + }, + { + "Description": "m365 spo list sitescript get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Extract a site script from an existing SharePoint list with specified server relative url located in the specified site." + }, + { + "Description": "m365 spo list sitescript get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Extract a site script from an existing SharePoint list with specified site-relative URL located in the specified site." } ] }, { - "Command": "m365 spo contenttypehub get", - "Description": "Returns the URL of the SharePoint Content Type Hub of the Tenant", - "Options": null, + "Command": "m365 spo tenant commandset get", + "Description": "Get a ListView Command Set that is installed tenant wide", + "Options": "`-t, --title [title]`: The title of the ListView Command Set. Specify either `title`, `id`, or `clientSideComponentId`.`-i, --id [id]`: The id of the ListView Command Set. Specify either `title`, `id`, or `clientSideComponentId`.`-c, --clientSideComponentId [clientSideComponentId]`: The Client Side Component Id (GUID) of the ListView Command Set. Specify either `title`, `id`, or `clientSideComponentId`.", "Examples": [ { - "Example": "Retrieve the Content Type Hub URL", - "Description": "m365 spo contenttypehub get" + "Description": "m365 spo tenant commandset get --title \"Some customizer\"", + "Example": "Retrieves a ListView Command Set by title." + }, + { + "Description": "m365 spo tenant commandset get --id 3", + "Example": "Retrieves a ListView Command Set by id." + }, + { + "Description": "m365 spo tenant commandset get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc", + "Example": "Retrieves a ListView Command Set by clientSideComponentId." } ] }, { - "Command": "m365 spo sitedesign task get", - "Description": "Gets information about the specified site design scheduled for execution", - "Options": "`-i, --id `: The ID of the site design task to get information for", + "Command": "m365 spo site list", + "Description": "Lists modern sites of the given type", + "Options": "`-t, --type [type]`: convenience option for type of sites to list. Allowed values are `TeamSite,CommunicationSite`.`--webTemplate [webTemplate]`: type of sites to list. To be used with values like `GROUP#0` and `SITEPAGEPUBLISHING#0`. Specify either `type` or `webTemplate`, but not both. `--filter [filter]`: filter to apply when retrieving sites`--includeOneDriveSites`: use this switch to include OneDrive sites in the result when retrieving sites. Do not specify the `type` or `webTemplate` options when using this.", "Examples": [ { - "Example": "Get information about the specified site design scheduled for execution", - "Description": "m365 spo sitedesign task get --id 6ec3ca5b-d04b-4381-b169-61378556d76e" + "Description": "m365 spo site list", + "Example": "List all sites in the currently connected tenant" + }, + { + "Description": "m365 spo site list --type TeamSite", + "Example": "List all group connected team sites in the currently connected tenant" + }, + { + "Description": "m365 spo site list --type CommunicationSite", + "Example": "List all communication sites in the currently connected tenant" + }, + { + "Description": "m365 spo site list --type TeamSite --filter \"Url -like 'project'\"", + "Example": "List all group connected team sites that contain project in the URL" + }, + { + "Description": "m365 spo site list --includeOneDriveSites", + "Example": "List all sites in the currently connected tenant including OneDrive sites" } ] }, { - "Command": "m365 spo navigation node list", - "Description": "Lists nodes from the specified site navigation", - "Options": "`-u, --webUrl `: Absolute URL of the site for which to retrieve navigation.`-l, --location `: Navigation type to retrieve. Available options: `QuickLaunch`, `TopNavigationBar`.", + "Command": "m365 spo storageentity get", + "Description": "Get details for the specified tenant property", + "Options": "`-k, --key `: Name of the tenant property to retrieve", + "Examples": [ + { + "Description": "m365 spo storageentity get -k AnalyticsId", + "Example": "Show the value, description and comment of the AnalyticsId tenant property" + } + ] + }, + { + "Command": "m365 spo cdn policy list", + "Description": "Lists CDN policies settings for the current SharePoint Online tenant", + "Options": "`-t, --cdnType [cdnType]`: Type of CDN to manage. `Public,Private`. Default `Public`", "Examples": [ { - "Example": "Retrieve nodes from the top navigation.", - "Description": "m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/team-a --location TopNavigationBar" + "Description": "m365 spo cdn policy list", + "Example": "Show the list of policies configured for the Public CDN" }, { - "Example": "Retrieve nodes from the quick launch.", - "Description": "m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/team-a --location QuickLaunch" + "Description": "m365 spo cdn policy list --cdnType Private", + "Example": "Show the list of policies configured for the Private CDN" } ] }, { - "Command": "m365 spo customaction list", - "Description": "Lists user custom actions for site or site collection", - "Options": "`-u, --webUrl `: Url of the site or site collection to retrieve the custom action from.`-s, --scope [scope]`: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`.", + "Command": "m365 spo web get", + "Description": "Retrieve information about the specified site", + "Options": "`-u, --url `: URL of the site for which to retrieve the information`--withGroups`: Set if you want to return associated groups (associatedOwnerGroup, associatedMemberGroup and associatedVisitorGroup) along with other properties`--withPermissions`: Set if you want to return associated roles and permissions", "Examples": [ { - "Example": "Return details about all user custom actions located in the specified site or site collection.", - "Description": "m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test" + "Description": "m365 spo web get --url https://contoso.sharepoint.com/subsite", + "Example": "Retrieve information about a site" }, { - "Example": "Return details about all user custom actions located in the specified site collection.", - "Description": "m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Site" + "Description": "m365 spo web get --url https://contoso.sharepoint.com/subsite --withGroups", + "Example": "Retrieve information about a site along with associated groups for the web" }, { - "Example": "Return details about all user custom actions located in the specified site.", - "Description": "m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Web" + "Description": "m365 spo web get --url https://contoso.sharepoint.com/subsite --withPermissions", + "Example": "Retrieve information about a site along with the RoleAssignments for the web" } ] }, { - "Command": "m365 spo page section get", - "Description": "Get information about the specified modern page section", - "Options": "`-u, --webUrl `: URL of the site where the page to retrieve is located.`-n, --pageName `: Name of the page to get section information of.`-s, --section `: ID of the section for which to retrieve information.", + "Command": "m365 spo sitedesign list", + "Description": "Lists available site designs for creating modern sites", + "Options": null, "Examples": [ { - "Example": "Get information about the specified section of the modern page", - "Description": "m365 spo page section get --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1" + "Description": "m365 spo sitedesign list", + "Example": "List available site designs" } ] }, @@ -335,468 +503,427 @@ export const Commands = [ "Options": "`-u, --webUrl [webUrl]`: If specified, allows you to list terms from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.`--termGroupId [termGroupId]`: ID of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both.`--termGroupName [termGroupName]`: Name of the term group where the term set is located. Specify `termGroupId` or `termGroupName` but not both.`--termSetId [termSetId]`: ID of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both.`--termSetName [termSetName]`: Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both.`--includeChildTerms`: If specified, child terms are loaded as well.", "Examples": [ { - "Example": "List taxonomy terms from the specified sitecollection, the term group and term set with the given name", - "Description": "m365 spo term list --webUrl https://contoso.sharepoint.com/sites/project-x --termGroupName PnPTermSets --termSetName PnP-Organizations" + "Description": "m365 spo term list --webUrl https://contoso.sharepoint.com/sites/project-x --termGroupName PnPTermSets --termSetName PnP-Organizations", + "Example": "List taxonomy terms from the specified sitecollection, the term group and term set with the given name" }, { - "Example": "List taxonomy terms from the term group and term set with the given name.", - "Description": "m365 spo term list --termGroupName PnPTermSets --termSetName PnP-Organizations" + "Description": "m365 spo term list --termGroupName PnPTermSets --termSetName PnP-Organizations", + "Example": "List taxonomy terms from the term group and term set with the given name." }, { - "Example": "List taxonomy terms from the term group and term set with the given ID.", - "Description": "m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec" + "Description": "m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec", + "Example": "List taxonomy terms from the term group and term set with the given ID." }, { - "Example": "List taxonomy terms from the term group and term set with the given ID including child terms if any are found.", - "Description": "m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --includeChildTerms" + "Description": "m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --includeChildTerms", + "Example": "List taxonomy terms from the term group and term set with the given ID including child terms if any are found." } ] }, { - "Command": "m365 spo app get", - "Description": "Gets information about the specific app from the specified app catalog", - "Options": "`-i, --id [id]`: ID of the app to retrieve information for. Specify the `id` or the `name` but not both.`-n, --name [name]`: Name of the app to retrieve information for. Specify the `id` or the `name` but not both.`-u, --appCatalogUrl [appCatalogUrl]`: URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection`.`-s, --appCatalogScope [appCatalogScope]`: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`.", + "Command": "m365 spo term group get", + "Description": "Gets information about the specified taxonomy term group", + "Options": "`-u, --webUrl [webUrl]`: If specified, allows you to get a term group from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.`-i, --id [id]`: ID of the term group to retrieve. Specify `name` or `id` but not both.`-n, --name [name]`: Name of the term group to retrieve. Specify `name` or `id` but not both.", "Examples": [ { - "Example": "Return details about the app with the specified ID available in the tenant app catalog.", - "Description": "m365 spo app get --id b2307a39-e878-458b-bc90-03bc578531d6" - }, - { - "Example": "Return details about the app with the specified name available in the tenant app catalog. Will try to detect the app catalog URL.", - "Description": "m365 spo app get --name solution.sppkg" + "Description": "m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb", + "Example": "Get information about a taxonomy term group using its ID." }, { - "Example": "Return details about the app with the specified name available in the tenant app catalog using the specified app catalog URL.", - "Description": "m365 spo app get --name solution.sppkg --appCatalogUrl https://contoso.sharepoint.com/sites/apps" + "Description": "m365 spo term group get --name PnPTermSets", + "Example": "Get information about a taxonomy term group using its name." }, { - "Example": "Return details about the app with the specified ID available in the site collection app catalog of the specified site.", - "Description": "m365 spo app get --id b2307a39-e878-458b-bc90-03bc578531d6 --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1" + "Description": "m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get information about a taxonomy term group from the specified sitecollection using its ID." } ] }, { - "Command": "m365 spo term get", - "Description": "Gets information about the specified taxonomy term", - "Options": "`-u, --webUrl [webUrl]`: If specified, allows you to get a term from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.`-i, --id [id]`: ID of the term to retrieve. Specify `name` or `id` but not both.`-n, --name [name]`: Name of the term to retrieve. Specify `name` or `id` but not both.`--termGroupId [termGroupId]`: ID of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.`--termGroupName [termGroupName]`: Name of the term group to which the term set belongs. Specify `termGroupId` or `termGroupName` but not both.`--termSetId [termSetId]`: ID of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both.`--termSetName [termSetName]`: Name of the term set to which the term belongs. Specify `termSetId` or `termSetName` but not both.", + "Command": "m365 spo eventreceiver get", + "Description": "Retrieves specific event receiver for the specified web, site or list by event receiver name or id.", + "Options": "`-u, --webUrl `: The URL of the web for which to retrieve the event receivers.`--listTitle [listTitle]`: The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.`--listId [listId]`: The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.`--listUrl [listUrl]`: The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.`-n, --name [name]`: The name of the event receiver to retrieve. Specify either `name` or `id` but not both.`-i, --id [id]`: The id of the event receiver to retrieve. Specify either `name` or `id` but not both.`-s, --scope [scope]`: The scope of which to retrieve the event receivers. Can be either `site` or `web`. Defaults to `web`. Only applicable when not specifying any of the list properties.", "Examples": [ { - "Example": "Get information about a taxonomy term using its ID from the specified sitecollection.", - "Description": "m365 spo term get --webUrl https://contoso.sharepoint.com/sites/project-x --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb" + "Description": "m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'", + "Example": "Retrieve event receivers in web https://contoso.sharepoint.com/sites/contoso-sales with name PnP Test Receiver." }, { - "Example": "Get information about a taxonomy term using its ID.", - "Description": "m365 spo term get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb" + "Description": "m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec", + "Example": "Retrieve event receivers in site https://contoso.sharepoint.com/sites/contoso-sales with id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec." }, { - "Example": "Get information about a taxonomy term using its name, retrieving the parent term group and term set using their names.", - "Description": "m365 spo term get --name IT --termGroupName People --termSetName Department" + "Description": "m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'", + "Example": "Retrieve event receivers for list with title Events in web https://contoso.sharepoint.com/sites/contoso-sales with name PnP Test Receiver." }, { - "Example": "Get information about a taxonomy term using its name, retrieving the parent term group and term set using their IDs.", - "Description": "m365 spo term get --name IT --termGroupId 5c928151-c140-4d48-aab9-54da901c7fef --termSetId 8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f" - } - ] - }, - { - "Command": "m365 spo group member list", - "Description": "List the members of a SharePoint Group", - "Options": "`-u, --webUrl `: URL of the SharePoint site.`--groupId [groupId]`: Id of the SharePoint group. Specify either `groupName` or `groupId`, but not both.`--groupName [groupName]`: Name of the SharePoint group. Specify either `groupName` or `groupId`, but not both.", - "Examples": [ - { - "Example": "List the members of the group with ID for the specified web.", - "Description": "m365 spo group member list --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5" + "Description": "m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec", + "Example": "Retrieve event receivers for list with ID 202b8199-b9de-43fd-9737-7f213f51c991 in web https://contoso.sharepoint.com/sites/contoso-sales with id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec." }, { - "Example": "List the members of the group with name for the specified web.", - "Description": "m365 spo group member list --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName \"Contoso Site Members\"" + "Description": "m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'", + "Example": "Retrieve event receivers for list with url /sites/contoso-sales/lists/Events in web https://contoso.sharepoint.com/sites/contoso-sales with name PnP Test Receiver." } ] }, { - "Command": "m365 spo theme get", - "Description": "Gets custom theme information", - "Options": "`-n, --name `: The name of the theme to retrieve", + "Command": "m365 spo tenant commandset list", + "Description": "Retrieves a list of ListView Command Sets that are installed tenant-wide", + "Options": null, "Examples": [ { - "Example": "Get information about a theme", - "Description": "m365 spo theme get --name Contoso-Blue" + "Description": "m365 spo tenant commandset list", + "Example": "Retrieves a list of ListView Command Sets." } ] }, { - "Command": "m365 spo cdn origin list", - "Description": "List CDN origins settings for the current SharePoint Online tenant", - "Options": "`-t, --type [type]`: Type of CDN to manage. Allowed values are: `Public`, `Private`. Default `Public`.", + "Command": "m365 spo user get", + "Description": "Gets a site user within specific web", + "Options": "`-u, --webUrl `: URL of the web to get the user within`-i, --id [id]`: ID of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.`--email [email]`: Email of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.`--loginName [loginName]`: Login name of the user to retrieve information for. Use either `email`, `id` or `loginName`, but not all.", "Examples": [ { - "Example": "Show the list of origins configured for the Public CDN.", - "Description": "m365 spo cdn origin list" + "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --email john.doe@mytenant.onmicrosoft.com", + "Example": "Get user by email for a web" + }, + { + "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --id 6", + "Example": "Get user by ID for a web" + }, + { + "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --loginName \"i:0#.f|membership|john.doe@mytenant.onmicrosoft.com\"", + "Example": "Get user by login name for a web" }, { - "Example": "Show the list of origins configured for the Private CDN.", - "Description": "m365 spo cdn origin list --type Private" + "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get the currently logged-in user" } ] }, { - "Command": "m365 spo sitedesign get", - "Description": "Gets information about the specified site design", - "Options": "`-i, --id [id]`: Site design ID. Specify either `id` or `title` but not both.`--title [title]`: Site design title. Specify either `id` or `title` but not both.", + "Command": "m365 spo customaction list", + "Description": "Lists user custom actions for site or site collection", + "Options": "`-u, --webUrl `: Url of the site or site collection to retrieve the custom action from`-s, --scope [scope]`: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`", "Examples": [ { - "Example": "Get information about the site design with ID 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a", - "Description": "m365 spo sitedesign get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a" + "Description": "m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test", + "Example": "Return details about all user custom actions located in site or site collection https://contoso.sharepoint.com/sites/test" + }, + { + "Description": "m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Site", + "Example": "Return details about all user custom actions located in site collection https://contoso.sharepoint.com/sites/test" }, { - "Example": "Get information about the site design with title Contoso Site Design", - "Description": "m365 spo sitedesign get --title \"Contoso Site Design\"" + "Description": "m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Web", + "Example": "Return details about all user custom actions located in site https://contoso.sharepoint.com/sites/test" } ] }, { - "Command": "m365 spo contenttype list", - "Description": "Lists content types from specified site", - "Options": "`-u, --webUrl `: Absolute URL of the site for which to list content types.`-c, --category [category]`: Category name of content types. When defined will return only content types from specified category.", - "Examples": [ - { - "Example": "Retrieve site content types.", - "Description": "m365 spo contenttype list --webUrl \"https://contoso.sharepoint.com/sites/contoso-sales\"" - }, - { - "Example": "Retrieve site content types from the 'List Content Types' category.", - "Description": "m365 spo contenttype list --webUrl \"https://contoso.sharepoint.com/sites/contoso-sales\" --category \"List Content Types\"" - } - ] - }, - { - "Command": "m365 spo page template list", - "Description": "Lists all page templates in the given site", - "Options": "`-u, --webUrl `: URL of the site from which to retrieve available pages.", - "Examples": [ - { - "Example": "Lists all page templates in the given site", - "Description": "m365 spo page template list --webUrl https://contoso.sharepoint.com/sites/team-a" - } - ] - }, - { - "Command": "m365 spo homesite get", - "Description": "Gets information about the Home Site", + "Command": "m365 spo tenant settings list", + "Description": "Lists the global tenant settings", "Options": null, "Examples": [ { - "Example": "Get information about the Home Site.", - "Description": "m365 spo homesite get" + "Description": "m365 spo tenant settings list", + "Example": "Lists the settings of the tenant" } ] }, { - "Command": "m365 spo hidedefaultthemes get", - "Description": "Gets the current value of the HideDefaultThemes setting", - "Options": null, + "Command": "m365 spo roledefinition get", + "Description": "Gets specified role definition from web", + "Options": "`-u, --webUrl `: URL of the site for which to retrieve the role definition.`-i, --id `: The Id of the role definition to retrieve.", "Examples": [ { - "Example": "Get the current value of the HideDefaultThemes setting.", - "Description": "m365 spo hidedefaultthemes get" + "Description": "m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1", + "Example": "Retrieve the role definition for the given site" } ] }, { - "Command": "m365 spo sitescript list", - "Description": "Lists site script available for use with site designs", - "Options": null, + "Command": "m365 spo field get", + "Description": "Retrieves information about the specified list- or site column", + "Options": "`-u, --webUrl `: Absolute URL of the site where the field is located`-l, --listTitle [listTitle]`: Title of the list where the field is located. Specify only one of listTitle, listId or listUrl`--listId [listId]`: ID of the list where the field is located. Specify only one of listTitle, listId or listUrl`--listUrl [listUrl]`: Server- or web-relative URL of the list where the field is located. Specify only one of listTitle, listId or listUrl`-i, --id [id]`: The ID of the field to retrieve. Specify id or title but not both`-t, --title [title]`: The display name (case-sensitive) of the field to remove. Specify id or title, or group but not both", "Examples": [ { - "Example": "List all site scripts available for use with site designs", - "Description": "m365 spo sitescript list" - } - ] - }, - { - "Command": "m365 spo term group list", - "Description": "Lists taxonomy term groups", - "Options": "`-u, --webUrl [webUrl]`: If specified, allows you to list term groups from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.", - "Examples": [ + "Description": "`-u, --webUrl `: Absolute URL of the site where the field is located", + "Example": "Retrieves site column by id located in site https://contoso.sharepoint.com/sites/contoso-sales" + }, { - "Example": "List taxonomy term groups.", - "Description": "m365 spo term group list" + "Description": ": Title of the list where the field is located. Specify only one of listTitle, listId or listUrl", + "Example": "`-l, --listTitle [listTitle]`" }, { - "Example": "List taxonomy term groups from the specified sitecollection.", - "Description": "m365 spo term group list --webUrl https://contoso.sharepoint.com/sites/project-x" - } - ] - }, - { - "Command": "m365 spo propertybag list", - "Description": "Gets property bag values", - "Options": "`-u, --webUrl `: The URL of the site from which the property bag value should be retrieved.`--folder [folder]`: Site-relative URL of the folder from which to retrieve property bag value. Case-sensitive.", - "Examples": [ + "Description": ": ID of the list where the field is located. Specify only one of listTitle, listId or listUrl", + "Example": "`--listId [listId]`" + }, { - "Example": "Return property bag values located in the given site", - "Description": "m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test" + "Description": ": Server- or web-relative URL of the list where the field is located. Specify only one of listTitle, listId or listUrl", + "Example": "`--listUrl [listUrl]`" }, { - "Example": "Return property bag values located in the given site root folder", - "Description": "m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder /" + "Description": ": The ID of the field to retrieve. Specify id or title but not both", + "Example": "`-i, --id [id]`" }, { - "Example": "Return property bag values located in the given site document library", - "Description": "m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder '/Shared Documents'" + "Description": ": The display name (case-sensitive) of the field to remove. Specify id or title, or group but not both", + "Example": "`-t, --title [title]`" }, { - "Example": "Return property bag values located in folder in the given site document library", - "Description": "m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder '/Shared Documents/MyFolder'" + "Description": ": Absolute URL of the site where the field is located", + "Example": "`-u, --webUrl `" }, { - "Example": "Return property bag values located in the given site list", - "Description": "m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder /Lists/MyList" - } - ] - }, - { - "Command": "m365 spo applicationcustomizer get", - "Description": "Get an application customizer that is added to a site", - "Options": "`-u, --webUrl `: URL of the site.`-t, --title [title]`: The title of the Application Customizer. Specify either `title`, `id` or `clientSideComponentId`.`-i, --id [id]`: The id of the Application Customizer. Specify either `title`, `id` or `clientSideComponentId`.`-c, --clientSideComponentId [clientSideComponentId]`: The Client Side Component Id (GUID) of the application customizer. Specify either `title`, `id` or `clientSideComponentId`.`-s, --scope [scope]`: Scope of the application customizer. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.`-p, --clientSideComponentProperties`: Only output the client-side component properties.", - "Examples": [ + "Description": "`-l, --listTitle [listTitle]`", + "Example": "" + }, { - "Example": "Retrieves an application customizer by title.", - "Description": "m365 spo applicationcustomizer get --title \"Some customizer\" --webUrl https://contoso.sharepoint.com/sites/sales" + "Description": "", + "Example": ": Title of the list where the field is located. Specify only one of listTitle, listId or listUrl" }, { - "Example": "Retrieves an application customizer by id.", - "Description": "m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales" + "Description": ": ID of the list where the field is located. Specify only one of listTitle, listId or listUrl", + "Example": "`--listId [listId]`" }, { - "Example": "Retrieves an application customizer by clientSideComponentId.", - "Description": "m365 spo applicationcustomizer get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales" + "Description": "`--listUrl [listUrl]`", + "Example": "" }, { - "Example": "Retrieves an application customizer by title available at the site scope.", - "Description": "m365 spo applicationcustomizer get --title \"Some customizer\" --webUrl https://contoso.sharepoint.com/sites/sales --scope site" + "Description": "", + "Example": ": Server- or web-relative URL of the list where the field is located. Specify only one of listTitle, listId or listUrl" }, { - "Example": "Retrieves the client-side component properties of a application customizer.", - "Description": "m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --clientSideComponentProperties" - } - ] - }, - { - "Command": "m365 spo tenant commandset get", - "Description": "Get a ListView Command Set that is installed tenant-wide", - "Options": "`-t, --title [title]`: The title of the ListView Command Set. Specify either `title`, `id`, or `clientSideComponentId`.`-i, --id [id]`: The id of the ListView Command Set. Specify either `title`, `id`, or `clientSideComponentId`.`-c, --clientSideComponentId [clientSideComponentId]`: The Client Side Component Id (GUID) of the ListView Command Set. Specify either `title`, `id`, or `clientSideComponentId`.`-p, --tenantWideExtensionComponentProperties`: Only output the tenant wide extension component properties.", - "Examples": [ + "Description": ": The ID of the field to retrieve. Specify id or title but not both", + "Example": "`-i, --id [id]`" + }, + { + "Description": "`-t, --title [title]`", + "Example": "" + }, { - "Example": "Retrieves a ListView Command Set by title.", - "Description": "m365 spo tenant commandset get --title \"Some customizer\"" + "Description": "m365 spo field get [options]", + "Example": ": The display name (case-sensitive) of the field to remove. Specify id or title, or group but not both" }, { - "Example": "Retrieves a ListView Command Set by id.", - "Description": "m365 spo tenant commandset get --id 3" + "Description": "import Global from '/docs/cmd/_global.mdx';", + "Example": "Retrieves information about the specified list- or site column" }, { - "Example": "Retrieves a ListView Command Set by clientSideComponentId.", - "Description": "m365 spo tenant commandset get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc" + "Description": null, + "Example": "m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl \"Lists/Events\" --title \"Title\"" } ] }, { - "Command": "m365 spo file version list", - "Description": "Retrieves all versions of a file", - "Options": "`-u, --webUrl `: The URL of the site where the file is located.`--fileUrl [fileUrl]`: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.`-i, --fileId [fileId]`: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.", + "Command": "m365 spo list list", + "Description": "Gets all lists within the specified site", + "Options": "`-u, --webUrl `: URL of the site where the lists to retrieve are located.`-p, --properties [properties]`: Comma-separated list of properties to retrieve. Will retrieve all properties if not specified.`--filter [filter]`: OData filter to use to query the lists with.", "Examples": [ { - "Example": "List file versions of a specific file based on the ID of the file.", - "Description": "m365 spo file version list --webUrl https://contoso.sharepoint.com --fileId 'b2307a39-e878-458b-bc90-03bc578531d6'" + "Description": "m365 spo list list --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Return all lists located in in a specific site." + }, + { + "Description": "m365 spo list list --webUrl https://contoso.sharepoint.com/sites/project-x --properties \"BaseTemplate,ParentWebUrl\"", + "Example": "Return all lists located in in a specific site with specific properties." }, { - "Example": "List file versions of a specific file based on the site-relative URL of the file.", - "Description": "m365 spo file version list --webUrl https://contoso.sharepoint.com --fileUrl '/Shared Documents/Document.docx'" + "Description": "m365 spo list list --webUrl https://contoso.sharepoint.com/sites/project-x --properties \"Id,Title,RootFolder/ServerRelativeUrl\"", + "Example": "Return all lists located in in a specific site with the Id, Title and ServerRelativeUrl properties." }, { - "Example": "List file versions of a specific file based on the server-relative URL of the file.", - "Description": "m365 spo file version list --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/Shared Documents/Document.docx'" + "Description": "m365 spo list list --webUrl https://contoso.sharepoint.com/sites/project-x --filter \"BaseTemplate eq 100\"", + "Example": "Return all lists located in in a specific site based on the given filter." } ] }, { - "Command": "m365 spo userprofile get", - "Description": "Get SharePoint user profile properties for the specified user", - "Options": "`-u, --userName `: Account name of the user", + "Command": "m365 spo applicationcustomizer list", + "Description": "Get a list of application customizers that are added to a site.", + "Options": "`-u, --webUrl `: The url of the site.`-s, --scope [scope]`: Scope of the application customizers. Allowed values `Site`, `Web`, `All`. Defaults to `All`", "Examples": [ { - "Example": "Get SharePoint user profile for the specified user", - "Description": "m365 spo userprofile get --userName 'john.doe@mytenant.onmicrosoft.com'" + "Description": "m365 spo applicationcustomizer list --webUrl https://contoso.sharepoint.com/sites/sales", + "Example": "Retrieves a list of application customizers." } ] }, { - "Command": "m365 spo eventreceiver get", - "Description": "Retrieves specific event receiver for the specified web, site or list by event receiver name or id.", - "Options": "`-u, --webUrl `: The URL of the web for which to retrieve the event receivers.`--listTitle [listTitle]`: The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.`--listId [listId]`: The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.`--listUrl [listUrl]`: The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.`-n, --name [name]`: The name of the event receiver to retrieve. Specify either `name` or `id` but not both.`-i, --id [id]`: The id of the event receiver to retrieve. Specify either `name` or `id` but not both.`-s, --scope [scope]`: The scope of which to retrieve the event receivers. Can be either `site` or `web`. Defaults to `web`. Only applicable when not specifying any of the list properties.", + "Command": "m365 spo term group list", + "Description": "Lists taxonomy term groups", + "Options": "`-u, --webUrl [webUrl]`: If specified, allows you to list term groups from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.", "Examples": [ { - "Example": "Retrieve an event receiver with the given name in the specified site.", - "Description": "m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'" - }, - { - "Example": "Retrieve an event receiver with the given id in the specified site.", - "Description": "m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec" - }, - { - "Example": "Retrieve an event receiver with the given name for a list with the given title in the specified site.", - "Description": "m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'" - }, - { - "Example": "Retrieve an event receiver with the given id for a list with the given ID in the specified site.", - "Description": "m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec" + "Description": "m365 spo term group list", + "Example": "List taxonomy term groups." }, { - "Example": "Retrieve an event receiver with the given name for a list with the given url in the specified site.", - "Description": "m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'" + "Description": "m365 spo term group list --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "List taxonomy term groups from the specified sitecollection." } ] }, { - "Command": "m365 spo tenant recyclebinitem list", - "Description": "Returns all modern and classic site collections in the tenant scoped recycle bin", - "Options": null, + "Command": "m365 spo site apppermission get", + "Description": "Get a specific application permissions for the site", + "Options": "`-u, --siteUrl `: URL of the site collection where the permission to retrieve is located`-i, --id `: ID of the permission to retrieve", "Examples": [ { - "Example": "Returns all modern and classic site collections in the tenant scoped recycle bin", - "Description": "m365 spo tenant recyclebinitem list" + "Description": "m365 spo site apppermission get --siteUrl https://contoso.sharepoint.com/sites/project-x --id aTowaS50fG1zLnNwLmV4dHw4OWVhNWM5NC03NzM2LTRlMjUtOTVhZC0zZmE5NWY2MmI2NmVAZGUzNDhiYzctMWFlYi00NDA2LThjYjMtOTdkYjAyMWNhZGI0", + "Example": "Return a specific application permissions for the https://contoso.sharepoint.com/sites/project-x site collection with permission id aTowaS50fG1zLnNwLmV4dHw4OWVhNWM5NC03NzM2LTRlMjUtOTVhZC0zZmE5NWY2MmI2NmVAZGUzNDhiYzctMWFlYi00NDA2LThjYjMtOTdkYjAyMWNhZGI0" } ] }, { - "Command": "m365 spo user list", - "Description": "Lists all the users within specific web", - "Options": "`-u, --webUrl `: URL of the web to list the users from", + "Command": "m365 spo web clientsidewebpart list", + "Description": "Lists available client-side web parts", + "Options": "`-u, --webUrl `: URL of the site for which to retrieve the information", "Examples": [ { - "Example": "Get list of users in a web", - "Description": "m365 spo user list --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": "m365 spo web clientsidewebpart list --webUrl https://contoso.sharepoint.com", + "Example": "Lists all the available client-side web parts for the specified site" } ] }, { - "Command": "m365 spo commandset list", - "Description": "Get a list of ListView Command Sets that are added to a site", - "Options": "`-u, --webUrl `: The url of the site.`-s, --scope [scope]`: Scope of the ListView Command Sets. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.", + "Command": "m365 spo user list", + "Description": "Lists all the users within specific web", + "Options": "`-u, --webUrl `: URL of the web to list the users from", "Examples": [ { - "Example": "Retrieves a list of ListView Command Sets.", - "Description": "m365 spo commandset list --webUrl https://contoso.sharepoint.com/sites/sales" + "Description": "m365 spo user list --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get list of users in a web" } ] }, { - "Command": "m365 spo propertybag get", - "Description": "Gets the value of the specified property from the property bag", - "Options": "`-u, --webUrl `: The URL of the site from which the property bag value should be retrieved.`-k, --key `: Key of the property for which the value should be retrieved. Case-sensitive.`--folder [folder]`: Site-relative URL of the folder from which to retrieve property bag value. Case-sensitive.", + "Command": "m365 spo group list", + "Description": "Lists all the groups within specific web", + "Options": "`-u, --webUrl `: Url of the web to list the group within`--associatedGroupsOnly`: Get only the associated visitor, member and owner groups of the site.", "Examples": [ { - "Example": "Returns the value of the property from the property bag located in the given site", - "Description": "m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1" + "Description": "`-u, --webUrl `: Url of the web to list the group within", + "Example": "Lists all the groups within a specific web" }, { - "Example": "Returns the value of the property from the property bag located in root folder of the given site", - "Description": "m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder /" + "Description": ": Get only the associated visitor, member and owner groups of the site.", + "Example": "`--associatedGroupsOnly`" }, { - "Example": "Returns the value of the property from the property bag located in document library of the given site", - "Description": "m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents'" + "Description": ": Url of the web to list the group within", + "Example": "`-u, --webUrl `" }, { - "Example": "Returns the value of the property from the property bag located in folder in a document library located in the given site", - "Description": "m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents/MyFolder'" + "Description": "`--associatedGroupsOnly`", + "Example": "" }, { - "Example": "Returns the value of the property from the property bag located in a list in the given site", - "Description": "m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder /Lists/MyList" + "Description": "m365 spo group list [options]", + "Example": ": Get only the associated visitor, member and owner groups of the site." + }, + { + "Description": "import Global from '/docs/cmd/_global.mdx';", + "Example": "Lists all the groups within specific web" + }, + { + "Description": null, + "Example": "m365 spo group list --webUrl \"https://contoso.sharepoint.com/sites/contoso\" --associatedGroupsOnly" } ] }, { - "Command": "m365 spo list view list", - "Description": "Lists views configured on the specified list", - "Options": " `-u, --webUrl `: URL of the site where the list is located. `-i, --listId [listId]`: ID of the list for which to list configured views. Specify either `listId`, `listTitle`, or `listUrl`. `-t, --listTitle [listTitle]`: Title of the list for which to list configured views. Specify either `listId`, `listTitle`, or `listUrl`. `--listUrl [listUrl]`: Server- or site-relative URL of the list. Specify either `listId` , `listTitle` or `listUrl`.", + "Command": "m365 spo orgassetslibrary list", + "Description": "List all libraries that are assigned as asset library", + "Options": null, "Examples": [ { - "Example": "List all views for a list by title.", - "Description": "m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents" - }, - { - "Example": "List all views for a list by ID.", - "Description": "m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf" - }, - { - "Example": "List all views for a list by URL.", - "Description": "m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events'" + "Description": "m365 spo orgassetslibrary list", + "Example": "List all libraries that are assigned as asset library" } ] }, { - "Command": "m365 spo tenant commandset list", - "Description": "Retrieves a list of ListView Command Sets that are installed tenant-wide", - "Options": null, + "Command": "m365 spo sitedesign task list", + "Description": "Lists site designs scheduled for execution on the specified site", + "Options": "`-u, --webUrl `: The URL of the site for which to list site designs scheduled for execution", "Examples": [ { - "Example": "Retrieves a list of ListView Command Sets.", - "Description": "m365 spo tenant commandset list" + "Description": "m365 spo sitedesign task list --webUrl https://contoso.sharepoint.com/sites/team-a", + "Example": "List site designs scheduled for execution on the specified site" } ] }, { - "Command": "m365 spo page list", - "Description": "Lists all modern pages in the given site", - "Options": "`-u, --webUrl `: URL of the site from which to retrieve available pages.", + "Command": "m365 spo file sharinglink get", + "Description": "Gets details about a specific sharing link of a file", + "Options": "`-u, --webUrl `: The URL of the site where the file is located.`--fileUrl [fileUrl]`: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.`--fileId [fileId]`: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.`-i, --id `: The ID of the sharing link.", "Examples": [ { - "Example": "List all modern pages in the specific site.", - "Description": "m365 spo page list --webUrl https://contoso.sharepoint.com/sites/team-a" + "Description": "m365 spo file sharinglink get --webUrl 'https://contoso.sharepoint.com/sites/demo' --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id 1ba739c5-e693-4c16-9dfa-042e4ec62972", + "Example": "Gets a specific sharing link of a file by id." + }, + { + "Description": "m365 spo file sharinglink get --webUrl 'https://contoso.sharepoint.com/sites/demo' --fileUrl 'Shared Documents/document.docx' --id 1ba739c5-e693-4c16-9dfa-042e4ec62972", + "Example": "Gets a specific sharing link of a file by a specified site-relative URL." + }, + { + "Description": "m365 spo file sharinglink get --webUrl 'https://contoso.sharepoint.com/sites/demo' --fileUrl '/sites/demo/Shared Documents/document.docx' --id 1ba739c5-e693-4c16-9dfa-042e4ec62972", + "Example": "Gets a specific sharing link of a file by a specified server-relative URL." } ] }, { - "Command": "m365 spo roledefinition list", - "Description": "Gets list of role definitions for the specified site", - "Options": "`-u, --webUrl `: URL of the site for which to retrieve role definitions.", + "Command": "m365 spo contenttypehub get", + "Description": "Returns the URL of the SharePoint Content Type Hub of the Tenant", + "Options": null, "Examples": [ { - "Example": "Return list of role definitions for the given site", - "Description": "m365 spo roledefinition list --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": "m365 spo contenttypehub get [options]", + "Example": "Retrieve the Content Type Hub URL" + }, + { + "Description": "import Global from '/docs/cmd/_global.mdx';", + "Example": "Returns the URL of the SharePoint Content Type Hub of the Tenant" + }, + { + "Description": null, + "Example": "m365 spo contenttypehub get" } ] }, { - "Command": "m365 spo page column list", - "Description": "Lists columns in the specific section of a modern page", - "Options": "`-u, --webUrl `: URL of the site where the page to retrieve is located.`-n, --pageName `: Name of the page to list columns of.`-s, --section `: ID of the section for which to list columns.", + "Command": "m365 spo serviceprincipal permissionrequest list", + "Description": "Lists pending permission requests", + "Options": "m365 spo sp permissionrequest list", "Examples": [ { - "Example": "List columns in the first section of a modern page", - "Description": "m365 spo page column list --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1" + "Description": null, + "Example": "The admin role that's required to list permissions depends on the API. To approve permissions to any of the third-party APIs registered in the tenant, the application administrator role is sufficient. To approve permissions for Microsoft Graph or any other Microsoft API, the Global Administrator role is required." } ] }, { - "Command": "m365 spo folder list", - "Description": "Returns all folders under the specified parent folder", - "Options": "`-u, --webUrl `: The URL of the site where the folders to list are located.`-p, --parentFolderUrl `: The server- or site-relative decoded URL of the parent folder.`--fields [fields]`: Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested.`--filter [filter]`: OData filter to use to query the list of folders with.`-r, --recursive`: Set to retrieve nested folders.", + "Command": "m365 spo applicationcustomizer get", + "Description": "Get an application customizer that is added to a site.", + "Options": "`-u, --webUrl `: URL of the site.`-t, --title [title]`: The title of the Application Customizer. Specify either `title`, `id`, or `clientSideComponentId`.`-i, --id [id]`: The id of the Application Customizer. Specify either `title`, `id`, or `clientSideComponentId`.`-c, --clientSideComponentId [clientSideComponentId]`: The Client Side Component Id (GUID) of the application customizer. Specify either `title`, `id`, or `clientSideComponentId`.`-s, --scope [scope]`: Scope of the application customizer. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.", "Examples": [ { - "Example": "Gets list of folders under a parent folder with site-relative URL.", - "Description": "m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'" + "Description": "m365 spo applicationcustomizer get --title \"Some customizer\" --webUrl https://contoso.sharepoint.com/sites/sales", + "Example": "Retrieves an application customizer by title." + }, + { + "Description": "m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales", + "Example": "Retrieves an application customizer by id." }, { - "Example": "Gets recursive list of folders under a specific folder on a specific site.", - "Description": "m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/sites/project-x/Shared Documents' --recursive" + "Description": "m365 spo applicationcustomizer get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales", + "Example": "Retrieves an application customizer by clientSideComponentId." }, { - "Example": "Return a filtered list of folders and only return the list item ID.", - "Description": "m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --fields ListItemAllFields/Id --filter \"startswith(Name,'Folder')\"" + "Description": "m365 spo applicationcustomizer get --title \"Some customizer\" --webUrl https://contoso.sharepoint.com/sites/sales --scope site", + "Example": "Retrieves an application customizer by title available at the site scope." } ] }, @@ -806,1145 +933,1355 @@ export const Commands = [ "Options": "`-u, --webUrl `: Absolute URL of the site.`--id `: Id of the navigation node.", "Examples": [ { - "Example": "Retrieve information for a specific navigation node.", - "Description": "m365 spo navigation node get --webUrl https://contoso.sharepoint.com/sites/team-a --id 2209" + "Description": "m365 spo navigation node get --webUrl https://contoso.sharepoint.com/sites/team-a --id 2209", + "Example": "Retrieve information for a specific navigation node." } ] }, { - "Command": "m365 spo applicationcustomizer list", - "Description": "Get a list of application customizers that are added to a site", - "Options": "`-u, --webUrl `: The url of the site.`-s, --scope [scope]`: Scope of the application customizers. Allowed values `Site`, `Web`, `All`. Defaults to `All`.", + "Command": "m365 spo hidedefaultthemes get", + "Description": "Gets the current value of the HideDefaultThemes setting", + "Options": null, "Examples": [ { - "Example": "Retrieves a list of application customizers.", - "Description": "m365 spo applicationcustomizer list --webUrl https://contoso.sharepoint.com/sites/sales" + "Description": "m365 spo hidedefaultthemes get", + "Example": "Get the current value of the HideDefaultThemes setting" } ] }, { - "Command": "m365 spo page column get", - "Description": "Get information about a specific column of a modern page", - "Options": "`-u, --webUrl `: URL of the site where the page to retrieve is located.`-n, --pageName `: Name of the page to get column information of.`-s, --section
`: ID of the section where the column is located.`-c, --column `: ID of the column for which to retrieve more information.", + "Command": "m365 spo serviceprincipal grant list", + "Description": "Lists permissions granted to the service principal", + "Options": "m365 spo sp grant list", "Examples": [ { - "Example": "Get information about the first column in the first section of a modern page", - "Description": "m365 spo page column get --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1 --column 1" + "Description": null, + "Example": "To use this command you must be a Global administrator." } ] }, { - "Command": "m365 spo web get", - "Description": "Retrieve information about the specified site", - "Options": "`-u, --url `: URL of the site for which to retrieve the information`--withGroups`: Set if you want to return associated groups (associatedOwnerGroup, associatedMemberGroup and associatedVisitorGroup) along with other properties`--withPermissions`: Set if you want to return associated roles and permissions", + "Command": "m365 spo file sharinglink list", + "Description": "Lists all the sharing links of a specific file", + "Options": "`-u, --webUrl `: The URL of the site where the file is located.`--fileUrl [fileUrl]`: The server- or site-relative decoded URL of the file. Specify either `fileUrl` or `fileId` but not both.`--fileId [fileId]`: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.`-s, --scope [scope]`: Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.", "Examples": [ { - "Example": "Retrieve information about a site", - "Description": "m365 spo web get --url https://contoso.sharepoint.com/subsite" + "Description": "m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234", + "Example": "List sharing links of a file by id" }, { - "Example": "Retrieve information about a site along with associated groups for the web", - "Description": "m365 spo web get --url https://contoso.sharepoint.com/subsite --withGroups" + "Description": "m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl \"/sites/demo/shared documents/document.docx\"", + "Example": "List sharing links of a file by url" }, { - "Example": "Retrieve information about a site along with the RoleAssignments for the web", - "Description": "m365 spo web get --url https://contoso.sharepoint.com/subsite --withPermissions" + "Description": "m365 spo file sharinglink list --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl \"/sites/demo/shared documents/document.docx\" --scope anonymous", + "Example": "List anonymous sharing links of a file by url" } ] }, { - "Command": "m365 spo field list", - "Description": "Retrieves columns for the specified list or site", - "Options": "`-u, --webUrl `: Absolute URL of the site where fields are located.`-t, --listTitle [listTitle]`: Title of the list where fields are located. Specify either `listTitle`, `listId` or `listUrl`.`-i --listId [listId]`: ID of the list where fields are located. Specify either `listTitle`, `listId` or `listUrl`.`--listUrl [listUrl]`: Server- or web-relative URL of the list where fields are located. Specify either `listTitle`, `listId` or `listUrl`.", + "Command": "m365 spo hubsite data get", + "Description": "Get hub site data for the specified site", + "Options": "`-u, --webUrl `: URL of the site for which to retrieve hub site data.`--forceRefresh`: Set, to refresh the server cache with the latest updates.", "Examples": [ { - "Example": "Retrieves site columns for the specified site.", - "Description": "m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales" - }, - { - "Example": "Retrieves list columns for list Events in the specified site.", - "Description": "m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events" - }, + "Description": "m365 spo hubsite data get --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get information about the hub site data for a specific site with URL." + } + ] + }, + { + "Command": "m365 spo listitem attachment get", + "Description": "Gets an attachment from a list item", + "Options": "`-u, --webUrl `: URL of the site where the list item is located.`--listId [listId]`: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.`--listTitle [listTitle]`: Title of the list. Specify either `listTitle`, `listId` or `listUrl`.`--listUrl [listUrl]`: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.`--listItemId `: The ID of the list item.`-n, --fileName `: Name of the file to get.", + "Examples": [ { - "Example": "Retrieves list columns for the specified list in the specified site.", - "Description": "m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'" + "Description": "m365 spo listitem attachment get --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle \"Demo List\" --listItemId 147 --fileName \"File1.jpg\"", + "Example": "Get an attachment from a list item by using list title." }, { - "Example": "m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'", - "Description": null + "Description": "m365 spo listitem attachment get --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl \"/sites/project-x/Lists/DemoList\" --listItemId 147 --fileName \"File1.jpg\"", + "Example": "Get an attachment from a list item by using list URL." } ] }, { - "Command": "m365 spo list webhook list", - "Description": "Lists all webhooks for the specified list", - "Options": "`-u, --webUrl `: URL of the site where the list is located.`-i, --listId [listId]`: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.`-t, --listTitle [listTitle]`: Title of the list. Specify either `listTitle`, `listId` or `listUrl`.`--listUrl [listUrl]`: Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`.", + "Command": "m365 spo hubsite list", + "Description": "Lists hub sites in the current tenant", + "Options": "`-i, --includeAssociatedSites`: Include the associated sites in the result (only in JSON output).", "Examples": [ { - "Example": "List all webhooks for a list with a specific ID in a specific site", - "Description": "m365 spo list webhook list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf" - }, - { - "Example": "List all webhooks for a list with a specific title in a specific site", - "Description": "m365 spo list webhook list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents" + "Description": "m365 spo hubsite list", + "Example": "List hub sites in the current tenant" }, { - "Example": "List all webhooks for a list with a specific URL in a specific site", - "Description": "m365 spo list webhook list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Documents'" + "Description": "m365 spo hubsite list --includeAssociatedSites --output json", + "Example": "List hub sites, including their associated sites, in the current tenant. Associated site info is only shown in JSON output." } ] }, { - "Command": "m365 spo hubsite data get", - "Description": "Get hub site data for the specified site", - "Options": "`-u, --webUrl `: URL of the site for which to retrieve hub site data.`--forceRefresh`: Set, to refresh the server cache with the latest updates.", + "Command": "m365 spo page column get", + "Description": "Get information about a specific column of a modern page", + "Options": "`-u, --webUrl `: URL of the site where the page to retrieve is located.`-n, --pageName `: Name of the page to get column information of.`-s, --section
`: ID of the section where the column is located.`-c, --column `: ID of the column for which to retrieve more information.", "Examples": [ { - "Example": "Get information about the hub site data for a specific site with URL.", - "Description": "m365 spo hubsite data get --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": "m365 spo page column get --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1 --column 1", + "Example": "Get information about the first column in the first section of a modern page" } ] }, { - "Command": "m365 spo site get", - "Description": "Gets information about the specific site collection", - "Options": "`-u, --url `: URL of the site collection to retrieve information for", + "Command": "m365 spo userprofile get", + "Description": "Get SharePoint user profile properties for the specified user", + "Options": "`-u, --userName `: Account name of the user", "Examples": [ { - "Example": "Return information about the https://contoso.sharepoint.com/sites/project-x site collection.", - "Description": "m365 spo site get -u https://contoso.sharepoint.com/sites/project-x" + "Description": "m365 spo userprofile get --userName 'john.doe@mytenant.onmicrosoft.com'", + "Example": "Get SharePoint user profile for the specified user" } ] }, { - "Command": "m365 spo folder sharinglink get", - "Description": "Gets details about a specific sharing link on a folder", - "Options": "`-u, --webUrl `: The URL of the site where the folder is located.`--folderUrl [folderUrl]`: The server- or site-relative decoded URL of the folder. Specify either `folderUrl` or `folderId` but not both.`--folderId [folderId]`: The Unique ID (GUID) of the folder. Specify either `folderUrl` or `folderId` but not both.`-i, --id `: The sharing link ID.", + "Command": "m365 spo page list", + "Description": "Lists all modern pages in the given site", + "Options": "`-u, --webUrl `: URL of the site from which to retrieve available pages.", "Examples": [ { - "Example": "Gets a specific sharing link of a folder by id.", - "Description": "m365 spo folder sharinglink get --webUrl https://contoso.sharepoint.com/sites/demo --id 45fa6aed-362f-48b1-b04e-6da85a526506 --folderId daebb04b-a773-4baa-b1d1-3625418e3234" - }, - { - "Example": "Gets a specific sharing link of a folder by url.", - "Description": "m365 spo folder sharinglink get --webUrl https://contoso.sharepoint.com/sites/demo --id 45fa6aed-362f-48b1-b04e-6da85a526506 --folderUrl \"/sites/demo/shared documents/folder\"" + "Description": "m365 spo page list --webUrl https://contoso.sharepoint.com/sites/team-a", + "Example": "List all modern pages in the specific site" } ] }, { - "Command": "m365 spo web installedlanguage list", - "Description": "Lists all installed languages on site", - "Options": "`-u, --webUrl `: URL of the site for which to retrieve the list of installed languages", + "Command": "m365 spo tenant appcatalogurl get", + "Description": "Gets the URL of the tenant app catalog", + "Options": null, "Examples": [ { - "Example": "Return all installed languages from site https://contoso.sharepoint.com/", - "Description": "m365 spo web installedlanguage list --webUrl https://contoso.sharepoint.com" + "Description": "m365 spo tenant appcatalogurl get", + "Example": "Get the URL of the tenant app catalog" } ] }, { - "Command": "m365 spo term group get", - "Description": "Gets information about the specified taxonomy term group", - "Options": "`-u, --webUrl [webUrl]`: If specified, allows you to get a term group from the tenant term store as well as the sitecollection specific term store. Defaults to the tenant admin site.`-i, --id [id]`: ID of the term group to retrieve. Specify `name` or `id` but not both.`-n, --name [name]`: Name of the term group to retrieve. Specify `name` or `id` but not both.", + "Command": "m365 spo sitedesign get", + "Description": "Gets information about the specified site design", + "Options": "`-i, --id [id]`: Site design ID. Specify either `id` or `title` but not both.`--title [title]`: Site design title. Specify either `id` or `title` but not both.", "Examples": [ { - "Example": "Get information about a taxonomy term group using its ID.", - "Description": "m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb" + "Description": "m365 spo sitedesign get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a", + "Example": "Get information about the site design with ID 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a" }, { - "Example": "Get information about a taxonomy term group using its name.", - "Description": "m365 spo term group get --name PnPTermSets" - }, - { - "Example": "Get information about a taxonomy term group from the specified sitecollection using its ID.", - "Description": "m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --webUrl https://contoso.sharepoint.com/sites/project-x" + "Description": "m365 spo sitedesign get --title \"Contoso Site Design\"", + "Example": "Get information about the site design with title Contoso Site Design" } ] }, { - "Command": "m365 spo user get", - "Description": "Gets a site user within specific web", - "Options": "`-u, --webUrl `: URL of the web to get the user within.`-i, --id [id]`: ID of the user to retrieve information for. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.`--email [email]`: Email of the user to retrieve information for. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.`--loginName [loginName]`: Login name of the user to retrieve information for. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.`--userName [userName]`: User's UPN (user principal name, eg. megan.bowen@contoso.com). Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.`--entraGroupId [entraGroupId]`: The object ID of the Microsoft Entra group. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.`--entraGroupName [entraGroupName]`: The name of the Microsoft Entra group. Specify either `id`, `loginName`, `email`, `userName`, `entraGroupId`, or `entraGroupName`.", + "Command": "m365 spo eventreceiver list", + "Description": "Retrieves event receivers for the specified web, site or list.", + "Options": "`-u, --webUrl `: The URL of the web for which to retrieve the event receivers.`--listTitle [listTitle]`: The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.`--listId [listId]`: The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.`--listUrl [listUrl]`: The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.`-s, --scope [scope]`: The scope of which to retrieve the Event Receivers. Can be either \"site\" or \"web\". Defaults to \"web\". Only applicable when not specifying any of the list properties.", "Examples": [ { - "Example": "Get user by email for a web.", - "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --email john.doe@mytenant.onmicrosoft.com" + "Description": "`-u, --webUrl `", + "Example": "Retrieves event receivers in web https://contoso.sharepoint.com/sites/contoso-sales." }, { - "Example": "Get user by ID for a web.", - "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --id 6" + "Description": "`--listTitle [listTitle]`", + "Example": ": The URL of the web for which to retrieve the event receivers." }, { - "Example": "Get user by login name for a web.", - "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --loginName \"i:0#.f|membership|john.doe@mytenant.onmicrosoft.com\"" + "Description": "`--listId [listId]`", + "Example": ": The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`." }, { - "Example": "Get user by user's UPN for a web.", - "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --userName \"john.doe@mytenant.onmicrosoft.com\"" + "Description": "`--listUrl [listUrl]`", + "Example": ": The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`." }, { - "Example": "Get user by entraGroupId for a web.", - "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --entraGroupId f832a493-de73-4fef-87ed-8c6fffd91be6" + "Description": "`-s, --scope [scope]`", + "Example": ": The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`." }, { - "Example": "Get user by entraGroupName for a web.", - "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --entraGroupName \"Test Members\"" + "Description": "`-u, --webUrl `", + "Example": ": The scope of which to retrieve the Event Receivers. Can be either \"site\" or \"web\". Defaults to \"web\". Only applicable when not specifying any of the list properties." }, { - "Example": "Get the currently logged-in user.", - "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x" - } - ] - }, - { - "Command": "m365 spo cdn get", - "Description": "View current status of the specified Microsoft 365 CDN", - "Options": "`-t, --type [type]`: Type of CDN to manage. Allowed values are: `Public`, `Private`. Default `Public`.", - "Examples": [ + "Description": "", + "Example": ": The URL of the web for which to retrieve the event receivers." + }, { - "Example": "Show if the Public CDN is currently enabled or not.", - "Description": "m365 spo cdn get" + "Description": ": The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.", + "Example": "`--listTitle [listTitle]`" }, { - "Example": "Show if the Private CDN is currently enabled or not.", - "Description": "m365 spo cdn get --type Private" - } - ] - }, - { - "Command": "m365 spo group list", - "Description": "Lists all the groups within specific web", - "Options": "`-u, --webUrl `: Url of the web to list the group within.`--associatedGroupsOnly`: Get only the associated visitor, member and owner groups of the site.", - "Examples": [ + "Description": "`--listId [listId]`", + "Example": "" + }, { - "Example": "Lists all the groups within a specific web.", - "Description": "m365 spo group list --webUrl \"https://contoso.sharepoint.com/sites/contoso\"" + "Description": "", + "Example": ": The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`." }, { - "Example": "Lists the associated groups within a specific web.", - "Description": "m365 spo group list --webUrl \"https://contoso.sharepoint.com/sites/contoso\" --associatedGroupsOnly" - } - ] - }, - { - "Command": "m365 spo file version get", - "Description": "Gets information about a specific version of a specified file", - "Options": "`-u, --webUrl `: The URL of the site where the file is located.`--label