diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json index 8e3d475..b899f20 100644 --- a/npm-shrinkwrap.json +++ b/npm-shrinkwrap.json @@ -1,12 +1,12 @@ { "name": "viva-connections-toolkit", - "version": "4.3.0", + "version": "4.3.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "viva-connections-toolkit", - "version": "4.3.0", + "version": "4.3.1", "license": "MIT", "dependencies": { "@pnp/cli-microsoft365": "6.11.0", diff --git a/package.json b/package.json index e5f5aa6..278f1f2 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "viva-connections-toolkit", "displayName": "SharePoint Framework Toolkit", "description": "SharePoint Framework Toolkit aims to boost your productivity in developing and managing SharePoint Framework solutions helping at every stage of your development flow, from setting up your development workspace to deploying a solution straight to your tenant without the need to leave VS Code and now even create a CI/CD pipeline to introduce automate deployment of your app. This toolkit is provided by the community.", - "version": "4.3.0", + "version": "4.3.1", "publisher": "m365pnp", "preview": false, "homepage": "https://github.com/pnp/vscode-viva", @@ -466,6 +466,11 @@ "category": "SharePoint Framework Toolkit", "icon": "$(sync)" }, + { + "command": "spfx-toolkit.setFormCustomizer", + "title": "Set Form Customizer", + "category": "SharePoint Framework Toolkit" + }, { "command": "spfx-toolkit.showMoreActions", "title": "...", diff --git a/scripts/cli-for-microsoft365-create-grounding-data.ps1 b/scripts/cli-for-microsoft365-create-grounding-data.ps1 index af3ebe6..b2d00b9 100644 --- a/scripts/cli-for-microsoft365-create-grounding-data.ps1 +++ b/scripts/cli-for-microsoft365-create-grounding-data.ps1 @@ -9,8 +9,10 @@ if (-not (Test-Path -Path $cliLocalProjectPath -PathType Container)) { [hashtable]$commandsData = @{} $allSpoCommands = Get-ChildItem -Path "$workspacePath\cli-microsoft365\docs\docs\cmd\spo\*.mdx" -Recurse -Force -Exclude "_global*" +$allTeamsCommands = Get-ChildItem -Path "$workspacePath\cli-microsoft365\docs\docs\cmd\teams\*.mdx" -Recurse -Force -Exclude "_global*" +$allCommands = $allSpoCommands + $allTeamsCommands -foreach ($command in $allSpoCommands) { +foreach ($command in $allCommands) { $commandDocs = ConvertFrom-Markdown -Path $command $html = New-Object -Com 'HTMLFile' $html.write([ref]$commandDocs.Html) diff --git a/src/chat/CliForMicrosoft365SpoCommands.ts b/src/chat/CliForMicrosoft365SpoCommands.ts index 202f07f..ff9cdf4 100644 --- a/src/chat/CliForMicrosoft365SpoCommands.ts +++ b/src/chat/CliForMicrosoft365SpoCommands.ts @@ -2,134 +2,241 @@ export const Commands = [ { - "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.", + "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", "Examples": [ { - "Description": "m365 spo page template list --webUrl https://contoso.sharepoint.com/sites/team-a", - "Example": "Lists all page templates in the given site" + "Description": "m365 spo file version list --webUrl https://contoso.sharepoint.com --fileId 'b2307a39-e878-458b-bc90-03bc578531d6'", + "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 --fileUrl '/Shared Documents/Document.docx'", + "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/sites/project-x --fileUrl '/sites/project-x/Shared Documents/Document.docx'", + "Example": "List file versions of a specific file based on the server-relative URL of the file" } ] }, { - "Command": "m365 spo homesite get", - "Description": "Gets information about the Home Site", - "Options": null, + "Command": "m365 teams guestsettings list", + "Description": "Lists guest settings for a Microsoft Teams team", + "Options": "`-i, --teamId`: The ID of the team for which to get the guest settings", "Examples": [ { - "Description": "m365 spo homesite get", - "Example": "Get information about the Home Site." + "Description": "m365 teams guestsettings list --teamId 2609af39-7775-4f94-a3dc-0dd67657e900", + "Example": "Get guest settings for a Microsoft Teams team" } ] }, { - "Command": "m365 spo theme list", - "Description": "Retrieves the list of custom themes", - "Options": null, + "Command": "m365 teams channel member list", + "Description": "Lists members of the specified Microsoft Teams team channel", + "Options": "`-i, --teamId [teamId]`: The Id of the Microsoft Teams team. Specify either `teamId` or `teamName` but not both`--teamName [teamName]`: The display name of the Microsoft Teams team. Specify either `teamId` or `teamName` but not both`-c, --channelId [channelId]`: The Id of the Microsoft Teams team channel. Specify either `channelId` or `channelName` but not both`--channelName [channelName]`: The display name of the Microsoft Teams team channel. Specify either `channelId` or `channelName` but not both`-r, --role [role]`: Filter the results to only users with the given role: owner, member, guest", "Examples": [ { - "Description": "m365 spo theme list", - "Example": "List available themes" + "Description": "m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype", + "Example": "List the members of a specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype" + }, + { + "Description": "m365 teams channel member list --teamName \"Team Name\" --channelName \"Channel Name\"", + "Example": "List the members of a specified Microsoft Teams team with name Team Name and channel with name Channel Name" + }, + { + "Description": "m365 teams channel member list --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --role owner", + "Example": "List all owners of the specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000 and channel id 19:00000000000000000000000000000000@thread.skype" } ] }, { - "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", + "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": [ { - "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": "m365 spo web get --url https://contoso.sharepoint.com/subsite", + "Example": "Retrieve information about a site" }, { - "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]`" + "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" }, { - "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]`" + "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 site apppermission list", + "Description": "Lists application permissions for a site", + "Options": "`-u, --siteUrl `: URL of the site collection to retrieve information for`-i, --appId [appId]`: Id of the application to filter by`-n, --appDisplayName [appDisplayName]`: Display name of the application to filter by", + "Examples": [ + { + "Description": "m365 spo site apppermission list --siteUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Return list of application permissions for the https://contoso.sharepoint.com/sites/project-x site collection." }, { - "Description": ": The URL of the site where the file is located", - "Example": "`-u, --webUrl `" + "Description": "m365 spo site apppermission list --siteUrl https://contoso.sharepoint.com/sites/project-x --appDisplayName Foo", + "Example": "Return list of application permissions for the https://contoso.sharepoint.com/sites/project-x site collection and filter by an application called Foo" + } + ] + }, + { + "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": [ + { + "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": "`--fileUrl [fileUrl]`", - "Example": "" + "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --id 6", + "Example": "Get user by ID for a web" }, { - "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" + "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" }, { - "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]`" + "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get the currently logged-in user" + } + ] + }, + { + "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": [ + { + "Description": "m365 spo list list --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Return all lists located in in a specific site." }, { - "Description": "Generates a sharing information report for the specified file", - "Example": "m365 spo file sharinginfo get [options]" + "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." }, { - "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';" + "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." + }, + { + "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 get", - "Description": "Gets the context URL for the root SharePoint site collection and SharePoint tenant admin site", - "Options": null, + "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": "m365 spo get --output json", - "Example": "Get the context URL for the root SharePoint site collection and SharePoint tenant admin site" + "Description": "m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test", + "Example": "Return property bag values located in the given site" + }, + { + "Description": "m365 spo propertybag list --webUrl https://contoso.sharepoint.com/sites/test --folder /", + "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 '/Shared Documents'", + "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/MyFolder'", + "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 /Lists/MyList", + "Example": "Return property bag values located in the given site list" } ] }, { - "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`", + "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": [ { - "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" + "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." + }, + { + "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." + }, + { + "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." + }, + { + "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." + }, + { + "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 app instance list", - "Description": "Retrieve apps installed in a site", - "Options": "`-u, --siteUrl `: URL of the site collection to retrieve the apps for", + "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`.", "Examples": [ { - "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": "m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle Documents", + "Example": "List all views for a list by title" }, { - "Description": ": URL of the site collection to retrieve the apps for", - "Example": "`-u, --siteUrl `" + "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 ID" }, { - "Description": "Retrieve apps installed in a site", - "Example": "m365 spo app instance list [options]" - }, + "Description": "m365 spo list view list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/lists/Events'", + "Example": "List all views for a list by URL" + } + ] + }, + { + "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 app instance list --siteUrl https://contoso.sharepoint.com/sites/site1", - "Example": "import Global from '/docs/cmd/_global.mdx';" + "Description": "m365 spo storageentity get -k AnalyticsId", + "Example": "Show the value, description and comment of the AnalyticsId tenant property" } ] }, { - "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 sitescript get", + "Description": "Gets information about the specified site script", + "Options": "`-i, --id `: Site script ID", "Examples": [ { - "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" + "Description": "m365 spo sitescript get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a", + "Example": "Get information about the site script with ID 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a" + } + ] + }, + { + "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`", + "Examples": [ + { + "Description": "m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/team-a --location TopNavigationBar", + "Example": "Retrieve nodes from the top navigation" + }, + { + "Description": "m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/team-a --location QuickLaunch", + "Example": "Retrieve nodes from the quick launch" } ] }, @@ -149,814 +256,1077 @@ export const Commands = [ ] }, { - "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 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": [ { - "Description": "m365 spo web list --url https://contoso.sharepoint.com", - "Example": "Return all subsites from site https://contoso.sharepoint.com/" + "Description": "m365 spo hubsite list", + "Example": "List hub sites in the current tenant" + }, + { + "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 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.", + "Command": "m365 teams message list", + "Description": "Lists all messages from a channel in a Microsoft Teams team", + "Options": "`-i, --teamId `: The ID of the team where the channel is located.`-c, --channelId `: The ID of the channel for which to list messages.`-s, --since [since]`: Date (ISO standard, dash separator) to get delta of messages from (in last 8 months).", "Examples": [ { - "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." - }, - { - "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." + "Description": "m365 teams message list --teamId fce9e580-8bba-4638-ab5c-ab40016651e3 --channelId 19:eb30973b42a847a2a1df92d91e37c76a@thread.skype", + "Example": "List the messages from a channel of the Microsoft Teams team." }, { - "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": "--since", + "Example": "List the messages from a channel of the Microsoft Teams team that have been created or modified since the date specified by the --since parameter (WARNING: only captures the last 8 months of data)." }, { - "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." + "Description": null, + "Example": "m365 teams message list --teamId fce9e580-8bba-4638-ab5c-ab40016651e3 --channelId 19:eb30973b42a847a2a1df92d91e37c76a@thread.skype --since 2019-12-31T14:00:00Z" } ] }, { - "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`", + "Command": "m365 teams message reply list", + "Description": "Retrieves replies to a message from a channel in a Microsoft Teams team", + "Options": "`-i, --teamId `: The ID of the team where the channel is located.`-c, --channelId `: The ID of the channel that contains the message.`-m, --messageId `: The ID of the message to retrieve replies for.", "Examples": [ { - "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." + "Description": "m365 teams message reply list --teamId 5f5d7b71-1161-44d8-bcc1-3da710eb4171 --channelId 19:88f7e66a8dfe42be92db19505ae912a8@thread.skype --messageId 1540747442203", + "Example": "Retrieve the replies from a specified message from a channel of the Microsoft Teams team." } ] }, { - "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", + "Command": "m365 spo contenttypehub get", + "Description": "Returns the URL of the SharePoint Content Type Hub of the Tenant", + "Options": null, "Examples": [ { - "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`." + "Description": "m365 spo contenttypehub get [options]", + "Example": "Retrieve the Content Type Hub URL" }, { - "Description": ": ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.", - "Example": "`--listId [listId]`" + "Description": "import Global from '/docs/cmd/_global.mdx';", + "Example": "Returns the URL of the SharePoint Content Type Hub of the Tenant" }, { - "Description": "`--listUrl [listUrl]`", - "Example": "" - }, + "Description": null, + "Example": "m365 spo contenttypehub get" + } + ] + }, + { + "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": [ { - "Description": "", - "Example": ": Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`." - }, + "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 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", + "Examples": [ { - "Description": ": The ID of the content type to retrieve. Specify either id or name but not both", - "Example": "`-i, --id [id]`" - }, + "Description": "m365 spo sitedesign task get --id 6ec3ca5b-d04b-4381-b169-61378556d76e", + "Example": "Get information about the specified site design scheduled for execution" + } + ] + }, + { + "Command": "m365 teams app list", + "Description": "Lists apps from the Microsoft Teams app catalog", + "Options": "`--distributionMethod [distributionMethod]`: The distribution method. Allowed values `store`, `organization`, `sideloaded`.", + "Examples": [ { - "Description": "`-n, --name [name]`", - "Example": "" + "Description": "m365 teams app list", + "Example": "List all apps from the Microsoft Teams app catalog" }, { - "Description": "m365 spo contenttype get [options]", - "Example": ": The name of the content type to retrieve. Specify either id or name but not both" - }, + "Description": "m365 teams app list --distributionMethod 'store'", + "Example": "List all apps from the Microsoft Teams app catalog according to a given distribution method" + } + ] + }, + { + "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": "import Global from '/docs/cmd/_global.mdx';", - "Example": "Retrieves information about the specified list or site content type" + "Description": "m365 spo term group list", + "Example": "List taxonomy term groups." }, { - "Description": null, - "Example": "m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --id 0x0100558D85B7216F6A489A499DB361E1AE2F" + "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 storageentity list", - "Description": "Lists tenant properties stored on the specified SharePoint Online app catalog", - "Options": "`-u, --appCatalogUrl `: URL of the app catalog site", + "Command": "m365 spo knowledgehub get", + "Description": "Gets the Knowledge Hub Site URL for your tenant", + "Options": null, "Examples": [ { - "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" + "Description": "m365 spo knowledgehub get", + "Example": "Gets the Knowledge Hub Site URL for your tenant." } ] }, { - "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 teams tab list", + "Description": "Lists tabs in the specified Microsoft Teams channel", + "Options": "`-i, --teamId `: The ID of the Microsoft Teams team where the channel is located`-c, --channelId `: The ID of the channel for which to list tabs", "Examples": [ { - "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." + "Description": "m365 teams tab list --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype", + "Example": "List all tabs in a Microsoft Teams channel" + }, + { + "Description": "m365 teams tab list --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --output json", + "Example": "Include all the values from the tab configuration and associated teams app" } ] }, { - "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 user list", + "Description": "Lists all the users within specific web", + "Options": "`-u, --webUrl `: URL of the web to list the users from", "Examples": [ { - "Description": "m365 spo web installedlanguage list --webUrl https://contoso.sharepoint.com", - "Example": "Return all installed languages from site https://contoso.sharepoint.com/" + "Description": "m365 spo user list --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get list of users in a web" } ] }, { - "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`", + "Command": "m365 spo listitem list", + "Description": "Gets a list of items from the specified list", + "Options": "`-u, --webUrl `: URL of the site from which the item should be retrieved.`-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.`-q, --camlQuery [camlQuery]`: CAML query to use to query the list of items with.`--fields [fields]`: Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested. Specify `camlQuery` or `fields` but not both.`-l, --filter [filter]`: OData filter to use to query the list of items with. Specify `camlQuery` or `filter` but not both.`-s, --pageSize [pageSize]`: Number of list items to return. Specify `camlQuery` or `pageSize` but not both. The default value is 5000.`-n, --pageNumber [pageNumber]`: Page number to return if `pageSize` is specified (first page is indexed as value of 0).", "Examples": [ { - "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": "m365 spo listitem list --listTitle \"Demo List\" --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get all items from a list named Demo List" }, { - "Description": ": Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`", - "Example": "`--listUrl [listUrl]`" + "Description": "m365 spo listitem list --listId 935c13a0-cc53-4103-8b48-c1d0828eaa7f --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get all items from a list with ID 935c13a0-cc53-4103-8b48-c1d0828eaa7f" }, { - "Description": ": Absolute URL of the site where fields are located", - "Example": "`-u, --webUrl `" + "Description": "m365 spo listitem list --listTitle \"Demo List\" --webUrl https://contoso.sharepoint.com/sites/project-x --fields \"ID,Title,Modified\"", + "Example": "Get all items from list named Demo List. For each item, retrieve the value of the ID, Title and Modified fields" }, { - "Description": "`-t, --listTitle [listTitle]`", - "Example": "" + "Description": "m365 spo listitem list --listTitle \"Demo List\" --webUrl https://contoso.sharepoint.com/sites/project-x --fields \"ID,Title,Modified,Company/Title\"", + "Example": "Get all items from list named Demo List. For each item, retrieve the value of the ID, Title, Modified fields, and the value of lookup field Company" }, { - "Description": "", - "Example": ": Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`" + "Description": "m365 spo listitem list --listTitle \"Demo List\" --webUrl https://contoso.sharepoint.com/sites/project-x --filter \"Title eq 'Demo list item'\"", + "Example": "From a list named Demo List get all items with title Demo list item using an OData filter" }, { - "Description": ": ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`", - "Example": "`-i --listId [listId]`" + "Description": "m365 spo listitem list --listTitle \"Demo List\" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 100 --pageNumber 0", + "Example": "From a list named Demo List get the first 100 items" }, { - "Description": "`--listUrl [listUrl]`", - "Example": "" + "Description": "m365 spo listitem list --listTitle \"Demo List\" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 1", + "Example": "From a list named Demo List get the second batch of 10 items" }, { - "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": "m365 spo listitem list --listUrl /sites/project-x/documents --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get all items from a list by server-relative URL" }, { - "Description": "import Global from '/docs/cmd/_global.mdx';", - "Example": "Retrieves columns for the specified list or site" + "Description": "m365 spo listitem list --listTitle \"Demo List\" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery \"Demo list item5000\"", + "Example": "From a list named Demo List get all items with title Demo list item using a CAML query" }, { - "Description": null, - "Example": "m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'" + "Description": "m365 spo listitem list --listTitle \"Demo List\" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery \"5000\"", + "Example": "From a library named Demo Library with 5000+ files and folders, get all items recursively without running into a list view threshold exception, using a CAML query" } ] }, { - "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.", + "Command": "m365 teams channel get", + "Description": "Gets information about the specific Microsoft Teams team channel", + "Options": "`--teamId [teamId]`: The ID of the team to which the channel belongs to. Specify either `teamId` or `teamName` but not both.`--teamName [teamName]`: The display name of the team to which the channel belongs to. Specify either `teamId` or `teamName` but not both.`-i, --id [id]`: The ID of the channel for which to retrieve more information. Specify either `id` or `name` but not both.`--name [name]`: The display name of the channel for which to retrieve more information. Specify either `id` or `name` but not both.`--primary`: Gets the default channel, General, of a team. If specified, id or name are not needed.", "Examples": [ { - "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 teams channel get --teamId 00000000-0000-0000-0000-000000000000 --id '19:493665404ebd4a18adb8a980a31b4986@thread.skype'", + "Example": "Get information about Microsoft Teams team channel with id 19:493665404ebd4a18adb8a980a31b4986@thread.skype" }, { - "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 teams channel get --teamName \"Team Name\" --name \"Channel Name\"", + "Example": "Get information about Microsoft Teams team channel with name Channel Name" }, { - "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." + "Description": "m365 teams channel get --teamName \"Team Name\" --primary", + "Example": "Get information about Microsoft Teams team primary channel , i.e. General" } ] }, { - "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`.", + "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": "m365 spo tenant commandset get --title \"Some customizer\"", - "Example": "Retrieves a ListView Command Set by title." + "Description": "`-u, --webUrl `: Url of the web to list the group within", + "Example": "Lists all the groups within a specific web" }, { - "Description": "m365 spo tenant commandset get --id 3", - "Example": "Retrieves a ListView Command Set by id." + "Description": ": Get only the associated visitor, member and owner groups of the site.", + "Example": "`--associatedGroupsOnly`" }, { - "Description": "m365 spo tenant commandset get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc", - "Example": "Retrieves a ListView Command Set by clientSideComponentId." - } - ] - }, - { - "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": [ - { - "Description": "m365 spo site list", - "Example": "List all sites in the currently connected tenant" + "Description": ": Url of the web to list the group within", + "Example": "`-u, --webUrl `" }, { - "Description": "m365 spo site list --type TeamSite", - "Example": "List all group connected team sites in the currently connected tenant" + "Description": "`--associatedGroupsOnly`", + "Example": "" }, { - "Description": "m365 spo site list --type CommunicationSite", - "Example": "List all communication sites in the currently connected tenant" + "Description": "m365 spo group list [options]", + "Example": ": Get only the associated visitor, member and owner groups of the site." }, { - "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": "import Global from '/docs/cmd/_global.mdx';", + "Example": "Lists all the groups within specific web" }, { - "Description": "m365 spo site list --includeOneDriveSites", - "Example": "List all sites in the currently connected tenant including OneDrive sites" + "Description": null, + "Example": "m365 spo group list --webUrl \"https://contoso.sharepoint.com/sites/contoso\" --associatedGroupsOnly" } ] }, { - "Command": "m365 spo storageentity get", - "Description": "Get details for the specified tenant property", - "Options": "`-k, --key `: Name of the tenant property to retrieve", + "Command": "m365 spo navigation node get", + "Description": "Gets information about a specific navigation node.", + "Options": "`-u, --webUrl `: Absolute URL of the site.`--id `: Id of the navigation node.", "Examples": [ { - "Description": "m365 spo storageentity get -k AnalyticsId", - "Example": "Show the value, description and comment of the AnalyticsId tenant property" + "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 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`", + "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": [ { - "Description": "m365 spo cdn policy list", - "Example": "Show the list of policies configured for the Public CDN" - }, - { - "Description": "m365 spo cdn policy list --cdnType Private", - "Example": "Show the list of policies configured for the Private CDN" + "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 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 teams tab get", + "Description": "Gets information about the specified Microsoft Teams tab", + "Options": "`--teamId [teamId]`: The ID of the Microsoft Teams team where the tab is located. Specify either teamId or teamName but not both`--teamName [teamName]`: The display name of the Microsoft Teams team where the tab is located. Specify either teamId or teamName but not both`--channelId [channelId]`: The ID of the Microsoft Teams channel where the tab is located. Specify either channelId or channelName but not both`--channelName [channelName]`: The display name of the Microsoft Teams channel where the tab is located. Specify either channelId or channelName but not both`-i, --id [id]`: The ID of the Microsoft Teams tab. Specify either `id` or `name` but not both`-n, --name [name]`: The display name of the Microsoft Teams tab. Specify either `id` or `name` but not both", "Examples": [ { - "Description": "m365 spo web get --url https://contoso.sharepoint.com/subsite", - "Example": "Retrieve information about a 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" + "Description": "m365 teams tab get --teamId 00000000-0000-0000-0000-000000000000 --channelId 19:00000000000000000000000000000000@thread.skype --id 1432c9da-8b9c-4602-9248-e0800f3e3f07", + "Example": "Get a Microsoft Teams Tab with ID 1432c9da-8b9c-4602-9248-e0800f3e3f07" }, { - "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" + "Description": "m365 teams tab get --teamName \"Team Name\" --channelName \"Channel Name\" --name \"Tab Name\"", + "Example": "Get a Microsoft Teams Tab with name Tab Name" } ] }, { - "Command": "m365 spo sitedesign list", - "Description": "Lists available site designs for creating modern sites", - "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": [ { - "Description": "m365 spo sitedesign list", - "Example": "List available site designs" + "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 term list", - "Description": "Lists taxonomy terms from the given term set", - "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.", + "Command": "m365 teams channel list", + "Description": "Lists channels in the specified Microsoft Teams team", + "Options": "`-i, --teamId [teamId]`: The ID of the team to list the channels of. Specify either `teamId` or `teamName` but not both`--teamName [teamName]`: The display name of the team to list the channels of. Specify either `teamId` or `teamName` but not both`--type [type]`: Filter the results to only channels of a given type: `standard`, `private`, `shared`. By default all channels are listed.", "Examples": [ { - "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" - }, - { - "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." + "Description": "m365 teams channel list --teamId 00000000-0000-0000-0000-000000000000", + "Example": "List all channels in a specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000" }, { - "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." + "Description": "m365 teams channel list --teamName \"Team Name\"", + "Example": "List all channels in a specified Microsoft Teams team with name Team Name" }, { - "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." + "Description": "m365 teams channel list --teamId 00000000-0000-0000-0000-000000000000 --type private", + "Example": "List private channels in a specified Microsoft Teams team with id 00000000-0000-0000-0000-000000000000" } ] }, { - "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 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.", "Examples": [ { - "Description": "m365 spo term group get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb", - "Example": "Get information about a taxonomy term group using its ID." + "Description": "m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'", + "Example": "Gets list of folders under a parent folder with site-relative URL" }, { - "Description": "m365 spo term group get --name PnPTermSets", - "Example": "Get information about a taxonomy term group using its name." + "Description": "m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/sites/project-x/Shared Documents' --recursive", + "Example": "Gets recursive list of folders under a specific folder on a specific site" }, { - "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." + "Description": "m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --fields ListItemAllFields/Id --filter \"startswith(Name,'Folder')\"", + "Example": "Return a filtered list of folders and only return the list item ID" } ] }, { - "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 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": [ { - "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." - }, - { - "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." + "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 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." + "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." }, { - "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." + "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." }, { - "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." + "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." } ] }, { - "Command": "m365 spo tenant commandset list", - "Description": "Retrieves a list of ListView Command Sets that are installed tenant-wide", + "Command": "m365 spo tenant applicationcustomizer list", + "Description": "Retrieves a list of application customizers that are installed tenant-wide", "Options": null, "Examples": [ { - "Description": "m365 spo tenant commandset list", - "Example": "Retrieves a list of ListView Command Sets." + "Description": "m365 spo tenant applicationcustomizer list", + "Example": "Retrieves a list of application customizers." } ] }, { - "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.", + "Command": "m365 teams team list", + "Description": "Lists Microsoft Teams teams in the current tenant", + "Options": "`-j, --joined`: Show only teams that the user is a direct member of. Specify either `joined` or `associated` but not both.`-a, --associated`: Show only teams that the user is associated with. This includes teams with direct membership and shared channels. Specify either `joined` or `associated` but not both.`--userId [userId]`: The ID of the user. Specify either `userId` or `userName` but not both. Specify only when using `joined` or `associated` options.`--userName [userName]`: The user principal name of the user. Specify either `userId` or `userName` but not both. Specify only when using `joined` or `associated` options.", "Examples": [ { - "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 teams team list", + "Example": "List all Microsoft Teams in the tenant" }, { - "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" + "Description": "m365 teams team list --joined", + "Example": "List all Microsoft Teams teams you are a direct member of" }, { - "Description": "m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x", - "Example": "Get the currently logged-in user" - } - ] - }, - { - "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": [ - { - "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 teams team list --associated", + "Example": "List all Microsoft Teams teams you are a direct member of or are associated with via a shared channel" }, { - "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" + "Description": "m365 teams team list --joined --userName john.doe@contoso.com", + "Example": "List all Microsoft Teams teams another user is member of" }, { - "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" + "Description": "m365 teams team list --associated --userId e3aca2a8-625a-449b-bb86-cfa84c5d08de", + "Example": "List all Microsoft Teams teams where another user is a direct member of or is associated with via a shared channel" } ] }, { - "Command": "m365 spo tenant settings list", - "Description": "Lists the global tenant settings", - "Options": null, + "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.", "Examples": [ { - "Description": "m365 spo tenant settings list", - "Example": "Lists the settings of the tenant" + "Description": "m365 spo page section list --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx", + "Example": "List sections of a modern page" } ] }, { - "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.", + "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": [ { - "Description": "m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1", - "Example": "Retrieve the role definition for the given site" + "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 `" + }, + { + "Description": "Retrieve apps installed in a site", + "Example": "m365 spo app instance list [options]" + }, + { + "Description": "m365 spo app instance list --siteUrl https://contoso.sharepoint.com/sites/site1", + "Example": "import Global from '/docs/cmd/_global.mdx';" } ] }, { - "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", + "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": [ { - "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" + "Description": "m365 spo site list", + "Example": "List all sites in the currently connected tenant" }, { - "Description": ": Title of the list where the field is located. Specify only one of listTitle, listId or listUrl", - "Example": "`-l, --listTitle [listTitle]`" + "Description": "m365 spo site list --type TeamSite", + "Example": "List all group connected team sites in the currently connected tenant" }, { - "Description": ": ID of the list where the field is located. Specify only one of listTitle, listId or listUrl", - "Example": "`--listId [listId]`" + "Description": "m365 spo site list --type CommunicationSite", + "Example": "List all communication sites in the currently connected tenant" }, { - "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]`" + "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": ": The ID of the field to retrieve. Specify id or title but not both", - "Example": "`-i, --id [id]`" - }, + "Description": "m365 spo site list --includeOneDriveSites", + "Example": "List all sites in the currently connected tenant including OneDrive sites" + } + ] + }, + { + "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.", + "Examples": [ { - "Description": ": The display name (case-sensitive) of the field to remove. Specify id or title, or group but not both", - "Example": "`-t, --title [title]`" + "Description": "m365 spo term set get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termGroupName PnPTermSets", + "Example": "Get information about a taxonomy term set using its ID." }, { - "Description": ": Absolute URL of the site where the field is located", - "Example": "`-u, --webUrl `" + "Description": "m365 spo term set get --name PnP-Organizations --termGroupId 0a099ee9-e231-4ae9-a5b6-d7f94a0d241d", + "Example": "Get information about a taxonomy term set using its name." }, { - "Description": "`-l, --listTitle [listTitle]`", - "Example": "" - }, + "Description": "m365 spo term set get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termGroupName PnPTermSets --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Get information about a taxonomy term set using its ID from the specified sitecollection." + } + ] + }, + { + "Command": "m365 teams meeting transcript list", + "Description": "Lists all transcripts for a given meeting", + "Options": "`-u, --userId [userId]`: The id of the user, omit to list meeting transcripts list for current signed in user. Use either `id`, `userName` or `email`, but not multiple.`-n, --userName [userName]`: The upn of the user, omit to list meeting transcripts list for current signed in user. Use either `id`, `userName` or `email`, but not multiple.`--email [email]`: The email of the user, omit to list meeting transcripts list for current signed in user. Use either `id`, `userName` or `email`, but not multiple.`-m, --meetingId `: The id of the meeting.", + "Examples": [ { - "Description": "", - "Example": ": Title of the list where the field is located. Specify only one of listTitle, listId or listUrl" + "Description": "m365 teams meeting transcript list --meetingId MSo1N2Y5ZGFjYy03MWJmLTQ3NDMtYjQxMy01M2EdFGkdRWHJlQ", + "Example": "Lists all transcripts made for the current signed in user and Microsoft Teams meeting with given id" }, { - "Description": ": ID of the list where the field is located. Specify only one of listTitle, listId or listUrl", - "Example": "`--listId [listId]`" - }, + "Description": "m365 teams meeting transcript list --userName garthf@contoso.com --meetingId MSo1N2Y5ZGFjYy03MWJmLTQ3NDMtYjQxMy01M2EdFGkdRWHJlQ", + "Example": "Lists all transcripts for a meeting of a specific user" + } + ] + }, + { + "Command": "m365 spo customaction get", + "Description": "Gets information about a user custom action for site or site collection", + "Options": "`-i, --id [id]`: ID of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId``-t, --title [title]`: Title of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId``-c, --clientSideComponentId [clientSideComponentId]`: clientSideComponentId of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId``-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": [ { - "Description": "`--listUrl [listUrl]`", - "Example": "" + "Description": "m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test", + "Example": "Return details about the user custom action based on the id and a given url" }, { - "Description": "", - "Example": ": Server- or web-relative URL of the list where the field is located. Specify only one of listTitle, listId or listUrl" + "Description": "m365 spo customaction get --title \"YourAppCustomizer\" --webUrl https://contoso.sharepoint.com/sites/test", + "Example": "Return details about the user custom action based on the title and a given url" }, { - "Description": ": The ID of the field to retrieve. Specify id or title but not both", - "Example": "`-i, --id [id]`" + "Description": "m365 spo customaction get --clientSideComponentId \"34a019f9-6198-4053-a3b6-fbdea9a107fd\" --webUrl https://contoso.sharepoint.com/sites/test", + "Example": "Return details about the user custom action based on the clientSideComponentId and a given url" }, { - "Description": "`-t, --title [title]`", - "Example": "" - }, - { - "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" - }, - { - "Description": "import Global from '/docs/cmd/_global.mdx';", - "Example": "Retrieves information about the specified list- or site column" + "Description": "m365 spo customaction get --id \"058140e3-0e37-44fc-a1d3-79c487d371a3\" --webUrl https://contoso.sharepoint.com/sites/test --scope Site", + "Example": "Return details about the user custom action based on the id and a given url and the scope" }, { "Description": null, - "Example": "m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl \"Lists/Events\" --title \"Title\"" + "Example": "m365 spo customaction get --id \"058140e3-0e37-44fc-a1d3-79c487d371a3\" --webUrl https://contoso.sharepoint.com/sites/test --scope Web" } ] }, { - "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.", + "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": [ { - "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." - }, - { - "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." - }, - { - "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." + "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 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 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": [ { - "Description": "m365 spo applicationcustomizer list --webUrl https://contoso.sharepoint.com/sites/sales", - "Example": "Retrieves a list of application customizers." + "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 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.", + "Command": "m365 spo get", + "Description": "Gets the context URL for the root SharePoint site collection and SharePoint tenant admin site", + "Options": null, "Examples": [ { - "Description": "m365 spo term group list", - "Example": "List taxonomy term groups." - }, - { - "Description": "m365 spo term group list --webUrl https://contoso.sharepoint.com/sites/project-x", - "Example": "List taxonomy term groups from the specified sitecollection." + "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 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", + "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": [ { - "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" + "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 web clientsidewebpart list", - "Description": "Lists available client-side web parts", - "Options": "`-u, --webUrl `: URL of the site for which to retrieve the information", + "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": [ { - "Description": "m365 spo web clientsidewebpart list --webUrl https://contoso.sharepoint.com", - "Example": "Lists all the available client-side web parts for the specified site" + "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." + }, + { + "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 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 userprofile get", + "Description": "Get SharePoint user profile properties for the specified user", + "Options": "`-u, --userName `: Account name of the user", "Examples": [ { - "Description": "m365 spo user list --webUrl https://contoso.sharepoint.com/sites/project-x", - "Example": "Get list of users in a web" + "Description": "m365 spo userprofile get --userName 'john.doe@mytenant.onmicrosoft.com'", + "Example": "Get SharePoint user profile for the specified user" } ] }, { - "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.", + "Command": "m365 teams chat get", + "Description": "Get a Microsoft Teams chat conversation by id, participants or chat name.", + "Options": "`-i, --id [id]`: The ID of the chat conversation. Specify either `id`, `name` or `participants`, but not multiple.`-n, --name [name]`: The display name of the chat conversation. Specify either `id`, `name` or `participants`, but not multiple.`-p, --participants [participants]`: A comma-separated list of one or more e-mail addresses. Specify either `id`, `name` or `participants`, but not multiple.", "Examples": [ { - "Description": "`-u, --webUrl `: Url of the web to list the group within", - "Example": "Lists all the groups within a specific web" - }, - { - "Description": ": Get only the associated visitor, member and owner groups of the site.", - "Example": "`--associatedGroupsOnly`" - }, - { - "Description": ": Url of the web to list the group within", - "Example": "`-u, --webUrl `" - }, - { - "Description": "`--associatedGroupsOnly`", - "Example": "" + "Description": "m365 teams chat get --id 19:2da4c29f6d7041eca70b638b43d45437@thread.v2", + "Example": "Get a Microsoft Teams chat conversation by id" }, { - "Description": "m365 spo group list [options]", - "Example": ": Get only the associated visitor, member and owner groups of the site." + "Description": "m365 teams chat get --participants alexw@contoso.com", + "Example": "Get a Microsoft Teams one on one chat conversation, finding it by participant." }, { - "Description": "import Global from '/docs/cmd/_global.mdx';", - "Example": "Lists all the groups within specific web" + "Description": "m365 teams chat get --participants alexw@contoso.com,meganb@contoso.com", + "Example": "Get a Microsoft Teams group chat conversation, finding it by participants." }, { - "Description": null, - "Example": "m365 spo group list --webUrl \"https://contoso.sharepoint.com/sites/contoso\" --associatedGroupsOnly" + "Description": "m365 teams chat get --name \"Just a conversation\"", + "Example": "Get a Microsoft Teams chat conversation, finding it by display name" } ] }, { - "Command": "m365 spo orgassetslibrary list", - "Description": "List all libraries that are assigned as asset library", - "Options": null, + "Command": "m365 spo site recyclebinitem list", + "Description": "Lists items from recycle bin", + "Options": "`-u, --siteUrl `: URL of the site for which to retrieve the recycle bin items`--type [type]`: Type of items which should be retrieved (listItems, folders, files)`--secondary`: Use this switch to retrieve items from secondary recycle bin", "Examples": [ { - "Description": "m365 spo orgassetslibrary list", - "Example": "List all libraries that are assigned as asset library" - } - ] - }, - { - "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": [ + "Description": "m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site", + "Example": "Lists all files, items and folders from recycle bin for site https://contoso.sharepoint.com/site" + }, { - "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" + "Description": "m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site --type files", + "Example": "Lists only files from recycle bin for site https://contoso.sharepoint.com/site" } ] }, { - "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.", + "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: `tenant,sitecollection`. Default `tenant`", "Examples": [ { - "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 app get --id b2307a39-e878-458b-bc90-03bc578531d6", + "Example": "Return details about the app with ID b2307a39-e878-458b-bc90-03bc578531d6 available in the tenant app catalog." }, { - "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 app get --name solution.sppkg", + "Example": "Return details about the app with name solution.sppkg available in the tenant app catalog. Will try to detect the app catalog 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." + "Description": "m365 spo app get --name solution.sppkg --appCatalogUrl https://contoso.sharepoint.com/sites/apps", + "Example": "Return details about the app with name solution.sppkg available in the tenant app catalog using the specified app catalog URL" + }, + { + "Description": "m365 spo app get --id b2307a39-e878-458b-bc90-03bc578531d6 --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1", + "Example": "Return details about the app with ID b2307a39-e878-458b-bc90-03bc578531d6 available in the site collection app catalog of site https://contoso.sharepoint.com/sites/site1." } ] }, { - "Command": "m365 spo contenttypehub get", - "Description": "Returns the URL of the SharePoint Content Type Hub of the Tenant", - "Options": null, + "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.", "Examples": [ { - "Description": "m365 spo contenttypehub get [options]", - "Example": "Retrieve the Content Type Hub URL" + "Description": "m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1", + "Example": "Returns the value of the property from the property bag located in the given site" }, { - "Description": "import Global from '/docs/cmd/_global.mdx';", - "Example": "Returns the URL of the SharePoint Content Type Hub of the Tenant" + "Description": "m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder /", + "Example": "Returns the value of the property from the property bag located in root folder of the given site" }, { - "Description": null, - "Example": "m365 spo contenttypehub get" + "Description": "m365 spo propertybag get --webUrl https://contoso.sharepoint.com/sites/test --key key1 --folder '/Shared Documents'", + "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/MyFolder'", + "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 /Lists/MyList", + "Example": "Returns the value of the property from the property bag located in a list in the given site" } ] }, { - "Command": "m365 spo serviceprincipal permissionrequest list", - "Description": "Lists pending permission requests", - "Options": "m365 spo sp permissionrequest list", + "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": [ + { + "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": "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." + "Example": "m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'" } ] }, { - "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`.", + "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.", "Examples": [ { - "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 term get --webUrl https://contoso.sharepoint.com/sites/project-x --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb", + "Example": "Get information about a taxonomy term using its ID from the specified sitecollection." }, { - "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." + "Description": "m365 spo term get --id 0e8f395e-ff58-4d45-9ff7-e331ab728beb", + "Example": "Get information about a taxonomy term using its ID." }, { - "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." + "Description": "m365 spo term get --name IT --termGroupName People --termSetName Department", + "Example": "Get information about a taxonomy term using its name, retrieving the parent term group and term set using their names." }, { - "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." + "Description": "m365 spo term get --name IT --termGroupId 5c928151-c140-4d48-aab9-54da901c7fef --termSetId 8ed8c9ea-7052-4c1d-a4d7-b9c10bffea6f", + "Example": "Get information about a taxonomy term using its name, retrieving the parent term group and term set using their IDs." } ] }, { - "Command": "m365 spo navigation node get", - "Description": "Gets information about a specific navigation node.", - "Options": "`-u, --webUrl `: Absolute URL of the site.`--id `: Id of the navigation node.", + "Command": "m365 teams team get", + "Description": "Gets information about the specified Microsoft Teams team", + "Options": "`-i, --id [id]`: The ID of the Microsoft Teams team to retrieve information for. Specify either `id` or `name` but not both.`-n, --name [name]`: The display name of the Microsoft Teams team to retrieve information for. Specify either `id` or `name` but not both.", "Examples": [ { - "Description": "m365 spo navigation node get --webUrl https://contoso.sharepoint.com/sites/team-a --id 2209", - "Example": "Retrieve information for a specific navigation node." + "Description": "m365 teams team get --id 2eaf7dcd-7e83-4c3a-94f7-932a1299c844", + "Example": "Get information about the Microsoft Teams team by id." + }, + { + "Description": "m365 teams team get --name \"Team Name\"", + "Example": "Get information about Microsoft Teams team by name." } ] }, { - "Command": "m365 spo hidedefaultthemes get", - "Description": "Gets the current value of the HideDefaultThemes setting", + "Command": "m365 spo folder get", + "Description": "Gets information about the specified folder", + "Options": "`-u, --webUrl `: The URL of the site where the folder is located.`--url [url]`: The server- or site-relative decoded URL of the folder to retrieve. Specify either `folderUrl` or `id` but not both.`-i, --id [id]`: The UniqueId (GUID) of the folder to retrieve. Specify either `url` or `id` but not both.`--withPermissions`: Set if you want to return associated roles and permissions of the folder. ", + "Examples": [ + { + "Description": "Please ensure the specified folder URL or folder Id does not refer to a root folder. Use \\'spo list get\\' with withPermissions instead' error.", + "Example": "Get folder properties for a folder with a specific site-relative URL" + }, + { + "Description": "Please check the folder URL. Folder might not exist on the specified URL", + "Example": "If root level folder is passed, you will get a Please ensure the specified folder URL or folder Id does not refer to a root folder. Use \\'spo list get\\' with withPermissions instead' error. Please use the command 'spo list get'." + }, + { + "Description": "`-u, --webUrl `: The URL of the site where the folder is located.", + "Example": "If no folder exists at the specified URL, you will get a Please check the folder URL. Folder might not exist on the specified URL error." + }, + { + "Description": ": The server- or site-relative decoded URL of the folder to retrieve. Specify either `folderUrl` or `id` but not both.", + "Example": "`--url [url]`" + }, + { + "Description": ": The UniqueId (GUID) of the folder to retrieve. Specify either `url` or `id` but not both.", + "Example": "`-i, --id [id]`" + }, + { + "Description": ": Set if you want to return associated roles and permissions of the folder. ", + "Example": "`--withPermissions`" + }, + { + "Description": ": The URL of the site where the folder is located.", + "Example": "`-u, --webUrl `" + }, + { + "Description": "`--url [url]`", + "Example": "" + }, + { + "Description": "", + "Example": ": The server- or site-relative decoded URL of the folder to retrieve. Specify either `folderUrl` or `id` but not both." + }, + { + "Description": ": The UniqueId (GUID) of the folder to retrieve. Specify either `url` or `id` but not both.", + "Example": "`-i, --id [id]`" + }, + { + "Description": "`--withPermissions`", + "Example": "" + }, + { + "Description": "m365 spo folder get [options]", + "Example": ": Set if you want to return associated roles and permissions of the folder. " + }, + { + "Description": "import Global from '/docs/cmd/_global.mdx';", + "Example": "Gets information about the specified folder" + }, + { + "Description": null, + "Example": "m365 spo folder get --webUrl https://contoso.sharepoint.com/sites/test --url \"/sites/test/Shared Documents/Test1\" --withPermissions" + } + ] + }, + { + "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", + "Examples": [ + { + "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 listItemId 147 in list with title Demo List in site https://contoso.sharepoint.com/sites/project-x" + }, + { + "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 list item with listItemId 147 in list with id 0cd891ef-afce-4e55-b836-fce03286cccf in site https://contoso.sharepoint.com/sites/project-x" + }, + { + "Description": "m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/Documents --listItemId 147", + "Example": "Gets the attachments from a specific list item in a specific list obtained by server-relative URL in a specific site" + } + ] + }, + { + "Command": "m365 spo page control list", + "Description": "Lists controls on the specific modern page", + "Options": "`-n, --pageName `: Name of the page to list controls of.`-u, --webUrl `: URL of the site where the page to retrieve is located.", + "Examples": [ + { + "Description": "m365 spo page control list --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx", + "Example": "List controls on the modern page" + } + ] + }, + { + "Command": "m365 spo orgnewssite list", + "Description": "Lists all organizational news sites", "Options": null, "Examples": [ { - "Description": "m365 spo hidedefaultthemes get", - "Example": "Get the current value of the HideDefaultThemes setting" + "Description": "m365 spo orgnewssite list", + "Example": "List all organizational news sites" } ] }, { - "Command": "m365 spo serviceprincipal grant list", - "Description": "Lists permissions granted to the service principal", - "Options": "m365 spo sp grant list", + "Command": "m365 spo orgassetslibrary list", + "Description": "List all libraries that are assigned as asset library", + "Options": null, + "Examples": [ + { + "Description": "m365 spo orgassetslibrary list", + "Example": "List all libraries that are assigned as asset library" + } + ] + }, + { + "Command": "m365 teams team app list", + "Description": "List apps installed in the specified team", + "Options": "`-i, --teamId [teamId]`: The id of the Microsoft Teams team. Specify either `teamId` or `teamName` but not both.`-n, --teamName [teamName]`: The name of the Microsoft Teams team. Specify either `teamId` or `teamName` but not both.", + "Examples": [ + { + "Description": "m365 teams team app list --teamId 2eaf7dcd-7e83-4c3a-94f7-932a1299c844", + "Example": "List applications installed in the specified Microsoft Teams team by id." + }, + { + "Description": "m365 teams team app list --teamName \"Team Name\"", + "Example": "List applications installed in the specified Microsoft Teams team by name." + } + ] + }, + { + "Command": "m365 spo hubsite get", + "Description": "Gets information about the specified hub site", + "Options": "`-i, --id [id]`: ID of the hub site. Specify either `id`, `title`, or `url` but not multiple.`-t, --title [title]`: Title of the hub site. Specify either `id`, `title`, or `url` but not multiple.`-u, --url [url]`: URL of the hub site. Specify either `id`, `title`, or `url` but not multiple.`--includeAssociatedSites`: Include the associated sites in the result (only in JSON output)", + "Examples": [ + { + "Description": "m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a", + "Example": "Get information about the hub site with specific ID." + }, + { + "Description": "m365 spo hubsite get --title 'My Hub Site'", + "Example": "Get information about the hub site with specific title." + }, + { + "Description": "m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'", + "Example": "Get information about the hub site with specific URL." + }, + { + "Description": "m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociatedSites --output json", + "Example": "Get information about the hub site with specific ID, including its associated sites. Associated site info is only shown in JSON output." + } + ] + }, + { + "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": [ + { + "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 teams chat member list", + "Description": "Lists all members from a Microsoft Teams chat conversation.", + "Options": "`-i, --chatId `: The ID of the chat conversation", + "Examples": [ + { + "Description": "m365 teams chat member list --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces", + "Example": "List the members from a Microsoft Teams chat conversation" + } + ] + }, + { + "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": [ + { + "Description": "`-u, --webUrl `", + "Example": "Retrieves event receivers in web https://contoso.sharepoint.com/sites/contoso-sales." + }, + { + "Description": "`--listTitle [listTitle]`", + "Example": ": The URL of the web for which to retrieve the event receivers." + }, + { + "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`." + }, + { + "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`." + }, + { + "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`." + }, + { + "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." + }, + { + "Description": "", + "Example": ": The URL of the web for which to retrieve the event receivers." + }, + { + "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]`" + }, + { + "Description": "`--listId [listId]`", + "Example": "" + }, + { + "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`." + }, + { + "Description": ": 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": "`--listUrl [listUrl]`" + }, + { + "Description": "`-s, --scope [scope]`", + "Example": "" + }, + { + "Description": "m365 spo eventreceiver list [options]", + "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." + }, + { + "Description": "import Global from '/docs/cmd/_global.mdx';", + "Example": "Retrieves event receivers for the specified web, site or list." + }, { "Description": null, - "Example": "To use this command you must be a Global administrator." + "Example": "m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'" + } + ] + }, + { + "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. Use either `groupName` or `groupId`, but not both`--groupName [groupName]`: Name of the SharePoint group. Use either `groupName` or `groupId`, but not both", + "Examples": [ + { + "Description": "`-u, --webUrl `: URL of the SharePoint site`--groupId [groupId]`", + "Example": "List the members of the group with ID 5 for web https://contoso.sharepoint.com/sites/SiteA" + }, + { + "Description": "`--groupName [groupName]`", + "Example": ": Id of the SharePoint group. Use either `groupName` or `groupId`, but not both" + }, + { + "Description": "`-u, --webUrl `", + "Example": ": Name of the SharePoint group. Use either `groupName` or `groupId`, but not both" + }, + { + "Description": "", + "Example": ": URL of the SharePoint site" + }, + { + "Description": ": Id of the SharePoint group. Use either `groupName` or `groupId`, but not both", + "Example": "`--groupId [groupId]`" + }, + { + "Description": "`--groupName [groupName]`", + "Example": "" + }, + { + "Description": "m365 spo group member list [options]", + "Example": ": Name of the SharePoint group. Use either `groupName` or `groupId`, but not both" + }, + { + "Description": "import Global from '/docs/cmd/_global.mdx';", + "Example": "List the members of a SharePoint Group" + }, + { + "Description": null, + "Example": "m365 spo group member list --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName \"Contoso Site Members\"" } ] }, @@ -980,372 +1350,445 @@ export const Commands = [ ] }, { - "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 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.", + "Examples": [ + { + "Description": "m365 spo roledefinition list --webUrl https://contoso.sharepoint.com/sites/project-x", + "Example": "Return list of role definitions for the given site" + } + ] + }, + { + "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": [ + { + "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 externaluser list", + "Description": "Lists external users in the tenant", + "Options": "`--filter [filter]`: Limits the results to only those users whose first name, last name or email address begins with the text in the string, using a case-insensitive comparison`-p, --pageSize [pageSize]`: Specifies the maximum number of users to be returned in the collection. The value must be less than or equal to `50``-i, --position [position]`: Use to specify the zero-based index of the position in the sorted collection of the first result to be returned`-s, --sortOrder [sortOrder]`: Specifies the sort results in Ascending or Descending order on the `SPOUser.Email` property should occur. Allowed values `asc|desc`. Default `asc``-u, --siteUrl [siteUrl]`: Specifies the site to retrieve external users for. If no site is specified, the external users for all sites are returned", + "Examples": [ + { + "Description": "To use this command you have to have permissions to access the tenant admin site.", + "Example": "List all external users from the current tenant. Show the first batch of 50 users." + }, + { + "Description": ": Limits the results to only those users whose first name, last name or email address begins with the text in the string, using a case-insensitive comparison", + "Example": "`--filter [filter]`" + }, + { + "Description": ": Specifies the maximum number of users to be returned in the collection. The value must be less than or equal to `50`", + "Example": "`-p, --pageSize [pageSize]`" + }, + { + "Description": ": Use to specify the zero-based index of the position in the sorted collection of the first result to be returned", + "Example": "`-i, --position [position]`" + }, + { + "Description": ": Specifies the sort results in Ascending or Descending order on the `SPOUser.Email` property should occur. Allowed values `asc|desc`. Default `asc`", + "Example": "`-s, --sortOrder [sortOrder]`" + }, + { + "Description": ": Specifies the site to retrieve external users for. If no site is specified, the external users for all sites are returned", + "Example": "`-u, --siteUrl [siteUrl]`" + }, + { + "Description": ": Limits the results to only those users whose first name, last name or email address begins with the text in the string, using a case-insensitive comparison", + "Example": "`--filter [filter]`" + }, + { + "Description": "`-p, --pageSize [pageSize]`", + "Example": "" + }, + { + "Description": "", + "Example": ": Specifies the maximum number of users to be returned in the collection. The value must be less than or equal to `50`" + }, + { + "Description": ": Use to specify the zero-based index of the position in the sorted collection of the first result to be returned", + "Example": "`-i, --position [position]`" + }, + { + "Description": "`-s, --sortOrder [sortOrder]`", + "Example": "" + }, + { + "Description": "", + "Example": ": Specifies the sort results in Ascending or Descending order on the `SPOUser.Email` property should occur. Allowed values `asc|desc`. Default `asc`" + }, + { + "Description": ": Specifies the site to retrieve external users for. If no site is specified, the external users for all sites are returned", + "Example": "`-u, --siteUrl [siteUrl]`" + }, + { + "Description": "Lists external users in the tenant", + "Example": "m365 spo externaluser list [options]" + }, + { + "Description": "m365 spo externaluser list --pageSize 50 --position 0 --sortOrder desc", + "Example": "import Global from '/docs/cmd/_global.mdx';" + } + ] + }, + { + "Command": "m365 spo homesite get", + "Description": "Gets information about the Home Site", + "Options": null, "Examples": [ { - "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." + "Description": "m365 spo homesite get", + "Example": "Get information about the Home Site." } ] }, { - "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.", + "Command": "m365 teams chat list", + "Description": "Lists all Microsoft Teams chat conversations for the current or a specific user.", + "Options": "`-t, --type [type]`: The chat type to optionally filter chat conversations by type. The value can be `oneOnOne`, `group` or `meeting`.`--userId [userId]`: ID of the user. Has to be specified when using application permissions. Specify either `userId` or `userName`, but not both.`--userName [userName]`: UPN of the user. Has to be specified when using application permissions. Specify either `userId` or `userName`, but not both.", "Examples": [ { - "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." + "Description": "m365 teams chat list", + "Example": "List all the Microsoft Teams chat conversations of the current user." }, { - "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." + "Description": "m365 teams chat list --userId e6296ed0-4b7d-4ace-aed4-f6b7371ce060 --type oneOnOne", + "Example": "List only the one on one Microsoft Teams chat conversations of a specific user retrieved by id." + }, + { + "Description": "m365 teams chat list --userName 'john@contoso.com' --type group ", + "Example": "List only the group Microsoft Teams chat conversations of a specific user retrieved by mail" } ] }, { - "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).", + "Command": "m365 spo tenant settings list", + "Description": "Lists the global tenant settings", + "Options": null, "Examples": [ { - "Description": "m365 spo hubsite list", - "Example": "List hub sites in the current tenant" - }, - { - "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." + "Description": "m365 spo tenant settings list", + "Example": "Lists the settings of the tenant" } ] }, { - "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 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": [ { - "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" + "Description": "m365 spo cdn policy list", + "Example": "Show the list of policies configured for the Public CDN" + }, + { + "Description": "m365 spo cdn policy list --cdnType Private", + "Example": "Show the list of policies configured for the Private CDN" } ] }, { - "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 serviceprincipal permissionrequest list", + "Description": "Lists pending permission requests", + "Options": "m365 spo sp permissionrequest list", "Examples": [ { - "Description": "m365 spo userprofile get --userName 'john.doe@mytenant.onmicrosoft.com'", - "Example": "Get SharePoint user profile for the specified user" + "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 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 theme list", + "Description": "Retrieves the list of custom themes", + "Options": null, "Examples": [ { - "Description": "m365 spo page list --webUrl https://contoso.sharepoint.com/sites/team-a", - "Example": "List all modern pages in the specific site" + "Description": "m365 spo theme list", + "Example": "List available themes" } ] }, { - "Command": "m365 spo tenant appcatalogurl get", - "Description": "Gets the URL of the tenant app catalog", - "Options": null, + "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. `Public,Private`. Default `Public`", "Examples": [ { - "Description": "m365 spo tenant appcatalogurl get", - "Example": "Get the URL of the tenant app catalog" + "Description": "m365 spo cdn origin list", + "Example": "Show the list of origins configured for the Public CDN" + }, + { + "Description": "m365 spo cdn origin list --type Private", + "Example": "Show the list of origins configured for the Private CDN" } ] }, { - "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 teams membersettings list", + "Description": "Lists member settings for a Microsoft Teams team", + "Options": "`-i, --teamId`: The ID of the team for which to get the member settings", "Examples": [ { - "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" - }, - { - "Description": "m365 spo sitedesign get --title \"Contoso Site Design\"", - "Example": "Get information about the site design with title Contoso Site Design" + "Description": "m365 teams membersettings list --teamId 2609af39-7775-4f94-a3dc-0dd67657e900", + "Example": "Get member settings for a Microsoft Teams team" } ] }, { - "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.", + "Command": "m365 spo feature list", + "Description": "Lists Features activated in the specified site or site collection", + "Options": "`-u, --webUrl `: URL of the site (collection) to retrieve the activated Features from`-s, --scope [scope]`: Scope of the Features to retrieve. Allowed values `Site,Web`. Default `Web`", "Examples": [ { "Description": "`-u, --webUrl `", - "Example": "Retrieves event receivers in web https://contoso.sharepoint.com/sites/contoso-sales." - }, - { - "Description": "`--listTitle [listTitle]`", - "Example": ": The URL of the web for which to retrieve the event receivers." - }, - { - "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`." - }, - { - "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": "Return details about Features activated in the specified site collection" }, { "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": ": URL of the site (collection) to retrieve the activated Features from" }, { "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": ": Scope of the Features to retrieve. Allowed values `Site,Web`. Default `Web`" }, { "Description": "", - "Example": ": The URL of the web for which to retrieve the event receivers." - }, - { - "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": ": URL of the site (collection) to retrieve the activated Features from" }, { - "Description": "`--listId [listId]`", - "Example": "" + "Description": ": Scope of the Features to retrieve. Allowed values `Site,Web`. Default `Web`", + "Example": "`-s, --scope [scope]`" }, { - "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`." + "Description": "Lists Features activated in the specified site or site collection", + "Example": "m365 spo feature list [options]" }, { - "Description": ": 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": "`--listUrl [listUrl]`" - }, + "Description": "m365 spo feature list --webUrl https://contoso.sharepoint.com/sites/test --scope Web", + "Example": "import Global from '/docs/cmd/_global.mdx';" + } + ] + }, + { + "Command": "m365 teams chat message list", + "Description": "Lists all messages from a Microsoft Teams chat conversation.", + "Options": "`-i, --chatId `: The ID of the chat conversation", + "Examples": [ { - "Description": "`-s, --scope [scope]`", - "Example": "" - }, + "Description": "m365 teams chat message list --chatId 19:2da4c29f6d7041eca70b638b43d45437@thread.v2", + "Example": "List the messages from a Microsoft Teams chat conversation" + } + ] + }, + { + "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.", + "Examples": [ { - "Description": "m365 spo eventreceiver list [options]", - "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." - }, + "Description": "m365 spo page section get --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --section 1", + "Example": "Get information about the specified section of the modern page" + } + ] + }, + { + "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