From 03269b6eec4766b56e3db85a2a775ff0303b1b78 Mon Sep 17 00:00:00 2001 From: Nanddeep Nachan Date: Mon, 2 Oct 2023 16:34:01 +0000 Subject: [PATCH 1/3] response output --- docs/docs/cmd/spo/app/app-add.mdx | 99 ++++++++++- docs/docs/cmd/spo/app/app-deploy.mdx | 18 +- docs/docs/cmd/spo/app/app-get.mdx | 123 +++++++++++++- docs/docs/cmd/spo/app/app-install.mdx | 14 +- docs/docs/cmd/spo/app/app-instance-list.mdx | 85 +++++++++- docs/docs/cmd/spo/app/app-list.mdx | 96 ++++++++++- docs/docs/cmd/spo/app/app-remove.mdx | 18 +- docs/docs/cmd/spo/app/app-retract.mdx | 14 +- .../cmd/spo/app/app-teamspackage-download.mdx | 20 ++- docs/docs/cmd/spo/app/app-uninstall.mdx | 18 +- docs/docs/cmd/spo/app/app-upgrade.mdx | 14 +- .../applicationcustomizer-add.mdx | 4 +- .../applicationcustomizer-get.mdx | 11 +- .../applicationcustomizer-list.mdx | 5 +- .../applicationcustomizer-remove.mdx | 12 +- .../applicationcustomizer-set.mdx | 4 +- docs/docs/cmd/spo/apppage/apppage-add.mdx | 57 ++++++- docs/docs/cmd/spo/apppage/apppage-set.mdx | 12 +- docs/docs/cmd/spo/cdn/cdn-get.mdx | 35 +++- docs/docs/cmd/spo/cdn/cdn-origin-add.mdx | 10 +- docs/docs/cmd/spo/cdn/cdn-origin-list.mdx | 49 +++++- docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx | 12 +- docs/docs/cmd/spo/cdn/cdn-policy-list.mdx | 54 +++++- docs/docs/cmd/spo/cdn/cdn-policy-set.mdx | 10 +- docs/docs/cmd/spo/cdn/cdn-set.mdx | 10 +- .../cmd/spo/commandset/commandset-add.mdx | 8 +- .../cmd/spo/commandset/commandset-list.mdx | 2 +- .../cmd/spo/commandset/commandset-remove.mdx | 4 +- .../cmd/spo/commandset/commandset-set.mdx | 6 +- .../cmd/spo/contenttype/contenttype-add.mdx | 155 +++++++++++++++++- .../contenttype/contenttype-field-remove.mdx | 34 ++-- .../spo/contenttype/contenttype-field-set.mdx | 20 ++- .../cmd/spo/contenttype/contenttype-get.mdx | 153 ++++++++++++++++- .../cmd/spo/contenttype/contenttype-list.mdx | 117 ++++++++++++- .../spo/contenttype/contenttype-remove.mdx | 12 +- .../cmd/spo/contenttype/contenttype-set.mdx | 12 +- .../spo/contenttypehub/contenttypehub-get.mdx | 42 +++++ .../cmd/spo/customaction/customaction-add.mdx | 20 ++- .../spo/customaction/customaction-clear.mdx | 17 +- .../cmd/spo/customaction/customaction-get.mdx | 22 +-- .../spo/customaction/customaction-list.mdx | 90 +++++++++- .../spo/customaction/customaction-remove.mdx | 30 ++-- .../cmd/spo/customaction/customaction-set.mdx | 50 +++--- .../spo/eventreceiver/eventreceiver-get.mdx | 43 +++-- .../spo/eventreceiver/eventreceiver-list.mdx | 69 +++++++- .../eventreceiver/eventreceiver-remove.mdx | 4 + 46 files changed, 1454 insertions(+), 260 deletions(-) diff --git a/docs/docs/cmd/spo/app/app-add.mdx b/docs/docs/cmd/spo/app/app-add.mdx index ee1429bdb07..75371618514 100644 --- a/docs/docs/cmd/spo/app/app-add.mdx +++ b/docs/docs/cmd/spo/app/app-add.mdx @@ -14,16 +14,16 @@ m365 spo app add [options] ```md definition-list `-p, --filePath ` -: Absolute or relative path to the solution package file to add to the app catalog +: Absolute or relative path to the solution package file to add to the app catalog. `--overwrite` -: Set to overwrite the existing package file +: Set to overwrite the existing package file. `-s, --appCatalogScope [appCatalogScope]` -: Scope of the app catalog: `tenant,sitecollection`. Default `tenant` +: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. `-u, --appCatalogUrl [appCatalogUrl]` -: The URL of the app catalog where the solution package will be added. It must be specified when the scope is `sitecollection` +: The URL of the app catalog where the solution package will be added. It must be specified when the scope is `sitecollection`. ``` @@ -40,24 +40,109 @@ If you try to upload a package that already exists in the app catalog without sp ## Examples -Add the _spfx.sppkg_ package to the tenant app catalog +Add the package from relative path to the tenant app catalog. ```sh m365 spo app add --filePath /Users/pnp/spfx/sharepoint/solution/spfx.sppkg ``` -Overwrite the _spfx.sppkg_ package in the tenant app catalog with the newer version +Overwrite the package in the tenant app catalog with the newer version. ```sh m365 spo app add --filePath sharepoint/solution/spfx.sppkg --overwrite ``` -Add the _spfx.sppkg_ package to the site collection app catalog of site _https://contoso.sharepoint.com/sites/site1_ +Add the package from absolute path to the site collection app catalog of the specified site. ```sh m365 spo app add --filePath c:\spfx.sppkg --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1 ``` +## Response + + + + + ```json + { + "CheckInComment": "", + "CheckOutType": 2, + "ContentTag": "{4BBC7873-4638-487D-900B-EF917A907C5A},2,1", + "CustomizedPageStatus": 0, + "ETag": "\"{4BBC7873-4638-487D-900B-EF917A907C5A},2\"", + "Exists": true, + "ExistsAllowThrowForPolicyFailures": true, + "IrmEnabled": false, + "Length": "757211", + "Level": 1, + "LinkingUri": null, + "LinkingUrl": "", + "MajorVersion": 1, + "MinorVersion": 0, + "Name": "spfx.sppkg", + "ServerRelativeUrl": "/sites/apps/AppCatalog/spfx.sppkg", + "TimeCreated": "2023-10-02T06:53:30Z", + "TimeLastModified": "2023-10-02T06:53:30Z", + "Title": "spfx-client-side-solution", + "UIVersion": 512, + "UIVersionLabel": "1.0", + "UniqueId": "4bbc7873-4638-487d-900b-ef917a907c5a" + } + ``` + + + + + ```text + e0f53330-61ec-4fee-882d-fadfb74b2033 + ``` + + + + + ```csv + CheckInComment,CheckOutType,ContentTag,CustomizedPageStatus,ETag,Exists,ExistsAllowThrowForPolicyFailures,IrmEnabled,Length,Level,LinkingUrl,MajorVersion,MinorVersion,Name,ServerRelativeUrl,TimeCreated,TimeLastModified,Title,UIVersion,UIVersionLabel,UniqueId + ,2,"{B9BCE524-2940-457B-A015-30CBAAB4C210},2,1",0,"""{B9BCE524-2940-457B-A015-30CBAAB4C210},2""",1,1,,757211,1,,1,0,spfx.sppkg,/sites/apps/AppCatalog/spfx.sppkg,2023-10-02T06:55:12Z,2023-10-02T06:55:12Z,spfx-client-side-solution,512,1.0,b9bce524-2940-457b-a015-30cbaab4c210 + ``` + + + + + ```md + # spo app add --filePath "C:\SPFx\sharepoint\solution\spfx.sppkg" + + Date: 10/2/2023 + + ## spfx-client-side-solution (b05196d4-65a3-4ee3-bf92-4acfb7a05cd7) + + Property | Value + ---------|------- + CheckInComment | + CheckOutType | 2 + ContentTag | {B05196D4-65A3-4EE3-BF92-4ACFB7A05CD7},2,1 + CustomizedPageStatus | 0 + ETag | "{B05196D4-65A3-4EE3-BF92-4ACFB7A05CD7},2" + Exists | true + ExistsAllowThrowForPolicyFailures | true + IrmEnabled | false + Length | 757211 + Level | 1 + LinkingUrl | + MajorVersion | 1 + MinorVersion | 0 + Name | spfx.sppkg + ServerRelativeUrl | /sites/apps/AppCatalog/spfx.sppkg + TimeCreated | 2023-10-02T06:56:02Z + TimeLastModified | 2023-10-02T06:56:02Z + Title | spfx-client-side-solution + UIVersion | 512 + UIVersionLabel | 1.0 + UniqueId | b05196d4-65a3-4ee3-bf92-4acfb7a05cd7 + ``` + + + + ## More information - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins) diff --git a/docs/docs/cmd/spo/app/app-deploy.mdx b/docs/docs/cmd/spo/app/app-deploy.mdx index c0fd0fbacf2..25b7a3262fc 100644 --- a/docs/docs/cmd/spo/app/app-deploy.mdx +++ b/docs/docs/cmd/spo/app/app-deploy.mdx @@ -14,19 +14,19 @@ m365 spo app deploy [options] ```md definition-list `-i, --id [id]` -: ID of the app to deploy. Specify the `id` or the `name` but not both +: ID of the app to deploy. Specify the `id` or the `name` but not both. `-n, --name [name]` -: Name of the app to deploy. Specify the `id` or the `name` but not both +: Name of the app to deploy. 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` +: URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection`. `--skipFeatureDeployment` -: If the app supports tenant-wide deployment, deploy it to the whole tenant +: If the app supports tenant-wide deployment, deploy it to the whole tenant. `-s, --appCatalogScope [appCatalogScope]` -: Scope of the app catalog: `tenant,sitecollection`. Default `tenant` +: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. ``` @@ -47,7 +47,7 @@ Deploy the specified app in the tenant app catalog. Try to resolve the URL of th m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3 ``` -Deploy the specified app in the site collection app catalog of site _https://contoso.sharepoint.com/sites/site1_ +Deploy the specified app in the site collection app catalog of the specified site. ```sh m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1 @@ -59,7 +59,7 @@ Deploy the app with the specified name in the tenant app catalog. Try to resolve m365 spo app deploy --name solution.sppkg ``` -Deploy the specified app in the tenant app catalog located at _https://contoso.sharepoint.com/sites/apps_ +Deploy the specified app in the tenant app catalog. ```sh m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --appCatalogUrl https://contoso.sharepoint.com/sites/apps @@ -71,6 +71,10 @@ Deploy the specified app to the whole tenant at once. Features included in the s m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --skipFeatureDeployment ``` +## Response + +The command won't return a response on success. + ## More information - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins) diff --git a/docs/docs/cmd/spo/app/app-get.mdx b/docs/docs/cmd/spo/app/app-get.mdx index 49b4d700f91..4fc7225d176 100644 --- a/docs/docs/cmd/spo/app/app-get.mdx +++ b/docs/docs/cmd/spo/app/app-get.mdx @@ -14,16 +14,16 @@ m365 spo app get [options] ```md definition-list `-i, --id [id]` -: ID of the app to retrieve information for. Specify the `id` or the `name` but not both +: 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 +: 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` +: 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` +: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. ``` @@ -36,30 +36,137 @@ When specifying site collection app catalog, you can specify the URL either with ## Examples -Return details about the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ available in the tenant app catalog. +Return details about the app with the specified ID available in the tenant app catalog. ```sh m365 spo app get --id b2307a39-e878-458b-bc90-03bc578531d6 ``` -Return details about the app with name _solution.sppkg_ available in the tenant app catalog. Will try to detect the app catalog URL +Return details about the app with the specified name available in the tenant app catalog. Will try to detect the app catalog URL. ```sh m365 spo app get --name solution.sppkg ``` -Return details about the app with name _solution.sppkg_ available in the tenant app catalog using the specified app catalog URL +Return details about the app with the specified name available in the tenant app catalog using the specified app catalog URL. ```sh m365 spo app get --name solution.sppkg --appCatalogUrl https://contoso.sharepoint.com/sites/apps ``` -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_. +Return details about the app with the specified ID available in the site collection app catalog of the specified site. ```sh m365 spo app get --id b2307a39-e878-458b-bc90-03bc578531d6 --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1 ``` +## Response + + + + + ```json + { + "AadAppId": "48535560-3cc0-442e-a1b4-94c084b3ff59", + "AadPermissions": "Microsoft Graph, Directory.ReadWrite.All", + "AppCatalogVersion": "1.6.0.0", + "CanUpgrade": false, + "CDNLocation": "SharePoint Online", + "ContainsTenantWideExtension": false, + "CurrentVersionDeployed": true, + "Deployed": true, + "ErrorMessage": "No errors.", + "ID": "b05196d4-65a3-4ee3-bf92-4acfb7a05cd7", + "InstalledVersion": "", + "IsClientSideSolution": true, + "IsEnabled": true, + "IsPackageDefaultSkipFeatureDeployment": true, + "IsValidAppPackage": true, + "ProductId": "1e5954e2-fc1c-4501-8678-27a6bd013422", + "ShortDescription": "spfx description", + "SkipDeploymentFeature": false, + "StoreAssetId": "", + "SupportsTeamsTabs": true, + "ThumbnailUrl": "", + "Title": "spfx-client-side-solution" + } + ``` + + + + + ```text + AadAppId : 48535560-3cc0-442e-a1b4-94c084b3ff59 + AadPermissions : Microsoft Graph, Directory.ReadWrite.All + AppCatalogVersion : 1.6.0.0 + CDNLocation : SharePoint Online + CanUpgrade : false + ContainsTenantWideExtension : false + CurrentVersionDeployed : true + Deployed : true + ErrorMessage : No errors. + ID : b05196d4-65a3-4ee3-bf92-4acfb7a05cd7 + InstalledVersion : + IsClientSideSolution : true + IsEnabled : true + IsPackageDefaultSkipFeatureDeployment: true + IsValidAppPackage : true + ProductId : 1e5954e2-fc1c-4501-8678-27a6bd013422 + ShortDescription : spfx description + SkipDeploymentFeature : false + StoreAssetId : + SupportsTeamsTabs : true + ThumbnailUrl : + Title : spfx-client-side-solution + ``` + + + + + ```csv + AadAppId,AadPermissions,AppCatalogVersion,CanUpgrade,CDNLocation,ContainsTenantWideExtension,CurrentVersionDeployed,Deployed,ErrorMessage,ID,InstalledVersion,IsClientSideSolution,IsEnabled,IsPackageDefaultSkipFeatureDeployment,IsValidAppPackage,ProductId,ShortDescription,SkipDeploymentFeature,StoreAssetId,SupportsTeamsTabs,ThumbnailUrl,Title + 48535560-3cc0-442e-a1b4-94c084b3ff59,"Microsoft Graph, Directory.ReadWrite.All",1.6.0.0,,SharePoint Online,,1,1,No errors.,b05196d4-65a3-4ee3-bf92-4acfb7a05cd7,,1,1,1,1,1e5954e2-fc1c-4501-8678-27a6bd013422,spfx description,,,1,,spfx-client-side-solution + ``` + + + + + ```md + # spo app get --id "b05196d4-65a3-4ee3-bf92-4acfb7a05cd7" + + Date: 10/2/2023 + + ## spfx-client-side-solution (b05196d4-65a3-4ee3-bf92-4acfb7a05cd7) + + Property | Value + ---------|------- + AadAppId | 48535560-3cc0-442e-a1b4-94c084b3ff59 + AadPermissions | Microsoft Graph, Directory.ReadWrite.All + AppCatalogVersion | 1.6.0.0 + CanUpgrade | false + CDNLocation | SharePoint Online + ContainsTenantWideExtension | false + CurrentVersionDeployed | true + Deployed | true + ErrorMessage | No errors. + ID | b05196d4-65a3-4ee3-bf92-4acfb7a05cd7 + InstalledVersion | + IsClientSideSolution | true + IsEnabled | true + IsPackageDefaultSkipFeatureDeployment | true + IsValidAppPackage | true + ProductId | 1e5954e2-fc1c-4501-8678-27a6bd013422 + ShortDescription | spfx description + SkipDeploymentFeature | false + StoreAssetId | + SupportsTeamsTabs | true + ThumbnailUrl | + Title | spfx-client-side-solution + ``` + + + + ## More information - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins) diff --git a/docs/docs/cmd/spo/app/app-install.mdx b/docs/docs/cmd/spo/app/app-install.mdx index 42fd06d6f49..00906f8428a 100644 --- a/docs/docs/cmd/spo/app/app-install.mdx +++ b/docs/docs/cmd/spo/app/app-install.mdx @@ -14,13 +14,13 @@ m365 spo app install [options] ```md definition-list `-i, --id ` -: ID of the app to install +: ID of the app to install. `-s, --siteUrl ` -: Absolute URL of the site to install the app in +: Absolute URL of the site to install the app in. `--appCatalogScope [appCatalogScope]` -: Scope of the app catalog: `tenant,sitecollection`. Default `tenant` +: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. ``` @@ -31,18 +31,22 @@ If the app with the specified ID doesn't exist in the app catalog, the command w ## Examples -Install the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ in the _https://contoso.sharepoint.com_ site. +Install the app with the specified ID in the specified site. ```sh m365 spo app install --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com ``` -Install the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ in the _https://contoso.sharepoint.com_ site from site collection app catalog. +Install the app with the specified ID in the specified site from site collection app catalog. ```sh m365 spo app install --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com --appCatalogScope sitecollection ``` +## Response + +The command won't return a response on success. + ## More information - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins) diff --git a/docs/docs/cmd/spo/app/app-instance-list.mdx b/docs/docs/cmd/spo/app/app-instance-list.mdx index 11a419a5c7b..342e8de6616 100644 --- a/docs/docs/cmd/spo/app/app-instance-list.mdx +++ b/docs/docs/cmd/spo/app/app-instance-list.mdx @@ -14,15 +14,96 @@ m365 spo app instance list [options] ```md definition-list `-u, --siteUrl ` -: URL of the site collection to retrieve the apps for +: URL of the site collection to retrieve the apps for. ``` ## Examples -Return a list of installed apps on site _https://contoso.sharepoint.com/sites/site1_. +Return a list of installed apps on the specified site. ```sh m365 spo app instance list --siteUrl https://contoso.sharepoint.com/sites/site1 ``` + +## Response + + + + + ```json + [ + { + "AppId": "03b4df10-320f-4d0f-8622-93822f9e0913", + "AppPrincipalId": "i:0i.t|ms.sp.int|82e6f5ac-b560-4b2a-9966-fd6f05514a1c@de348bc7-1aeb-4406-8cb3-97db021cadb4", + "AppSource": 2, + "AppStatus": 4, + "AppType": 3, + "AssetId": null, + "BaseTemplate": -1, + "ChildCount": -1, + "ContentMarket": null, + "CustomSettingsUrl": null, + "Description": "", + "IsCorporateCatalogSite": false, + "LastModified": "2022-07-15 06:00", + "LastModifiedDate": "2022-07-15T13:00:30.113Z", + "ProductId": "350f641f-cd1b-4274-819b-099f1ea66acc", + "Target": "", + "Thumbnail": "https://contoso.sharepoint.com/sites/site1/_layouts/15/images/spstorefrontappdefault.96x96x32.png", + "Title": "helloworld-client-side-solution", + "Version": "" + } + ] + ``` + + + + + ```text + Title AppId + ---------------------------------------------- ------------------------------------ + helloworld-client-side-solution 03b4df10-320f-4d0f-8622-93822f9e0913 + ``` + + + + + ```csv + AppId,AppPrincipalId,AppSource,AppStatus,AppType,BaseTemplate,ChildCount,Description,IsCorporateCatalogSite,LastModified,LastModifiedDate,ProductId,Target,Thumbnail,Title,Version + 03b4df10-320f-4d0f-8622-93822f9e0913,i:0i.t|ms.sp.int|82e6f5ac-b560-4b2a-9966-fd6f05514a1c@de348bc7-1aeb-4406-8cb3-97db021cadb4,2,4,3,-1,-1,,,2022-07-15 06:00,2022-07-15T13:00:30.113Z,350f641f-cd1b-4274-819b-099f1ea66acc,,https://contoso.sharepoint.com/sites/site1/_layouts/15/images/spstorefrontappdefault.96x96x32.png,helloworld-client-side-solution, + ``` + + + + + ```md + # spo app instance list --siteUrl "https://contoso.sharepoint.com/sites/site1" + + Date: 10/2/2023 + + ## helloworld-client-side-solution + + Property | Value + ---------|------- + AppId | 03b4df10-320f-4d0f-8622-93822f9e0913 + AppPrincipalId | i:0i.t\|ms.sp.int\|82e6f5ac-b560-4b2a-9966-fd6f05514a1c@de348bc7-1aeb-4406-8cb3-97db021cadb4 + AppSource | 2 + AppStatus | 4 + AppType | 3 + BaseTemplate | -1 + ChildCount | -1 + Description | + IsCorporateCatalogSite | false + LastModified | 2022-07-15 06:00 + LastModifiedDate | 2022-07-15T13:00:30.113Z + ProductId | 350f641f-cd1b-4274-819b-099f1ea66acc + Target | + Thumbnail | https://contoso.sharepoint.com/sites/site1/\_layouts/15/images/spstorefrontappdefault.96x96x32.png + Title | helloworld-client-side-solution + Version | + ``` + + + diff --git a/docs/docs/cmd/spo/app/app-list.mdx b/docs/docs/cmd/spo/app/app-list.mdx index f53a0c0e3af..5fbb3a38a0e 100644 --- a/docs/docs/cmd/spo/app/app-list.mdx +++ b/docs/docs/cmd/spo/app/app-list.mdx @@ -14,10 +14,10 @@ m365 spo app list [options] ```md definition-list `-s, --appCatalogScope [appCatalogScope]` -: Target app catalog. `tenant,sitecollection`. Default `tenant` +: Target app catalog. Possible values are: `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` +: URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection`. ``` @@ -38,12 +38,102 @@ Return the list of available apps from the tenant app catalog. Show the installe m365 spo app list ``` -Return the list of available apps from a site collection app catalog of site _https://contoso.sharepoint.com/sites/site1_. +Return the list of available apps from a site collection app catalog of the specified site. ```sh m365 spo app list --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1 ``` +## Response + + + + + ```json + [ + { + "AadAppId": "48535560-3cc0-442e-a1b4-94c084b3ff59", + "AadPermissions": "Microsoft Graph, Directory.ReadWrite.All", + "AppCatalogVersion": "1.6.0.0", + "CanUpgrade": false, + "CDNLocation": "SharePoint Online", + "ContainsTenantWideExtension": false, + "CurrentVersionDeployed": true, + "Deployed": true, + "ErrorMessage": "No errors.", + "ID": "b05196d4-65a3-4ee3-bf92-4acfb7a05cd7", + "InstalledVersion": "", + "IsClientSideSolution": true, + "IsEnabled": true, + "IsPackageDefaultSkipFeatureDeployment": true, + "IsValidAppPackage": true, + "ProductId": "1e5954e2-fc1c-4501-8678-27a6bd013422", + "ShortDescription": "spfx description", + "SkipDeploymentFeature": false, + "StoreAssetId": "", + "SupportsTeamsTabs": true, + "ThumbnailUrl": "", + "Title": "spfx-client-side-solution" + } + ] + ``` + + + + + ```text + Title ID Deployed AppCatalogVersion + ------------------------------------------------------------ ------------------------------------ -------- ----------------- + spfx-client-side-solution b05196d4-65a3-4ee3-bf92-4acfb7a05cd7 true 1.6.0.0 + ``` + + + + + ```csv + AadAppId,AppCatalogVersion,CanUpgrade,CDNLocation,ContainsTenantWideExtension,CurrentVersionDeployed,Deployed,ErrorMessage,ID,InstalledVersion,IsClientSideSolution,IsEnabled,IsPackageDefaultSkipFeatureDeployment,IsValidAppPackage,ProductId,ShortDescription,SkipDeploymentFeature,StoreAssetId,SupportsTeamsTabs,ThumbnailUrl,Title + 48535560-3cc0-442e-a1b4-94c084b3ff59,1.6.0.0,,SharePoint Online,,1,1,No errors.,b05196d4-65a3-4ee3-bf92-4acfb7a05cd7,,1,1,1,1,1e5954e2-fc1c-4501-8678-27a6bd013422,spfx description,,,1,,spfx-client-side-solution + ``` + + + + + ```md + # spo app list + + Date: 10/2/2023 + + ## spfx-client-side-solution (b05196d4-65a3-4ee3-bf92-4acfb7a05cd7) + + Property | Value + ---------|------- + AadAppId | 48535560-3cc0-442e-a1b4-94c084b3ff59 + AadPermissions | Microsoft Graph, Directory.ReadWrite.All + AppCatalogVersion | 1.6.0.0 + CanUpgrade | false + CDNLocation | SharePoint Online + ContainsTenantWideExtension | false + CurrentVersionDeployed | true + Deployed | true + ErrorMessage | No errors. + ID | b05196d4-65a3-4ee3-bf92-4acfb7a05cd7 + InstalledVersion | + IsClientSideSolution | true + IsEnabled | true + IsPackageDefaultSkipFeatureDeployment | true + IsValidAppPackage | true + ProductId | 1e5954e2-fc1c-4501-8678-27a6bd013422 + ShortDescription | spfx description + SkipDeploymentFeature | false + StoreAssetId | + SupportsTeamsTabs | true + ThumbnailUrl | + Title | spfx-client-side-solution + ``` + + + + ## More information - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins) diff --git a/docs/docs/cmd/spo/app/app-remove.mdx b/docs/docs/cmd/spo/app/app-remove.mdx index 130af804a23..23191bc2f62 100644 --- a/docs/docs/cmd/spo/app/app-remove.mdx +++ b/docs/docs/cmd/spo/app/app-remove.mdx @@ -14,16 +14,16 @@ m365 spo app remove [options] ```md definition-list `-i, --id ` -: ID of the app to remove. Needs to be available in the app catalog +: ID of the app to remove. Needs to be available in the app catalog. `-u, --appCatalogUrl [appCatalogUrl]` -: URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection` +: 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` +: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. `-f, --force` -: Don't prompt for confirming removing the app +: Don't prompt for confirming removing the app. ``` @@ -44,24 +44,28 @@ Remove the specified app from the tenant app catalog. Try to resolve the URL of m365 spo app remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 ``` -Remove the specified app from the tenant app catalog located at _https://contoso.sharepoint.com/sites/apps_. Additionally, will prompt for confirmation before actually retracting the app. +Remove the specified app from the tenant app catalog. Additionally, will prompt for confirmation before actually retracting the app. ```sh m365 spo app remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --appCatalogUrl https://contoso.sharepoint.com/sites/apps ``` -Remove the specified app from the tenant app catalog located at _https://contoso.sharepoint.com/sites/apps_. Don't prompt for confirmation. +Remove the specified app from the tenant app catalog. Don't prompt for confirmation. ```sh m365 spo app remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --appCatalogUrl https://contoso.sharepoint.com/sites/apps --force ``` -Remove the specified app from a site collection app catalog of site _https://contoso.sharepoint.com/sites/site1_. +Remove the specified app from a site collection app catalog of the specified site. ```sh m365 spo app remove --id d95f8c94-67a1-4615-9af8-361ad33be93c --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1/AppCatalog ``` +## Response + +The command won't return a response on success. + ## More information - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins) diff --git a/docs/docs/cmd/spo/app/app-retract.mdx b/docs/docs/cmd/spo/app/app-retract.mdx index 15cc2fd1cbe..99b66c570c6 100644 --- a/docs/docs/cmd/spo/app/app-retract.mdx +++ b/docs/docs/cmd/spo/app/app-retract.mdx @@ -17,13 +17,13 @@ m365 spo app retract [options] : ID of the app to retract. Needs to be available in the app catalog. `-u, --appCatalogUrl [appCatalogUrl]` -: URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection` +: 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` +: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. `-f, --force` -: Don't prompt for confirming retracting the app +: Don't prompt for confirming retracting the app. ``` @@ -44,7 +44,7 @@ Retract the specified app from the tenant app catalog. Try to resolve the URL of m365 spo app retract --id 058140e3-0e37-44fc-a1d3-79c487d371a3 ``` -Retract the specified app from the tenant app catalog located at _https://contoso.sharepoint.com/sites/apps_. Additionally, will prompt for confirmation before actually retracting the app. +Retract the specified app from the tenant app catalog. Additionally, will prompt for confirmation before actually retracting the app. ```sh m365 spo app retract --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --appCatalogUrl https://contoso.sharepoint.com/sites/apps @@ -56,12 +56,16 @@ Retract the specified app from the tenant app catalog. Try to resolve the URL of m365 spo app retract --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --force ``` -Retract the specified app from a site collection app catalog of site _https://contoso.sharepoint.com/sites/site1_. +Retract the specified app from a site collection app catalog of the specified site. ```sh m365 spo app retract --id d95f8c94-67a1-4615-9af8-361ad33be93c --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1 ``` +## Response + +The command won't return a response on success. + ## More information - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins) diff --git a/docs/docs/cmd/spo/app/app-teamspackage-download.mdx b/docs/docs/cmd/spo/app/app-teamspackage-download.mdx index ef1fedaf386..6bf227b0cdc 100644 --- a/docs/docs/cmd/spo/app/app-teamspackage-download.mdx +++ b/docs/docs/cmd/spo/app/app-teamspackage-download.mdx @@ -14,19 +14,19 @@ m365 spo app teamspackage download [options] ```md definition-list `--appItemUniqueId [appItemUniqueId]` -: The unique ID of the SPFx app to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName` +: The unique ID of the SPFx app to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName`. `--appItemId [appItemId]` -: The ID of the list item behind the SPFx app to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName` +: The ID of the list item behind the SPFx app to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName`. `--appName [appName]` -: The name of the sppkg file to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName` +: The name of the sppkg file to download the Teams package for. Specify `appItemUniqueId`, `appItemId` or `appName`. `--fileName [fileName]` -: Name of the file to save the package to. If not specified will use the name of the sppkg file with a `.zip` extension +: Name of the file to save the package to. If not specified will use the name of the sppkg file with a `.zip` extension. `-u, --appCatalogUrl [appCatalogUrl]` -: URL of the tenant app catalog. If not specified, the command will try to autodiscover it +: URL of the tenant app catalog. If not specified, the command will try to autodiscover it. ``` @@ -41,20 +41,24 @@ For maximum performance, specify the URL of the tenant app catalog, the item ID ## Examples -Downloads the Teams app package for the SPFx solution deployed to the tenant app catalog with the ID `1` to a file with .zip extension named after the .sppkg file: +Downloads the Teams app package for the SPFx solution deployed to the tenant app catalog with the specified ID to a file with .zip extension named after the .sppkg file. ```sh m365 spo app teamspackage download --appItemId 1 ``` -Downloads the Teams app package for the SPFx solution deployed to the tenant app catalog with the unique item ID `335a5612-3e85-462d-9d5b-c014b5abeac5` to the specified file: +Downloads the Teams app package for the SPFx solution deployed to the tenant app catalog with the specified unique item ID to the specified file. ```sh m365 spo app teamspackage download --appItemUniqueId 335a5612-3e85-462d-9d5b-c014b5abeac5 --fileName my-app.zip ``` -Downloads the Teams app package for the SPFx solution deployed to the specified tenant app catalog: +Downloads the Teams app package for the SPFx solution deployed to the specified tenant app catalog. ```sh m365 spo app teamspackage download --appName my-app.sppkg --appCatalogUrl https://contoso.sharepoint.com/sites/appcatalog ``` + +## Response + +The command won't return a response on success. diff --git a/docs/docs/cmd/spo/app/app-uninstall.mdx b/docs/docs/cmd/spo/app/app-uninstall.mdx index b779fd96887..ead65bb52ea 100644 --- a/docs/docs/cmd/spo/app/app-uninstall.mdx +++ b/docs/docs/cmd/spo/app/app-uninstall.mdx @@ -14,16 +14,16 @@ m365 spo app uninstall [options] ```md definition-list `-i, --id ` -: ID of the app to uninstall +: ID of the app to uninstall. `-s, --siteUrl ` -: Absolute URL of the site to uninstall the app from +: Absolute URL of the site to uninstall the app from. `--appCatalogScope [appCatalogScope]` -: Scope of the app catalog: `tenant,sitecollection`. Default `tenant` +: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. `-f, --force` -: Don't prompt for confirming uninstalling the app +: Don't prompt for confirming uninstalling the app. ``` @@ -34,24 +34,28 @@ If the app with the specified ID doesn't exist in the app catalog, the command w ## Examples -Uninstall the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ from the _https://contoso.sharepoint.com_ site. +Uninstall the app with the specified ID from the specified site. ```sh m365 spo app uninstall --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com ``` -Uninstall the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ from the _https://contoso.sharepoint.com_ site without prompting for confirmation. +Uninstall the app with the specified ID from the specified site without prompting for confirmation. ```sh m365 spo app uninstall --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com ``` -Uninstall the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ from the _https://contoso.sharepoint.com_ site where the app is deployed to the site collection app catalog of _https://contoso.sharepoint.com_. +Uninstall the app with the specified ID from the specified site where the app is deployed to the site collection app catalog. ```sh m365 spo app uninstall --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com --appCatalogScope sitecollection ``` +## Response + +The command won't return a response on success. + ## More information - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins) diff --git a/docs/docs/cmd/spo/app/app-upgrade.mdx b/docs/docs/cmd/spo/app/app-upgrade.mdx index 5d901482569..da2db46703b 100644 --- a/docs/docs/cmd/spo/app/app-upgrade.mdx +++ b/docs/docs/cmd/spo/app/app-upgrade.mdx @@ -14,13 +14,13 @@ m365 spo app upgrade [options] ```md definition-list `-i, --id ` -: ID of the app to upgrade +: ID of the app to upgrade. `-s, --siteUrl ` -: Absolute URL of the site to upgrade the app in +: Absolute URL of the site to upgrade the app in. `--appCatalogScope [appCatalogScope]` -: Scope of the app catalog: `tenant,sitecollection`. Default `tenant` +: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. ``` @@ -31,18 +31,22 @@ If the app with the specified ID doesn't exist in the app catalog, the command w ## Examples -Upgrade the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ in the _https://contoso.sharepoint.com_ site. +Upgrade the app with the specified ID in the specified site. ```sh m365 spo app upgrade --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com ``` -Upgrade the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ in the _https://contoso.sharepoint.com_ site from site collection app catalog. +Upgrade the app with the specified ID in the specified site from site collection app catalog. ```sh m365 spo app upgrade --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com --appCatalogScope sitecollection ``` +## Response + +The command won't return a response on success. + ## More information - Application Lifecycle Management (ALM) APIs: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins](https://docs.microsoft.com/en-us/sharepoint/dev/apis/alm-api-for-spfx-add-ins) diff --git a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx index df015e160e2..15792af5064 100644 --- a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx +++ b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx @@ -2,7 +2,7 @@ import Global from '/docs/cmd/_global.mdx'; # spo applicationcustomizer add -Add an application customizer to a site. +Add an application customizer to a site ## Usage @@ -23,7 +23,7 @@ m365 spo applicationcustomizer add [options] : Client-side component ID of the application customizer (GUID). `--clientSideComponentProperties [clientSideComponentProperties]` -: JSON string with application customizer properties +: JSON string with application customizer properties. `-s, --scope [scope]` : Scope of the application customizer. Allowed values: `Site`, `Web`. Defaults to `Site`. diff --git a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx index 06f598a61e8..d908603ba05 100644 --- a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +++ b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx @@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem'; # spo applicationcustomizer get -Get an application customizer that is added to a site. +Get an application customizer that is added to a site ## Usage @@ -19,13 +19,13 @@ m365 spo applicationcustomizer get [options] : URL of the site. `-t, --title [title]` -: The title of the Application Customizer. Specify either `title`, `id`, or `clientSideComponentId`. +: 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`. +: 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`. +: 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`. @@ -125,7 +125,7 @@ m365 spo applicationcustomizer get --title "Some customizer" --webUrl https://co ```md - # spo applicationcustomizer get --title "Some customizer" --webUrl "https://nachan365.sharepoint.com/sites/spdemo" --scope "Web" + # spo applicationcustomizer get --title "Some customizer" --webUrl "https://contoso.sharepoint.com/sites/sales" --scope "Web" Date: 3/6/2023 @@ -156,4 +156,3 @@ m365 spo applicationcustomizer get --title "Some customizer" --webUrl https://co - diff --git a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx index 04ca2896d90..da21e9ddad5 100644 --- a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +++ b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx @@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem'; # spo applicationcustomizer list -Get a list of application customizers that are added to a site. +Get a list of application customizers that are added to a site ## Usage @@ -19,7 +19,7 @@ m365 spo applicationcustomizer list [options] : The url of the site. `-s, --scope [scope]` -: Scope of the application customizers. Allowed values `Site`, `Web`, `All`. Defaults to `All` +: Scope of the application customizers. Allowed values `Site`, `Web`, `All`. Defaults to `All`. ``` @@ -120,4 +120,3 @@ m365 spo applicationcustomizer list --webUrl https://contoso.sharepoint.com/site - diff --git a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.mdx b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.mdx index 96fba89c66f..0698dca3b6f 100644 --- a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.mdx +++ b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-remove.mdx @@ -40,37 +40,37 @@ If the command finds multiple application customizers with the specified title o ## Examples -Remove an application customizer by id +Remove an application customizer by id. ```sh m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales ``` -Remove an application customizer by title +Remove an application customizer by title. ```sh m365 spo applicationcustomizer remove --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales ``` -Remove an application customizer by clientSideComponentId +Remove an application customizer by clientSideComponentId. ```sh m365 spo applicationcustomizer remove --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales ``` -Remove an application customizer by its id without prompting for confirmation +Remove an application customizer by its id without prompting for confirmation. ```sh m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --force ``` -Remove an application customizer from a site collection by its id without prompting for confirmation +Remove an application customizer from a site collection by its id without prompting for confirmation. ```sh m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --force --scope Site ``` -Remove an application customizer from a site by its id without prompting for confirmation +Remove an application customizer from a site by its id without prompting for confirmation. ```sh m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --force --scope Web diff --git a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx index 0cb696a73c4..9ff02f73741 100644 --- a/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx +++ b/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx @@ -55,13 +55,13 @@ When using the `--clientSideComponentProperties` option it's possible to enter a ## Examples -Updates the title of an application customizer on the sales site +Updates the title of an application customizer on the sales site. ```sh m365 spo applicationcustomizer set --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --newTitle "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales ``` -Updates the properties of an application customizer on the sales site +Updates the properties of an application customizer on the sales site. ```sh m365 spo applicationcustomizer set --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{ "testMessage": "Test message" }' --webUrl https://contoso.sharepoint.com/sites/sales diff --git a/docs/docs/cmd/spo/apppage/apppage-add.mdx b/docs/docs/cmd/spo/apppage/apppage-add.mdx index 0eb13c4ac56..0fbb280583c 100644 --- a/docs/docs/cmd/spo/apppage/apppage-add.mdx +++ b/docs/docs/cmd/spo/apppage/apppage-add.mdx @@ -14,16 +14,16 @@ m365 spo apppage add [options] ```md definition-list `-u, --webUrl ` -: The URL of the site where the page should be created +: The URL of the site where the page should be created. `-t, --title ` -: The title of the page to be created +: The title of the page to be created. `-d, --webPartData <webPartData>` -: JSON string of the web part to put on the page +: JSON string of the web part to put on the page. `--addToQuickLaunch` -: Set, to add the page to the quick launch +: Set, to add the page to the quick launch. ``` <Global /> @@ -34,8 +34,55 @@ If you want to add the single-part app page to quick launch, use the addToQuickL ## Examples -Create a single-part app page in a site with url https://contoso.sharepoint.com, webpart data is stored in the `$webPartData` variable +Create a single-part app page in the specified site, webpart data is stored in the `$webPartData` variable ```sh m365 spo apppage add --title "Contoso" --webUrl "https://contoso.sharepoint.com" --webPartData $webPartData --addToQuickLaunch ``` + + +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + { + "value": "SitePages/Contoso.aspx" + } + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + value: SitePages/Contoso.aspx + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + value + SitePages/Contoso.aspx + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + # spo apppage add --title "Contoso" --webUrl "https://contoso.sharepoint.com/sites/sales" --webPartData "{"id": "62ca + c389-787f-495d-beca-e11786162ef4", "instanceId": "9c6edb6e-199a-4a30-a3b6-73466a68187b", "title": "Full App Page Countdo + wn Timer", "description": "This web part is used to allow a site admin to count down/up to an important event.", "dataVe + rsion": "1.0", "properties": { "showButton": false, "countDate": "Mon May 13 2019 14:00:00 GMT+0100", "title": "My count + down", "description": "", "countDirection": "COUNT_DOWN", "dateDisplay": "DAY_HOUR_MINUTE_SECOND", "buttonText": ""}}" + + Date: 10/2/2023 + + Property | Value + ---------|------- + value | SitePages/Contoso.aspx + ``` + + </TabItem> +</Tabs> diff --git a/docs/docs/cmd/spo/apppage/apppage-set.mdx b/docs/docs/cmd/spo/apppage/apppage-set.mdx index e6589401dfe..60ffcd6f512 100644 --- a/docs/docs/cmd/spo/apppage/apppage-set.mdx +++ b/docs/docs/cmd/spo/apppage/apppage-set.mdx @@ -14,21 +14,25 @@ m365 spo apppage set [options] ```md definition-list `-u, --webUrl <webUrl>` -: The URL of the site where the page to update is located +: The URL of the site where the page to update is located. `-n, --name <name>` -: The name of the page to be updated, eg. page.aspx +: The name of the page to be updated, eg. page.aspx. `-d, --webPartData <webPartData>` -: JSON string of the web part to update on the page +: JSON string of the web part to update on the page. ``` <Global /> ## Examples -Updates the single-part app page located in a site with url https://contoso.sharepoint.com. Web part data is stored in the `$webPartData` variable +Updates the single-part app page located in a specified site. Web part data is stored in the `$webPartData` variable. ```sh m365 spo apppage set --webUrl "https://contoso.sharepoint.com" --name "Contoso.aspx" --webPartData $webPartData ``` + +## Response + +The command won't return a response on success. diff --git a/docs/docs/cmd/spo/cdn/cdn-get.mdx b/docs/docs/cmd/spo/cdn/cdn-get.mdx index 0876bfb466d..4e41dbcf0c8 100644 --- a/docs/docs/cmd/spo/cdn/cdn-get.mdx +++ b/docs/docs/cmd/spo/cdn/cdn-get.mdx @@ -14,7 +14,7 @@ m365 spo cdn get [options] ```md definition-list `-t, --type [type]` -: Type of CDN to manage. Allowed values `Public`, `Private`. Default `Public`. +: Type of CDN to manage. Allowed values are: `Public`, `Private`. Default `Public`. ``` <Global /> @@ -43,6 +43,39 @@ Show if the Private CDN is currently enabled or not. m365 spo cdn get --type Private ``` +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + true + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + true + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + true + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + true + ``` + + </TabItem> +</Tabs> + ## More information - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide) diff --git a/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx b/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx index 2b6584ba80d..ec5a30a8f05 100644 --- a/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +++ b/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx @@ -14,10 +14,10 @@ m365 spo cdn origin add [options] ```md definition-list `-t, --type [type]` -: Type of CDN to manage. `Public,Private`. Default `Public` +: Type of CDN to manage. Allowed values are: `Public`, `Private`. Default `Public`. `-r, --origin <origin>` -: Origin to add to the current CDN configuration +: Origin to add to the current CDN configuration. ``` <Global /> @@ -34,12 +34,16 @@ To use this command you have to have permissions to access the tenant admin site ## Examples -Add _*/CDN_ to the list of origins of the Public CDN +Add _*/CDN_ to the list of origins of the Public CDN. ```sh m365 spo cdn origin add --type Public --origin */CDN ``` +## Response + +The command won't return a response on success. + ## More information - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide) diff --git a/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx b/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx index a9fc71810ed..2450d4445b2 100644 --- a/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +++ b/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx @@ -14,7 +14,7 @@ m365 spo cdn origin list [options] ```md definition-list `-t, --type [type]` -: Type of CDN to manage. `Public,Private`. Default `Public` +: Type of CDN to manage. Allowed values are: `Public`, `Private`. Default `Public`. ``` <Global /> @@ -31,18 +31,61 @@ To use this command you have to have permissions to access the tenant admin site ## Examples -Show the list of origins configured for the Public CDN +Show the list of origins configured for the Public CDN. ```sh m365 spo cdn origin list ``` -Show the list of origins configured for the Private CDN +Show the list of origins configured for the Private CDN. ```sh m365 spo cdn origin list --type Private ``` +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + [ + "*/MASTERPAGE", + "*/STYLE LIBRARY", + "*/CLIENTSIDEASSETS" + ] + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + */MASTERPAGE + */STYLE LIBRARY + */CLIENTSIDEASSETS + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + */MASTERPAGE + */STYLE LIBRARY + */CLIENTSIDEASSETS + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + */MASTERPAGE + */STYLE LIBRARY + */CLIENTSIDEASSETS + ``` + + </TabItem> +</Tabs> + ## More information - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide) diff --git a/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx b/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx index 7ba26c784c7..9d86dbf6c79 100644 --- a/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +++ b/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx @@ -14,13 +14,13 @@ m365 spo cdn origin remove [options] ```md definition-list `-t, --type [type]` -: Type of CDN to manage. `Public,Private`. Default `Public` +: Type of CDN to manage. Allowed values are: `Public`, `Private`. Default `Public`. `-r, --origin <origin>` -: Origin to remove from the current CDN configuration +: Origin to remove from the current CDN configuration. `-f, --force` -: Don't prompt for confirming removal of a tenant property +: Don't prompt for confirming removal of a tenant property. ``` <Global /> @@ -37,12 +37,16 @@ To use this command you have to have permissions to access the tenant admin site ## Examples -Remove _*/CDN_ from the list of origins of the Public CDN +Remove _*/CDN_ from the list of origins of the Public CDN. ```sh m365 spo cdn origin remove --type Public --origin */CDN ``` +## Response + +The command won't return a response on success. + ## More information - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide) diff --git a/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx b/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx index 6ee32ab22fc..b7a60e6250f 100644 --- a/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +++ b/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx @@ -14,7 +14,7 @@ m365 spo cdn policy list [options] ```md definition-list `-t, --cdnType [cdnType]` -: Type of CDN to manage. `Public,Private`. Default `Public` +: Type of CDN to manage. Allowed values are: `Public`, `Private`. Default `Public`. ``` <Global /> @@ -31,18 +31,66 @@ To use this command you have to have permissions to access the tenant admin site ## Examples -Show the list of policies configured for the Public CDN +Show the list of policies configured for the Public CDN. ```sh m365 spo cdn policy list ``` -Show the list of policies configured for the Private CDN +Show the list of policies configured for the Private CDN. ```sh m365 spo cdn policy list --cdnType Private ``` +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + [ + { + "Policy": "IncludeFileExtensions", + "Value": "CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF,JSON" + } + ] + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + Policy Value + ------------------------------------ ----------------------------------------------------- + IncludeFileExtensions CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF,JSON + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + Policy,Value + IncludeFileExtensions,"CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF,JSON" + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + # spo cdn policy list + + Date: 10/2/2023 + + Property | Value + ---------|------- + Policy | IncludeFileExtensions + Value | CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF,JSON + ``` + + </TabItem> +</Tabs> + ## More information - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide) diff --git a/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx b/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx index c6a22ff90c8..906cdad9400 100644 --- a/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +++ b/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx @@ -14,13 +14,13 @@ m365 spo cdn policy set [options] ```md definition-list `-t, --cdnType [cdnType]` -: Type of CDN to manage. `Public,Private`. Default `Public` +: Type of CDN to manage. Allowed values are: `Public`, `Private`. Default `Public`. `-p, --policy <policy>` -: CDN policy to configure. `IncludeFileExtensions|ExcludeRestrictedSiteClassifications` +: CDN policy to configure. Allowed values are: `IncludeFileExtensions`, `ExcludeRestrictedSiteClassifications`. `-v, --value <value>` -: Value for the policy to configure +: Value for the policy to configure. ``` <Global /> @@ -43,6 +43,10 @@ Set the list of extensions supported by the Public CDN m365 spo cdn policy set --cdnType Public --policy IncludeFileExtensions --value CSS,EOT,GIF,ICO,JPEG,JPG,JS,MAP,PNG,SVG,TTF,WOFF,JSON ``` +## Response + +The command won't return a response on success. + ## More information - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide) diff --git a/docs/docs/cmd/spo/cdn/cdn-set.mdx b/docs/docs/cmd/spo/cdn/cdn-set.mdx index 8000232635f..78a25abe05a 100644 --- a/docs/docs/cmd/spo/cdn/cdn-set.mdx +++ b/docs/docs/cmd/spo/cdn/cdn-set.mdx @@ -14,13 +14,13 @@ m365 spo cdn set [options] ```md definition-list `-e, --enabled <enabled>` -: Set to true to enable CDN or to false to disable it. Valid values are `true,false` +: Set to true to enable CDN or to false to disable it. Valid values are `true`, `false`. `-t, --type [type]` -: Type of CDN to manage. `Public`, `Private`, `Both`. Default `Public` +: Type of CDN to manage. Possible values are: `Public`, `Private`, `Both`. Default `Public`. `--noDefaultOrigins` -: pass to not create the default Origins +: pass to not create the default origins. ``` <Global /> @@ -71,6 +71,10 @@ Enable the Microsoft 365 Private and Public CDN on the current tenant without de m365 spo cdn set --type Both --enabled true --noDefaultOrigins ``` +## Response + +The command won't return a response on success. + ## More information - Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide) diff --git a/docs/docs/cmd/spo/commandset/commandset-add.mdx b/docs/docs/cmd/spo/commandset/commandset-add.mdx index 21f79650e84..2190d7cf04c 100644 --- a/docs/docs/cmd/spo/commandset/commandset-add.mdx +++ b/docs/docs/cmd/spo/commandset/commandset-add.mdx @@ -16,13 +16,13 @@ m365 spo commandset add [options] ```md definition-list `-t, --title <title>` -: The title of the ListView Command Set +: The title of the ListView Command Set. `-u, --webUrl <webUrl>` : The site to add the ListView Command Set. `-l, --listType <listType>` -: The list or library type to register the Command Set on. Allowed values `List`, `Library` or `SitePages`. +: The list or library type to register the Command Set on. Allowed values are: `List`, `Library` or `SitePages`. `-i, --clientSideComponentId <clientSideComponentId>` : The Client Side Component Id (GUID) of the ListView Command Set. @@ -31,10 +31,10 @@ m365 spo commandset add [options] : The Client Side Component properties of the ListView Command Set. `-s, --scope [scope]` -: Scope of the ListView Command Set. Allowed values: `Site`, `Web`. Defaults to `Web`. +: Scope of the ListView Command Set. Allowed values are: `Site`, `Web`. Defaults to `Web`. `--location [location]` -: The location of the ListView Command Set. Allowed values `ContextMenu`, `CommandBar` or `Both`. Defaults to `CommandBar`. +: The location of the ListView Command Set. Allowed values are: `ContextMenu`, `CommandBar` or `Both`. Defaults to `CommandBar`. ``` <Global /> diff --git a/docs/docs/cmd/spo/commandset/commandset-list.mdx b/docs/docs/cmd/spo/commandset/commandset-list.mdx index e0cb6413a24..ce0f49f1196 100644 --- a/docs/docs/cmd/spo/commandset/commandset-list.mdx +++ b/docs/docs/cmd/spo/commandset/commandset-list.mdx @@ -19,7 +19,7 @@ m365 spo commandset list [options] : The url of the site. `-s, --scope [scope]` -: Scope of the ListView Command Sets. Allowed values `Site`, `Web`, `All`. Default to `All` +: Scope of the ListView Command Sets. Allowed values are: `Site`, `Web`, `All`. Default to `All` ``` <Global /> diff --git a/docs/docs/cmd/spo/commandset/commandset-remove.mdx b/docs/docs/cmd/spo/commandset/commandset-remove.mdx index 5bbb6b20d96..9a1f029b55e 100644 --- a/docs/docs/cmd/spo/commandset/commandset-remove.mdx +++ b/docs/docs/cmd/spo/commandset/commandset-remove.mdx @@ -26,10 +26,10 @@ m365 spo commandset remove [options] : The id of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`. `-s, --scope [scope]` -: Scope of the ListView Command Set. Allowed values: `Site`, `Web`, `All`. Defaults to `All`. +: Scope of the ListView Command Set. Allowed values are: `Site`, `Web`, `All`. Defaults to `All`. `-f, --force` -: Don't prompt for confirming removal of the ListView Command Set +: Don't prompt for confirming removal of the ListView Command Set. ``` <Global /> diff --git a/docs/docs/cmd/spo/commandset/commandset-set.mdx b/docs/docs/cmd/spo/commandset/commandset-set.mdx index fb9235d8dfc..7dda545101e 100644 --- a/docs/docs/cmd/spo/commandset/commandset-set.mdx +++ b/docs/docs/cmd/spo/commandset/commandset-set.mdx @@ -32,16 +32,16 @@ m365 spo commandset set [options] : The new title of the ListView Command Set. `-l, --listType [listType]` -: The list or library type to register the Command Set on. Allowed values `List`, `Library` or `SitePages`. +: The list or library type to register the Command Set on. Allowed values are: `List`, `Library` or `SitePages`. `--clientSideComponentProperties [clientSideComponentProperties]` : The Client Side Component properties of the ListView Command Set. `-s, --scope [scope]` -: The scope where to lookup the ListView Command Set: at site level or web level. Allowed values: `Site`, `Web`, `All`. Defaults to `All`. +: The scope where to lookup the ListView Command Set: at site level or web level. Allowed values are: `Site`, `Web`, `All`. Defaults to `All`. `--location [location]` -: The location of the ListView Command Set. Allowed values `ContextMenu`, `CommandBar` or `Both`. +: The location of the ListView Command Set. Allowed values are: `ContextMenu`, `CommandBar` or `Both`. ``` <Global /> diff --git a/docs/docs/cmd/spo/contenttype/contenttype-add.mdx b/docs/docs/cmd/spo/contenttype/contenttype-add.mdx index c776613a3a4..688d08ab404 100644 --- a/docs/docs/cmd/spo/contenttype/contenttype-add.mdx +++ b/docs/docs/cmd/spo/contenttype/contenttype-add.mdx @@ -14,7 +14,7 @@ m365 spo contenttype add [options] ```md definition-list `-u, --webUrl <webUrl>` -: Absolute URL of the site where the content type should be created +: Absolute URL of the site where the content type should be created. `-l, --listTitle [listTitle]` : Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`. @@ -26,16 +26,16 @@ m365 spo contenttype add [options] : 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. Determines the parent content type +: The ID of the content type. Determines the parent content type. `-n, --name <name>` -: The name of the content type +: The name of the content type. `-d, --description [description]` -: The description of the content type +: The description of the content type. `-g, --group [group]` -: The group with which the content type should be associated +: The group with which the content type should be associated. ``` <Global /> @@ -48,30 +48,167 @@ The ID of the content type specifies the parent content type from which this con ## Examples -Create a site content type that inherits from the List item content type +Create a site content type that inherits from the List item content type. ```sh m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D --group 'PnP Content Types' ``` -Create a list (retrieved by Title) content type that inherits from the List item content type +Create a list (retrieved by Title) content type that inherits from the List item content type. ```sh m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Alerts --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D ``` -Create a list (retrieved by ID) content type that inherits from the List item content type +Create a list (retrieved by ID) content type that inherits from the List item content type. ```sh m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D ``` -Create a list (retrieved by URL) content type that inherits from the List item content type +Create a list (retrieved by URL) content type that inherits from the List item content type. ```sh m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D ``` +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + { + "ClientFormCustomFormatter": "", + "Description": "Create a new list item.", + "DisplayFormClientSideComponentId": "", + "DisplayFormClientSideComponentProperties": "", + "DisplayFormTarget": 0, + "DisplayFormTemplateName": "ListForm", + "DisplayFormUrl": "", + "DocumentTemplate": "", + "DocumentTemplateUrl": "", + "EditFormClientSideComponentId": "", + "EditFormClientSideComponentProperties": "", + "EditFormTarget": 0, + "EditFormTemplateName": "ListForm", + "EditFormUrl": "", + "Group": "PnP Content Types", + "Hidden": false, + "Id": { + "StringValue": "0x01007926A45D687BA842B947286090B8F67D" + }, + "JSLink": "", + "MobileDisplayFormUrl": "", + "MobileEditFormUrl": "", + "MobileNewFormUrl": "", + "Name": "PnP Alert", + "NewFormClientSideComponentId": null, + "NewFormClientSideComponentProperties": "", + "NewFormTarget": 0, + "NewFormTemplateName": "ListForm", + "NewFormUrl": "", + "ReadOnly": false, + "SchemaXml": "<ContentType ID=\"0x01007926A45D687BA842B947286090B8F67D\" Name=\"PnP Alert\" Group=\"PnP Content Types\" Description=\"Create a new list item.\" Version=\"0\"><Folder TargetName=\"_cts/PnP Alert\" /><Fields><Field ID=\"{c042a256-787d-4a6f-8a8a-cf6ab767f12d}\" Name=\"ContentType\" SourceID=\"http://schemas.microsoft.com/sharepoint/v3\" StaticName=\"ContentType\" Group=\"_Hidden\" Type=\"Computed\" DisplayName=\"Content Type\" Sealed=\"TRUE\" Sortable=\"FALSE\" RenderXMLUsingPattern=\"TRUE\" PITarget=\"MicrosoftWindowsSharePointServices\" PIAttribute=\"ContentTypeID\" DelayActivateTemplateBinding=\"GROUP,SPSPERS,SITEPAGEPUBLISHING\" Customization=\"\"><FieldRefs><FieldRef ID=\"{03e45e84-1992-4d42-9116-26f756012634}\" Name=\"ContentTypeId\" /></FieldRefs><DisplayPattern><MapToContentType><Column Name=\"ContentTypeId\" /></MapToContentType></DisplayPattern></Field><Field ID=\"{fa564e0f-0c70-4ab9-b863-0177e6ddd247}\" Name=\"Title\" SourceID=\"http://schemas.microsoft.com/sharepoint/v3\" StaticName=\"Title\" Group=\"_Hidden\" Type=\"Text\" DisplayName=\"Title\" Required=\"TRUE\" FromBaseType=\"TRUE\" DelayActivateTemplateBinding=\"GROUP,SPSPERS,SITEPAGEPUBLISHING\" Customization=\"\" ShowInNewForm=\"TRUE\" ShowInEditForm=\"TRUE\"></Field></Fields><XmlDocuments><XmlDocument NamespaceURI=\"http://schemas.microsoft.com/sharepoint/v3/contenttype/forms\"><FormTemplates xmlns=\"http://schemas.microsoft.com/sharepoint/v3/contenttype/forms\"><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType>", + "Scope": "/sites/contoso-sales", + "Sealed": false, + "StringId": "0x01007926A45D687BA842B947286090B8F67D" + } + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + ClientFormCustomFormatter : + Description : Create a new list item. + DisplayFormClientSideComponentId : + DisplayFormClientSideComponentProperties: + DisplayFormTarget : 0 + DisplayFormTemplateName : ListForm + DisplayFormUrl : + DocumentTemplate : + DocumentTemplateUrl : + EditFormClientSideComponentId : + EditFormClientSideComponentProperties : + EditFormTarget : 0 + EditFormTemplateName : ListForm + EditFormUrl : + Group : PnP Content Types + Hidden : false + Id : {"StringValue":"0x01007926A45D687BA842B947286090B8F67D"} + JSLink : + MobileDisplayFormUrl : + MobileEditFormUrl : + MobileNewFormUrl : + Name : PnP Alert + NewFormClientSideComponentId : null + NewFormClientSideComponentProperties : + NewFormTarget : 0 + NewFormTemplateName : ListForm + NewFormUrl : + ReadOnly : false + SchemaXml : <ContentType ID="0x01007926A45D687BA842B947286090B8F67D" Name="PnP Alert" Group="PnP Content Types" Description="Create a new list item." Version="0"><Folder TargetName="_cts/PnP Alert" /><Fields><Field ID="{c042a256-787d-4a6f-8a8a-cf6ab767f12d}" Name="ContentType" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentType" Group="_Hidden" Type="Computed" DisplayName="Content Type" Sealed="TRUE" Sortable="FALSE" RenderXMLUsingPattern="TRUE" PITarget="MicrosoftWindowsSharePointServices" PIAttribute="ContentTypeID" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization=""><FieldRefs><FieldRef ID="{03e45e84-1992-4d42-9116-26f756012634}" Name="ContentTypeId" /></FieldRefs><DisplayPattern><MapToContentType><Column Name="ContentTypeId" /></MapToContentType></DisplayPattern></Field><Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Name="Title" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" Group="_Hidden" Type="Text" DisplayName="Title" Required="TRUE" FromBaseType="TRUE" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization="" ShowInNewForm="TRUE" ShowInEditForm="TRUE"></Field></Fields><XmlDocuments><XmlDocument NamespaceURI="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><FormTemplates xmlns="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType> + Scope : /sites/contoso-sales + Sealed : false + StringId : 0x01007926A45D687BA842B947286090B8F67D + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + ClientFormCustomFormatter,Description,DisplayFormClientSideComponentId,DisplayFormClientSideComponentProperties,DisplayFormTarget,DisplayFormTemplateName,DisplayFormUrl,DocumentTemplate,DocumentTemplateUrl,EditFormClientSideComponentId,EditFormClientSideComponentProperties,EditFormTarget,EditFormTemplateName,EditFormUrl,Group,Hidden,JSLink,MobileDisplayFormUrl,MobileEditFormUrl,MobileNewFormUrl,Name,NewFormClientSideComponentProperties,NewFormTarget,NewFormTemplateName,NewFormUrl,ReadOnly,SchemaXml,Scope,Sealed,StringId + ,Create a new list item.,,,0,ListForm,,,,,,0,ListForm,,PnP Content Types,,,,,,PnP Alert,,0,ListForm,,,"<ContentType ID=""0x01007926A45D687BA842B947286090B8F67D"" Name=""PnP Alert"" Group=""PnP Content Types"" Description=""Create a new list item."" Version=""0""><Folder TargetName=""_cts/PnP Alert"" /><Fields><Field ID=""{c042a256-787d-4a6f-8a8a-cf6ab767f12d}"" Name=""ContentType"" SourceID=""http://schemas.microsoft.com/sharepoint/v3"" StaticName=""ContentType"" Group=""_Hidden"" Type=""Computed"" DisplayName=""Content Type"" Sealed=""TRUE"" Sortable=""FALSE"" RenderXMLUsingPattern=""TRUE"" PITarget=""MicrosoftWindowsSharePointServices"" PIAttribute=""ContentTypeID"" DelayActivateTemplateBinding=""GROUP,SPSPERS,SITEPAGEPUBLISHING"" Customization=""""><FieldRefs><FieldRef ID=""{03e45e84-1992-4d42-9116-26f756012634}"" Name=""ContentTypeId"" /></FieldRefs><DisplayPattern><MapToContentType><Column Name=""ContentTypeId"" /></MapToContentType></DisplayPattern></Field><Field ID=""{fa564e0f-0c70-4ab9-b863-0177e6ddd247}"" Name=""Title"" SourceID=""http://schemas.microsoft.com/sharepoint/v3"" StaticName=""Title"" Group=""_Hidden"" Type=""Text"" DisplayName=""Title"" Required=""TRUE"" FromBaseType=""TRUE"" DelayActivateTemplateBinding=""GROUP,SPSPERS,SITEPAGEPUBLISHING"" Customization="""" ShowInNewForm=""TRUE"" ShowInEditForm=""TRUE""></Field></Fields><XmlDocuments><XmlDocument NamespaceURI=""http://schemas.microsoft.com/sharepoint/v3/contenttype/forms""><FormTemplates xmlns=""http://schemas.microsoft.com/sharepoint/v3/contenttype/forms""><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType>",/sites/contoso-sales,,0x01007926A45D687BA842B947286090B8F67D + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + # spo contenttype add --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --name "PnP Alert" --id "0x01007926A45D687BA842B947286090B8F67D" --group "PnP Content Types" + + Date: 10/2/2023 + + ## PnP Alert ([object Object]) + + Property | Value + ---------|------- + ClientFormCustomFormatter | + Description | Create a new list item. + DisplayFormClientSideComponentId | + DisplayFormClientSideComponentProperties | + DisplayFormTarget | 0 + DisplayFormTemplateName | ListForm + DisplayFormUrl | + DocumentTemplate | + DocumentTemplateUrl | + EditFormClientSideComponentId | + EditFormClientSideComponentProperties | + EditFormTarget | 0 + EditFormTemplateName | ListForm + EditFormUrl | + Group | PnP Content Types + Hidden | false + JSLink | + MobileDisplayFormUrl | + MobileEditFormUrl | + MobileNewFormUrl | + Name | PnP Alert + NewFormClientSideComponentProperties | + NewFormTarget | 0 + NewFormTemplateName | ListForm + NewFormUrl | + ReadOnly | false + SchemaXml | <ContentType ID="0x01007926A45D687BA842B947286090B8F67D" Name="PnP Alert" Group="PnP Content Types" Description="Create a new list item." Version="0"><Folder TargetName="\_cts/PnP Alert" /><Fields><Field ID="{c042a256-787d-4a6f-8a8a-cf6ab767f12d}" Name="ContentType" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentType" Group="\_Hidden" Type="Computed" DisplayName="Content Type" Sealed="TRUE" Sortable="FALSE" RenderXMLUsingPattern="TRUE" PITarget="MicrosoftWindowsSharePointServices" PIAttribute="ContentTypeID" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization=""><FieldRefs><FieldRef ID="{03e45e84-1992-4d42-9116-26f756012634}" Name="ContentTypeId" /></FieldRefs><DisplayPattern><MapToContentType><Column Name="ContentTypeId" /></MapToContentType></DisplayPattern></Field><Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Name="Title" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" Group="\_Hidden" Type="Text" DisplayName="Title" Required="TRUE" FromBaseType="TRUE" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization="" ShowInNewForm="TRUE" ShowInEditForm="TRUE"></Field></Fields><XmlDocuments><XmlDocument NamespaceURI="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><FormTemplates xmlns="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType> + Scope | /sites/contoso-sales + Sealed | false + StringId | 0x01007926A45D687BA842B947286090B8F67D + ``` + + </TabItem> +</Tabs> + ## More information - Content Type IDs: [https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14)](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14)) diff --git a/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx b/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx index b99f989a622..0da9ab679c5 100644 --- a/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +++ b/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx @@ -2,7 +2,7 @@ import Global from '/docs/cmd/_global.mdx'; # spo contenttype field remove -Removes a column from a site- or list content type +Removes a column from a site or list content type ## Usage @@ -14,7 +14,7 @@ m365 spo contenttype field remove [options] ```md definition-list `-u, --webUrl <webUrl>` -: Absolute URL of the site where the content type is located +: 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`. @@ -26,16 +26,16 @@ m365 spo contenttype field remove [options] : Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`. `-i, --contentTypeId <contentTypeId>` -: The ID of the content type to remove the column from +: The ID of the content type to remove the column from. `--fieldLinkId <fieldLinkId>` -: The ID of the column to remove +: The ID of the column to remove. `-c, --updateChildContentTypes` -: Update child content types +: Update child content types. `-f, --force` -: Don't prompt for confirming removal of a column from content type +: Don't prompt for confirming removal of a column from content type. ``` <Global /> @@ -45,29 +45,33 @@ m365 spo contenttype field remove [options] Remove column with a specific ID from a content type with a specific ID from a specific site. ```sh -m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --force +m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --force ``` -Remove column with a specific ID from a content type with a specific ID from a specific site and updating the child content types +Remove column with a specific ID from a content type with a specific ID from a specific site and updating the child content types. ```sh -m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --updateChildContentTypes +m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --updateChildContentTypes ``` -Remove fieldLink with a specific ID from a list (obtained by Title) content type with a specific ID on a spefici site. +Remove fieldLink with a specific ID from a list (obtained by Title) content type with a specific ID on a specific site. ```sh -m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listTitle "Documents" +m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listTitle "Documents" ``` -Remove fieldLink with a specific ID from a list (obtained by ID) content type with a specific ID on a spefici site. +Remove fieldLink with a specific ID from a list (obtained by ID) content type with a specific ID on a specific site. ```sh -m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listId "8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c" +m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listId "8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c" ``` -Remove fieldLink with a specific ID from a list (obtained by URL) content type with a specific ID on a spefici site. +Remove fieldLink with a specific ID from a list (obtained by URL) content type with a specific ID on a specific site. ```sh -m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listUrl "/shared documents" +m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listUrl "/shared documents" ``` + +## Response + +The command won't return a response on success. diff --git a/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx b/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx index 27f02ed216c..84c06d27ce1 100644 --- a/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +++ b/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx @@ -14,19 +14,19 @@ m365 spo contenttype field set [options] ```md definition-list `-u, --webUrl <webUrl>` -: Absolute URL of the site where the content type is located +: Absolute URL of the site where the content type is located. `-c, --contentTypeId <contentTypeId>` -: ID of the content type on which the field reference should be set +: ID of the content type on which the field reference should be set. `--id <id>` -: ID of the field to which the reference should be set +: ID of the field to which the reference should be set. `-r, --required [required]` -: Set to `true`, if the field should be required or to `false` if it should be optional +: Set to `true`, if the field should be required or to `false` if it should be optional. `--hidden [hidden]` -: Set to `true`, if the field should be hidden or to `false` if it should be visible +: Set to `true`, if the field should be hidden or to `false` if it should be visible. ``` <Global /> @@ -37,20 +37,24 @@ If the field reference already exists, the command will update its _required_ an ## Examples -Add the specified site column to the specified content type as an optional and visible field +Add the specified site column to the specified content type as an optional and visible field. ```sh m365 spo contenttype field set --webUrl https://contoso.sharepoint.com/sites/portal --contentTypeId 0x01007926A45D687BA842B947286090B8F67D --id ebe7e498-44ff-43da-a7e5-99b444f656a5 ``` -Add the specified site column to the specified content type as a required field +Add the specified site column to the specified content type as a required field. ```sh m365 spo contenttype field set --webUrl https://contoso.sharepoint.com/sites/portal --contentTypeId 0x01007926A45D687BA842B947286090B8F67D --id ebe7e498-44ff-43da-a7e5-99b444f656a5 --required true ``` -Update the existing site column reference in the specified content type to optional +Update the existing site column reference in the specified content type to optional. ```sh m365 spo contenttype field set --webUrl https://contoso.sharepoint.com/sites/portal --contentTypeId 0x01007926A45D687BA842B947286090B8F67D --id ebe7e498-44ff-43da-a7e5-99b444f656a5 --required false ``` + +## Response + +The command won't return a response on success. diff --git a/docs/docs/cmd/spo/contenttype/contenttype-get.mdx b/docs/docs/cmd/spo/contenttype/contenttype-get.mdx index 6ff0188bb5b..5b5f4d6df40 100644 --- a/docs/docs/cmd/spo/contenttype/contenttype-get.mdx +++ b/docs/docs/cmd/spo/contenttype/contenttype-get.mdx @@ -14,7 +14,7 @@ m365 spo contenttype get [options] ```md definition-list `-u, --webUrl <webUrl>` -: Absolute URL of the site where the content type is located +: 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`. @@ -26,10 +26,10 @@ m365 spo contenttype get [options] : 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 +: 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 +: The name of the content type to retrieve. Specify either id or name but not both. ``` <Global /> @@ -40,32 +40,169 @@ If no content type with the specified is found in the site or the list, you will ## Examples -Retrieve site content type by id +Retrieve site content type by id. ```sh m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --id 0x0100558D85B7216F6A489A499DB361E1AE2F ``` -Retrieve site content type by name +Retrieve site content type by name. ```sh m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'Document' ``` -Retrieve list (retrieved by Title) content type +Retrieve list (retrieved by Title) content type. ```sh m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 0x0100558D85B7216F6A489A499DB361E1AE2F ``` -Retrieve list (retrieved by ID) content type +Retrieve list (retrieved by ID) content type. ```sh m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --id 0x0100558D85B7216F6A489A499DB361E1AE2F ``` -Retrieve list (retrieved by URL) content type +Retrieve list (retrieved by URL) content type. ```sh m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --id 0x0100558D85B7216F6A489A499DB361E1AE2F ``` + +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + { + "ClientFormCustomFormatter": "", + "Description": "Create a new list item.", + "DisplayFormClientSideComponentId": "", + "DisplayFormClientSideComponentProperties": "", + "DisplayFormTarget": 0, + "DisplayFormTemplateName": "ListForm", + "DisplayFormUrl": "", + "DocumentTemplate": "", + "DocumentTemplateUrl": "", + "EditFormClientSideComponentId": "", + "EditFormClientSideComponentProperties": "", + "EditFormTarget": 0, + "EditFormTemplateName": "ListForm", + "EditFormUrl": "", + "Group": "PnP Content Types", + "Hidden": false, + "Id": { + "StringValue": "0x01007926A45D687BA842B947286090B8F67D" + }, + "JSLink": "", + "MobileDisplayFormUrl": "", + "MobileEditFormUrl": "", + "MobileNewFormUrl": "", + "Name": "PnP Alert", + "NewFormClientSideComponentId": null, + "NewFormClientSideComponentProperties": "", + "NewFormTarget": 0, + "NewFormTemplateName": "ListForm", + "NewFormUrl": "", + "ReadOnly": false, + "SchemaXml": "<ContentType ID=\"0x01007926A45D687BA842B947286090B8F67D\" Name=\"PnP Alert\" Group=\"PnP Content Types\" Description=\"Create a new list item.\" Version=\"0\"><Folder TargetName=\"_cts/PnP Alert\" /><Fields><Field ID=\"{c042a256-787d-4a6f-8a8a-cf6ab767f12d}\" Name=\"ContentType\" SourceID=\"http://schemas.microsoft.com/sharepoint/v3\" StaticName=\"ContentType\" Group=\"_Hidden\" Type=\"Computed\" DisplayName=\"Content Type\" Sealed=\"TRUE\" Sortable=\"FALSE\" RenderXMLUsingPattern=\"TRUE\" PITarget=\"MicrosoftWindowsSharePointServices\" PIAttribute=\"ContentTypeID\" DelayActivateTemplateBinding=\"GROUP,SPSPERS,SITEPAGEPUBLISHING\" Customization=\"\"><FieldRefs><FieldRef ID=\"{03e45e84-1992-4d42-9116-26f756012634}\" Name=\"ContentTypeId\" /></FieldRefs><DisplayPattern><MapToContentType><Column Name=\"ContentTypeId\" /></MapToContentType></DisplayPattern></Field><Field ID=\"{fa564e0f-0c70-4ab9-b863-0177e6ddd247}\" Name=\"Title\" SourceID=\"http://schemas.microsoft.com/sharepoint/v3\" StaticName=\"Title\" Group=\"_Hidden\" Type=\"Text\" DisplayName=\"Title\" Required=\"TRUE\" FromBaseType=\"TRUE\" DelayActivateTemplateBinding=\"GROUP,SPSPERS,SITEPAGEPUBLISHING\" Customization=\"\" ShowInNewForm=\"TRUE\" ShowInEditForm=\"TRUE\"></Field></Fields><XmlDocuments><XmlDocument NamespaceURI=\"http://schemas.microsoft.com/sharepoint/v3/contenttype/forms\"><FormTemplates xmlns=\"http://schemas.microsoft.com/sharepoint/v3/contenttype/forms\"><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType>", + "Scope": "/sites/contoso-sales", + "Sealed": false, + "StringId": "0x01007926A45D687BA842B947286090B8F67D" + } + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + ClientFormCustomFormatter : + Description : Create a new list item. + DisplayFormClientSideComponentId : + DisplayFormClientSideComponentProperties: + DisplayFormTarget : 0 + DisplayFormTemplateName : ListForm + DisplayFormUrl : + DocumentTemplate : + DocumentTemplateUrl : + EditFormClientSideComponentId : + EditFormClientSideComponentProperties : + EditFormTarget : 0 + EditFormTemplateName : ListForm + EditFormUrl : + Group : PnP Content Types + Hidden : false + Id : {"StringValue":"0x01007926A45D687BA842B947286090B8F67D"} + JSLink : + MobileDisplayFormUrl : + MobileEditFormUrl : + MobileNewFormUrl : + Name : PnP Alert + NewFormClientSideComponentId : null + NewFormClientSideComponentProperties : + NewFormTarget : 0 + NewFormTemplateName : ListForm + NewFormUrl : + ReadOnly : false + SchemaXml : <ContentType ID="0x01007926A45D687BA842B947286090B8F67D" Name="PnP Alert" Group="PnP Content Types" Description="Create a new list item." Version="0"><Folder TargetName="_cts/PnP Alert" /><Fields><Field ID="{c042a256-787d-4a6f-8a8a-cf6ab767f12d}" Name="ContentType" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentType" Group="_Hidden" Type="Computed" DisplayName="Content Type" Sealed="TRUE" Sortable="FALSE" RenderXMLUsingPattern="TRUE" PITarget="MicrosoftWindowsSharePointServices" PIAttribute="ContentTypeID" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization=""><FieldRefs><FieldRef ID="{03e45e84-1992-4d42-9116-26f756012634}" Name="ContentTypeId" /></FieldRefs><DisplayPattern><MapToContentType><Column Name="ContentTypeId" /></MapToContentType></DisplayPattern></Field><Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Name="Title" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" Group="_Hidden" Type="Text" DisplayName="Title" Required="TRUE" FromBaseType="TRUE" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization="" ShowInNewForm="TRUE" ShowInEditForm="TRUE"></Field></Fields><XmlDocuments><XmlDocument NamespaceURI="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><FormTemplates xmlns="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType> + Scope : /sites/contoso-sales + Sealed : false + StringId : 0x01007926A45D687BA842B947286090B8F67D + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + ClientFormCustomFormatter,Description,DisplayFormClientSideComponentId,DisplayFormClientSideComponentProperties,DisplayFormTarget,DisplayFormTemplateName,DisplayFormUrl,DocumentTemplate,DocumentTemplateUrl,EditFormClientSideComponentId,EditFormClientSideComponentProperties,EditFormTarget,EditFormTemplateName,EditFormUrl,Group,Hidden,JSLink,MobileDisplayFormUrl,MobileEditFormUrl,MobileNewFormUrl,Name,NewFormClientSideComponentProperties,NewFormTarget,NewFormTemplateName,NewFormUrl,ReadOnly,SchemaXml,Scope,Sealed,StringId + ,Create a new list item.,,,0,ListForm,,,,,,0,ListForm,,PnP Content Types,,,,,,PnP Alert,,0,ListForm,,,"<ContentType ID=""0x01007926A45D687BA842B947286090B8F67D"" Name=""PnP Alert"" Group=""PnP Content Types"" Description=""Create a new list item."" Version=""0""><Folder TargetName=""_cts/PnP Alert"" /><Fields><Field ID=""{c042a256-787d-4a6f-8a8a-cf6ab767f12d}"" Name=""ContentType"" SourceID=""http://schemas.microsoft.com/sharepoint/v3"" StaticName=""ContentType"" Group=""_Hidden"" Type=""Computed"" DisplayName=""Content Type"" Sealed=""TRUE"" Sortable=""FALSE"" RenderXMLUsingPattern=""TRUE"" PITarget=""MicrosoftWindowsSharePointServices"" PIAttribute=""ContentTypeID"" DelayActivateTemplateBinding=""GROUP,SPSPERS,SITEPAGEPUBLISHING"" Customization=""""><FieldRefs><FieldRef ID=""{03e45e84-1992-4d42-9116-26f756012634}"" Name=""ContentTypeId"" /></FieldRefs><DisplayPattern><MapToContentType><Column Name=""ContentTypeId"" /></MapToContentType></DisplayPattern></Field><Field ID=""{fa564e0f-0c70-4ab9-b863-0177e6ddd247}"" Name=""Title"" SourceID=""http://schemas.microsoft.com/sharepoint/v3"" StaticName=""Title"" Group=""_Hidden"" Type=""Text"" DisplayName=""Title"" Required=""TRUE"" FromBaseType=""TRUE"" DelayActivateTemplateBinding=""GROUP,SPSPERS,SITEPAGEPUBLISHING"" Customization="""" ShowInNewForm=""TRUE"" ShowInEditForm=""TRUE""></Field></Fields><XmlDocuments><XmlDocument NamespaceURI=""http://schemas.microsoft.com/sharepoint/v3/contenttype/forms""><FormTemplates xmlns=""http://schemas.microsoft.com/sharepoint/v3/contenttype/forms""><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType>",/sites/contoso-sales,,0x01007926A45D687BA842B947286090B8F67D + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + # spo contenttype get --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --id "0x01007926A45D687BA842B947286090B8F67D" + + Date: 10/2/2023 + + ## PnP Alert ([object Object]) + + Property | Value + ---------|------- + ClientFormCustomFormatter | + Description | Create a new list item. + DisplayFormClientSideComponentId | + DisplayFormClientSideComponentProperties | + DisplayFormTarget | 0 + DisplayFormTemplateName | ListForm + DisplayFormUrl | + DocumentTemplate | + DocumentTemplateUrl | + EditFormClientSideComponentId | + EditFormClientSideComponentProperties | + EditFormTarget | 0 + EditFormTemplateName | ListForm + EditFormUrl | + Group | PnP Content Types + Hidden | false + JSLink | + MobileDisplayFormUrl | + MobileEditFormUrl | + MobileNewFormUrl | + Name | PnP Alert + NewFormClientSideComponentProperties | + NewFormTarget | 0 + NewFormTemplateName | ListForm + NewFormUrl | + ReadOnly | false + SchemaXml | <ContentType ID="0x01007926A45D687BA842B947286090B8F67D" Name="PnP Alert" Group="PnP Content Types" Description="Create a new list item." Version="0"><Folder TargetName="\_cts/PnP Alert" /><Fields><Field ID="{c042a256-787d-4a6f-8a8a-cf6ab767f12d}" Name="ContentType" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentType" Group="\_Hidden" Type="Computed" DisplayName="Content Type" Sealed="TRUE" Sortable="FALSE" RenderXMLUsingPattern="TRUE" PITarget="MicrosoftWindowsSharePointServices" PIAttribute="ContentTypeID" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization=""><FieldRefs><FieldRef ID="{03e45e84-1992-4d42-9116-26f756012634}" Name="ContentTypeId" /></FieldRefs><DisplayPattern><MapToContentType><Column Name="ContentTypeId" /></MapToContentType></DisplayPattern></Field><Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Name="Title" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" Group="\_Hidden" Type="Text" DisplayName="Title" Required="TRUE" FromBaseType="TRUE" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization="" ShowInNewForm="TRUE" ShowInEditForm="TRUE"></Field></Fields><XmlDocuments><XmlDocument NamespaceURI="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><FormTemplates xmlns="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType> + Scope | /sites/contoso-sales + Sealed | false + StringId | 0x01007926A45D687BA842B947286090B8F67D + ``` + + </TabItem> +</Tabs> diff --git a/docs/docs/cmd/spo/contenttype/contenttype-list.mdx b/docs/docs/cmd/spo/contenttype/contenttype-list.mdx index 094bad8f05f..978b5d49008 100644 --- a/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +++ b/docs/docs/cmd/spo/contenttype/contenttype-list.mdx @@ -14,24 +14,133 @@ m365 spo contenttype list [options] ```md definition-list `-u, --webUrl <webUrl>` -: Absolute URL of the site for which to list content types +: Absolute URL of the site for which to list content types. `-c, --category [category]` -: Category name of content types. When defined will return only content types from specified category +: Category name of content types. When defined will return only content types from specified category. ``` <Global /> ## Examples -Retrieve site content types +Retrieve site content types. ```PowerShell m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" ``` -Retrieve site content types from the 'List Content Types' category +Retrieve site content types from the 'List Content Types' category. ```PowerShell m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --category "List Content Types" ``` + +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + [ + { + "ClientFormCustomFormatter": "", + "Description": "Create a new list item.", + "DisplayFormClientSideComponentId": "", + "DisplayFormClientSideComponentProperties": "", + "DisplayFormTarget": 0, + "DisplayFormTemplateName": "ListForm", + "DisplayFormUrl": "", + "DocumentTemplate": "", + "DocumentTemplateUrl": "", + "EditFormClientSideComponentId": "", + "EditFormClientSideComponentProperties": "", + "EditFormTarget": 0, + "EditFormTemplateName": "ListForm", + "EditFormUrl": "", + "Group": "PnP Content Types", + "Hidden": false, + "Id": { + "StringValue": "0x01007926A45D687BA842B947286090B8F67D" + }, + "JSLink": "", + "MobileDisplayFormUrl": "", + "MobileEditFormUrl": "", + "MobileNewFormUrl": "", + "Name": "PnP Alert", + "NewFormClientSideComponentId": null, + "NewFormClientSideComponentProperties": "", + "NewFormTarget": 0, + "NewFormTemplateName": "ListForm", + "NewFormUrl": "", + "ReadOnly": false, + "SchemaXml": "<ContentType ID=\"0x01007926A45D687BA842B947286090B8F67D\" Name=\"PnP Alert\" Group=\"PnP Content Types\" Description=\"Create a new list item.\" Version=\"0\"><Folder TargetName=\"_cts/PnP Alert\" /><Fields><Field ID=\"{c042a256-787d-4a6f-8a8a-cf6ab767f12d}\" Name=\"ContentType\" SourceID=\"http://schemas.microsoft.com/sharepoint/v3\" StaticName=\"ContentType\" Group=\"_Hidden\" Type=\"Computed\" DisplayName=\"Content Type\" Sealed=\"TRUE\" Sortable=\"FALSE\" RenderXMLUsingPattern=\"TRUE\" PITarget=\"MicrosoftWindowsSharePointServices\" PIAttribute=\"ContentTypeID\" DelayActivateTemplateBinding=\"GROUP,SPSPERS,SITEPAGEPUBLISHING\" Customization=\"\"><FieldRefs><FieldRef ID=\"{03e45e84-1992-4d42-9116-26f756012634}\" Name=\"ContentTypeId\" /></FieldRefs><DisplayPattern><MapToContentType><Column Name=\"ContentTypeId\" /></MapToContentType></DisplayPattern></Field><Field ID=\"{fa564e0f-0c70-4ab9-b863-0177e6ddd247}\" Name=\"Title\" SourceID=\"http://schemas.microsoft.com/sharepoint/v3\" StaticName=\"Title\" Group=\"_Hidden\" Type=\"Text\" DisplayName=\"Title\" Required=\"TRUE\" FromBaseType=\"TRUE\" DelayActivateTemplateBinding=\"GROUP,SPSPERS,SITEPAGEPUBLISHING\" Customization=\"\" ShowInNewForm=\"TRUE\" ShowInEditForm=\"TRUE\"></Field></Fields><XmlDocuments><XmlDocument NamespaceURI=\"http://schemas.microsoft.com/sharepoint/v3/contenttype/forms\"><FormTemplates xmlns=\"http://schemas.microsoft.com/sharepoint/v3/contenttype/forms\"><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType>", + "Scope": "/sites/contoso-sales", + "Sealed": false, + "StringId": "0x01007926A45D687BA842B947286090B8F67D" + } + ] + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + StringId Name Hidden ReadOnly Sealed + -------------------------------------------------------------------------- ------------------------------- ------ -------- ------ + 0x01007926A45D687BA842B947286090B8F67D PnP Alert false false false 0x01007CE30DD1206047728BAFD1C39A850120 Official Notice false false false 0x0100807FBAC5EB8A4653B8D24775195B5463 Phone Call Memo false false false + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + ClientFormCustomFormatter,Description,DisplayFormClientSideComponentId,DisplayFormClientSideComponentProperties,DisplayFormTarget,DisplayFormTemplateName,DisplayFormUrl,DocumentTemplate,DocumentTemplateUrl,EditFormClientSideComponentId,EditFormClientSideComponentProperties,EditFormTarget,EditFormTemplateName,EditFormUrl,Group,Hidden,JSLink,MobileDisplayFormUrl,MobileEditFormUrl,MobileNewFormUrl,Name,NewFormClientSideComponentProperties,NewFormTarget,NewFormTemplateName,NewFormUrl,ReadOnly,SchemaXml,Scope,Sealed,StringId + ,Create a new list item.,,,0,ListForm,,,,,,0,ListForm,,PnP Content Types,,,,,,PnP Alert,,0,ListForm,,,"<ContentType ID=""0x01007926A45D687BA842B947286090B8F67D"" Name=""PnP Alert"" Group=""PnP Content Types"" Description=""Create a new list item."" Version=""0""><Folder TargetName=""_cts/PnP Alert"" /><Fields><Field ID=""{c042a256-787d-4a6f-8a8a-cf6ab767f12d}"" Name=""ContentType"" SourceID=""http://schemas.microsoft.com/sharepoint/v3"" StaticName=""ContentType"" Group=""_Hidden"" Type=""Computed"" DisplayName=""Content Type"" Sealed=""TRUE"" Sortable=""FALSE"" RenderXMLUsingPattern=""TRUE"" PITarget=""MicrosoftWindowsSharePointServices"" PIAttribute=""ContentTypeID"" DelayActivateTemplateBinding=""GROUP,SPSPERS,SITEPAGEPUBLISHING"" Customization=""""><FieldRefs><FieldRef ID=""{03e45e84-1992-4d42-9116-26f756012634}"" Name=""ContentTypeId"" /></FieldRefs><DisplayPattern><MapToContentType><Column Name=""ContentTypeId"" /></MapToContentType></DisplayPattern></Field><Field ID=""{fa564e0f-0c70-4ab9-b863-0177e6ddd247}"" Name=""Title"" SourceID=""http://schemas.microsoft.com/sharepoint/v3"" StaticName=""Title"" Group=""_Hidden"" Type=""Text"" DisplayName=""Title"" Required=""TRUE"" FromBaseType=""TRUE"" DelayActivateTemplateBinding=""GROUP,SPSPERS,SITEPAGEPUBLISHING"" Customization="""" ShowInNewForm=""TRUE"" ShowInEditForm=""TRUE""></Field></Fields><XmlDocuments><XmlDocument NamespaceURI=""http://schemas.microsoft.com/sharepoint/v3/contenttype/forms""><FormTemplates xmlns=""http://schemas.microsoft.com/sharepoint/v3/contenttype/forms""><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType>",/sites/contoso-sales,,0x01007926A45D687BA842B947286090B8F67D + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + # spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" + + Date: 10/2/2023 + ## PnP Alert ([object Object]) + + Property | Value + ---------|------- + ClientFormCustomFormatter | + Description | Create a new list item. + DisplayFormClientSideComponentId | + DisplayFormClientSideComponentProperties | + DisplayFormTarget | 0 + DisplayFormTemplateName | ListForm + DisplayFormUrl | + DocumentTemplate | + DocumentTemplateUrl | + EditFormClientSideComponentId | + EditFormClientSideComponentProperties | + EditFormTarget | 0 + EditFormTemplateName | ListForm + EditFormUrl | + Group | PnP Content Types + Hidden | false + JSLink | + MobileDisplayFormUrl | + MobileEditFormUrl | + MobileNewFormUrl | + Name | PnP Alert + NewFormClientSideComponentProperties | + NewFormTarget | 0 + NewFormTemplateName | ListForm + NewFormUrl | + ReadOnly | false + SchemaXml | <ContentType ID="0x01007926A45D687BA842B947286090B8F67D" Name="PnP Alert" Group="PnP Content Types" Description="Create a new list item." Version="0"><Folder TargetName="\_cts/PnP Alert" /><Fields><Field ID="{c042a256-787d-4a6f-8a8a-cf6ab767f12d}" Name="ContentType" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="ContentType" Group="\_Hidden" Type="Computed" DisplayName="Content Type" Sealed="TRUE" Sortable="FALSE" RenderXMLUsingPattern="TRUE" PITarget="MicrosoftWindowsSharePointServices" PIAttribute="ContentTypeID" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization=""><FieldRefs><FieldRef ID="{03e45e84-1992-4d42-9116-26f756012634}" Name="ContentTypeId" /></FieldRefs><DisplayPattern><MapToContentType><Column Name="ContentTypeId" /></MapToContentType></DisplayPattern></Field><Field ID="{fa564e0f-0c70-4ab9-b863-0177e6ddd247}" Name="Title" SourceID="http://schemas.microsoft.com/sharepoint/v3" StaticName="Title" Group="\_Hidden" Type="Text" DisplayName="Title" Required="TRUE" FromBaseType="TRUE" DelayActivateTemplateBinding="GROUP,SPSPERS,SITEPAGEPUBLISHING" Customization="" ShowInNewForm="TRUE" ShowInEditForm="TRUE"></Field></Fields><XmlDocuments><XmlDocument NamespaceURI="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><FormTemplates xmlns="http://schemas.microsoft.com/sharepoint/v3/contenttype/forms"><Display>ListForm</Display><Edit>ListForm</Edit><New>ListForm</New></FormTemplates></XmlDocument></XmlDocuments></ContentType> + Scope | /sites/contoso-sales + Sealed | false + StringId | 0x01007926A45D687BA842B947286090B8F67D + ``` + + </TabItem> +</Tabs> diff --git a/docs/docs/cmd/spo/contenttype/contenttype-remove.mdx b/docs/docs/cmd/spo/contenttype/contenttype-remove.mdx index e1d7e0527c2..81f94230860 100644 --- a/docs/docs/cmd/spo/contenttype/contenttype-remove.mdx +++ b/docs/docs/cmd/spo/contenttype/contenttype-remove.mdx @@ -14,16 +14,16 @@ m365 spo contenttype remove [options] ```md definition-list `-u, --webUrl <webUrl>` -: Absolute URL of the site where the content type is located +: Absolute URL of the site where the content type is located. `-i, --id [id]` -: The ID of the content type to remove +: The ID of the content type to remove. Specify either `id` or `name`. `-n, --name [name]` -: The name of the content type to remove +: The name of the content type to remove. Specify either `id` or `name`. `-f, --force` -: Don't prompt for confirming removal of the content type +: Don't prompt for confirming removal of the content type. ``` <Global /> @@ -53,3 +53,7 @@ Remove a site content type without prompting for confirmation ```sh m365 spo contenttype remove --name "My Content Type" --webUrl https://contoso.sharepoint.com --force ``` + +## Response + +The command won't return a response on success. diff --git a/docs/docs/cmd/spo/contenttype/contenttype-set.mdx b/docs/docs/cmd/spo/contenttype/contenttype-set.mdx index 3c34d01dc04..f860a04ec84 100644 --- a/docs/docs/cmd/spo/contenttype/contenttype-set.mdx +++ b/docs/docs/cmd/spo/contenttype/contenttype-set.mdx @@ -17,10 +17,10 @@ m365 spo contenttype set [options] : URL of the site where the content type to update is defined. `-i, --id [id]` -: ID of the content type to update. Specify `id` or `name` but not both, one is required. +: ID of the content type to update. Specify either `id` or `name` but not both. `-n, --name [name]` -: Name of the content type to update. Specify the `id` or the `name` but not both, one is required. +: Name of the content type to update. Specify either `id` or the `name` but not both. `--listTitle [listTitle]` : Title of the list if you want to update a list content type. Specify either `listTitle`, `listId` or `listUrl`. @@ -47,13 +47,13 @@ When specifying the `--updateChildren` flag, SharePoint will only propagate the ## Examples -Move site content type to a different group +Move site content type to a different group. ```sh m365 spo contenttype set --id 0x001001 --webUrl https://contoso.sharepoint.com --Group "My group" ``` -Rename list content type +Rename list content type. ```sh m365 spo contenttype set --name "My old item" --webUrl https://contoso.sharepoint.com --listTitle "My list" --Name "My item" @@ -64,3 +64,7 @@ Configure a form customizer with manifest ID _19890cce-15d8-4af9-bfcb-72da06d13e ```sh m365 spo contenttype set --name "My content type" --webUrl https://contoso.sharepoint.com --DisplayFormClientSideComponentId "19890cce-15d8-4af9-bfcb-72da06d13ed8" --EditFormClientSideComponentId "19890cce-15d8-4af9-bfcb-72da06d13ed8" --NewFormClientSideComponentId "19890cce-15d8-4af9-bfcb-72da06d13ed8" --updateChildren ``` + +## Response + +The command won't return a response on success. diff --git a/docs/docs/cmd/spo/contenttypehub/contenttypehub-get.mdx b/docs/docs/cmd/spo/contenttypehub/contenttypehub-get.mdx index ac3da300472..fd0c5b5df1a 100644 --- a/docs/docs/cmd/spo/contenttypehub/contenttypehub-get.mdx +++ b/docs/docs/cmd/spo/contenttypehub/contenttypehub-get.mdx @@ -21,3 +21,45 @@ Retrieve the Content Type Hub URL ```sh m365 spo contenttypehub get ``` + +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + { + "ContentTypePublishingHub": "https://contoso.sharepoint.com/sites/contentTypeHub" + } + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + ContentTypePublishingHub: https://contoso.sharepoint.com/sites/contentTypeHub + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + ContentTypePublishingHub + https://contoso.sharepoint.com/sites/contentTypeHub + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + # spo contenttypehub get + + Date: 10/2/2023 + + Property | Value + ---------|------- + ContentTypePublishingHub | https://contoso.sharepoint.com/sites/contentTypeHub + ``` + + </TabItem> +</Tabs> diff --git a/docs/docs/cmd/spo/customaction/customaction-add.mdx b/docs/docs/cmd/spo/customaction/customaction-add.mdx index a3c57fa4134..11e968bfdec 100644 --- a/docs/docs/cmd/spo/customaction/customaction-add.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-add.mdx @@ -90,54 +90,58 @@ When using the `--clientSideComponentProperties` option it's possible to enter a ## Examples -Adds tenant-wide SharePoint Framework Application Customizer extension in site _https://contoso.sharepoint.com/sites/test_ +Adds tenant-wide SharePoint Framework Application Customizer extension in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --name "YourName" --location "ClientSideExtension.ApplicationCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{"testMessage":"Test message"}' ``` -Adds tenant-wide SharePoint Framework **modern List View** Command Set extension in site _https://contoso.sharepoint.com/sites/test_ +Adds tenant-wide SharePoint Framework **modern List View** Command Set extension in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourCommandSet" --name "YourName" --location "ClientSideExtension.ListViewCommandSet" --clientSideComponentId db3e6e35-363c-42b9-a254-ca661e437848 --clientSideComponentProperties '{"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}' --registrationId 100 --registrationType List ``` -Creates url custom action in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_ +Creates url custom action in the SiteActions menu in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "Microsoft.SharePoint.StandardMenu" --group "SiteActions" --actionUrl "~site/SitePages/Home.aspx" --sequence 100 ``` -Creates custom action in **classic** Document Library edit context menu in site _https://contoso.sharepoint.com/sites/test_ +Creates custom action in **classic** Document Library edit context menu in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "EditControlBlock" --actionUrl "javascript:(function(){ return console.log('CLI for Microsoft 365 rocks!'); })();" --registrationId 101 --registrationType List ``` -Creates ScriptLink custom action with script source in **classic pages** in site collection _https://contoso.sharepoint.com/sites/test_ +Creates ScriptLink custom action with script source in **classic pages** in the specified site collection. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "ScriptLink" --scriptSrc "~sitecollection/SiteAssets/YourScript.js" --sequence 101 --scope Site ``` -Creates ScriptLink custom action with script block in **classic pages** in site _https://contoso.sharepoint.com/sites/test_ +Creates ScriptLink custom action with script block in **classic pages** in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "ScriptLink" --scriptBlock "(function(){ return console.log('Hello CLI for Microsoft 365!'); })();" --sequence 102 ``` -Creates **classic List View** custom action located in the Ribbon in site _https://contoso.sharepoint.com/sites/test_ +Creates **classic List View** custom action located in the Ribbon in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "CommandUI.Ribbon" --commandUIExtension '<CommandUIExtension><CommandUIDefinitions><CommandUIDefinition Location="Ribbon.List.Share.Controls._children"><Button Id="Ribbon.List.Share.GetItemsCountButton" Alt="Get list items count" Sequence="11" Command="Invoke_GetItemsCountButtonRequest" LabelText="Get Items Count" TemplateAlias="o1" Image32by32="_layouts/15/images/placeholder32x32.png" Image16by16="_layouts/15/images/placeholder16x16.png" /></CommandUIDefinition></CommandUIDefinitions><CommandUIHandlers><CommandUIHandler Command="Invoke_GetItemsCountButtonRequest" CommandAction="javascript: alert(ctx.TotalListItems);" EnabledScript="javascript: function checkEnable() { return (true);} checkEnable();"/></CommandUIHandlers></CommandUIExtension>' ``` -Creates custom action with delegated rights in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_ +Creates custom action with delegated rights in the SiteActions menu in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "Microsoft.SharePoint.StandardMenu" --group "SiteActions" --actionUrl "~site/SitePages/Home.aspx" --rights "AddListItems,DeleteListItems,ManageLists" ``` +## Response + +The command won't return a response on success. + ## More information - UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) diff --git a/docs/docs/cmd/spo/customaction/customaction-clear.mdx b/docs/docs/cmd/spo/customaction/customaction-clear.mdx index 09121cec9fd..7819fe342d1 100644 --- a/docs/docs/cmd/spo/customaction/customaction-clear.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-clear.mdx @@ -14,34 +14,37 @@ m365 spo customaction clear [options] ```md definition-list `-u, --webUrl <webUrl>` -: Url of the site or site collection to clear the custom actions from +: Url of the site or site collection to clear the custom actions from. `-s, --scope [scope]` -: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All` +: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`. `-f, --force` -: Don't prompt for confirming removing all custom actions +: Don't prompt for confirming removing all custom actions. ``` <Global /> ## Examples -Clears all user custom actions for both site and site collection _https://contoso.sharepoint.com/sites/test_. -Skips the confirmation prompt message. +Clears all user custom actions for both site and site collection. Skips the confirmation prompt message. ```sh m365 spo customaction clear --webUrl https://contoso.sharepoint.com/sites/test --force ``` -Clears all user custom actions for site _https://contoso.sharepoint.com/sites/test_. +Clears all user custom actions for the specified site. ```sh m365 spo customaction clear --webUrl https://contoso.sharepoint.com/sites/test --scope Web ``` -Clears all user custom actions for site collection _https://contoso.sharepoint.com/sites/test_ +Clears all user custom actions for the specified site collection. ```sh m365 spo customaction clear --webUrl https://contoso.sharepoint.com/sites/test --scope Site ``` + +## Response + +The command won't return a response on success. diff --git a/docs/docs/cmd/spo/customaction/customaction-get.mdx b/docs/docs/cmd/spo/customaction/customaction-get.mdx index 91651af3064..e134d3997ba 100644 --- a/docs/docs/cmd/spo/customaction/customaction-get.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-get.mdx @@ -16,19 +16,19 @@ m365 spo customaction get [options] ```md definition-list `-i, --id [id]` -: ID of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId` +: 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` +: 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` +: clientSideComponentId of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`. `-u, --webUrl <webUrl>` -: Url of the site or site collection to retrieve the custom action from +: 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` +: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`. ``` <Global /> @@ -39,37 +39,37 @@ If the command finds multiple user custom actions with the specified `title` or ## Examples -Return details about the user custom action based on the id and a given url +Return details about the user custom action based on the id and a given url. ```sh m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test ``` -Return details about the user custom action based on the title and a given url +Return details about the user custom action based on the title and a given url. ```sh m365 spo customaction get --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test ``` -Return details about the user custom action based on the clientSideComponentId and a given url +Return details about the user custom action based on the clientSideComponentId and a given url. ```sh m365 spo customaction get --clientSideComponentId "34a019f9-6198-4053-a3b6-fbdea9a107fd" --webUrl https://contoso.sharepoint.com/sites/test ``` -Return details about the user custom action based on the id and a given url and the scope +Return details about the user custom action based on the id and a given url and the scope. ```sh m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Site ``` -Return details about the user custom action based on the id and a given url and the scope +Return details about the user custom action based on the id and a given url and the scope. ```sh m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web ``` -Return details about the user custom action based on the id and a given url and the scope +Return details about the user custom action based on the id and a given url and the scope. ```sh m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web diff --git a/docs/docs/cmd/spo/customaction/customaction-list.mdx b/docs/docs/cmd/spo/customaction/customaction-list.mdx index be256490b98..0eff3471875 100644 --- a/docs/docs/cmd/spo/customaction/customaction-list.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-list.mdx @@ -14,10 +14,10 @@ m365 spo customaction list [options] ```md definition-list `-u, --webUrl <webUrl>` -: Url of the site or site collection to retrieve the custom action from +: 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` +: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`. ``` <Global /> @@ -28,24 +28,104 @@ When using the text output type (default), the command lists only the values of ## Examples -Return details about all user custom actions located in site or site collection _https://contoso.sharepoint.com/sites/test_ +Return details about all user custom actions located in the specified site or site collection. ```sh m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test ``` -Return details about all user custom actions located in site collection _https://contoso.sharepoint.com/sites/test_ +Return details about all user custom actions located in the specified site collection. ```sh m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Site ``` -Return details about all user custom actions located in site _https://contoso.sharepoint.com/sites/test_ +Return details about all user custom actions located in the specified site. ```sh m365 spo customaction list --webUrl https://contoso.sharepoint.com/sites/test --scope Web ``` +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + [ + { + "ClientSideComponentId": "b41916e7-e69d-467f-b37f-ff8ecf8f99f2", + "ClientSideComponentProperties": "'{testMessage:Test message}'", + "CommandUIExtension": null, + "Description": null, + "Group": null, + "HostProperties": "", + "Id": "a70d8013-3b9f-4601-93a5-0e453ab9a1f3", + "ImageUrl": null, + "Location": "ClientSideExtension.ApplicationCustomizer", + "Name": "YourName", + "RegistrationId": null, + "RegistrationType": 0, + "Rights": { + "High": 0, + "Low": 0 + }, + "Scope": 3, + "ScriptBlock": null, + "ScriptSrc": null, + "Sequence": 0, + "Title": "YourAppCustomizer", + "Url": null, + "VersionOfUserCustomAction": "16.0.1.0" + } + ] + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + Name Location Scope Id + --------------- ----------------------------------------- ----- ------------------------------------ + YourName ClientSideExtension.ApplicationCustomizer Web a70d8013-3b9f-4601-93a5-0e453ab9a1f3 + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + ClientSideComponentId,ClientSideComponentProperties,HostProperties,Id,Location,Name,RegistrationType,Scope,Sequence,Title,VersionOfUserCustomAction + b41916e7-e69d-467f-b37f-ff8ecf8f99f2,'{testMessage:Test message}',,a70d8013-3b9f-4601-93a5-0e453ab9a1f3,ClientSideExtension.ApplicationCustomizer,YourName,0,Web,0,YourAppCustomizer,16.0.1.0 + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + # spo customaction list --webUrl "https://contoso.sharepoint.com/sites/sales" + + Date: 10/2/2023 + + ## YourAppCustomizer (a70d8013-3b9f-4601-93a5-0e453ab9a1f3) + + Property | Value + ---------|------- + ClientSideComponentId | b41916e7-e69d-467f-b37f-ff8ecf8f99f2 + ClientSideComponentProperties | '{testMessage:Test message}' + HostProperties | + Id | a70d8013-3b9f-4601-93a5-0e453ab9a1f3 + Location | ClientSideExtension.ApplicationCustomizer + Name | YourName + RegistrationType | 0 + Scope | Web + Sequence | 0 + Title | YourAppCustomizer + VersionOfUserCustomAction | 16.0.1.0 + ``` + + </TabItem> +</Tabs> + ## More information - UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) diff --git a/docs/docs/cmd/spo/customaction/customaction-remove.mdx b/docs/docs/cmd/spo/customaction/customaction-remove.mdx index aa272de9db4..d1f005c5b21 100644 --- a/docs/docs/cmd/spo/customaction/customaction-remove.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-remove.mdx @@ -14,19 +14,19 @@ m365 spo customaction remove [options] ```md definition-list `-i, --id [id]` -: Id (GUID) of the custom action to remove. Specify either `id` or `title` +: Id (GUID) of the custom action to remove. Specify either `id` or `title`. `-t, --title [title]` -: Title of the user custom action to retrieve information for. Specify either `id` or `title` +: Title of the user custom action to retrieve information for. Specify either `id` or `title`. `-u, --webUrl <webUrl>` -: Url of the site or site collection to remove the custom action from +: Url of the site or site collection to remove the custom action from. `-s, --scope [scope]` -: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All` +: Scope of the custom action. Allowed values `Site`, `Web`, `All`. Default `All`. `-f, --force` -: Don't prompt for confirming removal of a user custom action +: Don't prompt for confirming removal of a user custom action. ``` <Global /> @@ -37,54 +37,58 @@ If the command finds multiple user custom actions with the specified title, it w ## Examples -Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site or site collection _https://contoso.sharepoint.com/sites/test_ +Removes user custom action with given ID located in the specified site or site collection. ```sh m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test ``` -Removes user custom action with Title _YourAppCustomizer_ located in site or site collection _https://contoso.sharepoint.com/sites/test_ +Removes user custom action with given Title located in the specified site or site collection. ```sh m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test ``` -Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site or site collection _https://contoso.sharepoint.com/sites/test_. Skips the confirmation prompt message. +Removes user custom action with given ID located in the specified site or site collection. Skips the confirmation prompt message. ```sh m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --force ``` -Removes user custom action with Title _YourAppCustomizer_ located in site or site collection _https://contoso.sharepoint.com/sites/test_. Skips the confirmation prompt message. +Removes user custom action with given Title located in the specified site or site collection. Skips the confirmation prompt message. ```sh m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test --force ``` -Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site collection _https://contoso.sharepoint.com/sites/test_ +Removes user custom action with given ID located in the specified site collection. ```sh m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Site ``` -Removes user custom action with Title _YourAppCustomizer_ located in site collection _https://contoso.sharepoint.com/sites/test_ +Removes user custom action with given Title located in site collection _https://contoso.sharepoint.com/sites/test_ ```sh m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test --scope Site ``` -Removes user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site _https://contoso.sharepoint.com/sites/test_ +Removes user custom action with given ID located in the specified site. ```sh m365 spo customaction remove --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Web ``` -Removes user custom action with Title _YourAppCustomizer_ located in site _https://contoso.sharepoint.com/sites/test_ +Removes user custom action with given Title located in the specified site. ```sh m365 spo customaction remove --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test --scope Web ``` +## Response + +The command won't return a response on success. + ## More information - UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) diff --git a/docs/docs/cmd/spo/customaction/customaction-set.mdx b/docs/docs/cmd/spo/customaction/customaction-set.mdx index 58f0c8e9020..b357279d6d5 100644 --- a/docs/docs/cmd/spo/customaction/customaction-set.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-set.mdx @@ -14,61 +14,61 @@ m365 spo customaction set [options] ```md definition-list `-u, --webUrl <webUrl>` -: Url of the site or site collection to update the custom action +: Url of the site or site collection to update the custom action.. `-i, --id <id>` -: ID of the custom action to update +: ID of the custom action to update. `-n, --name [name]` -: The name of the custom action +: The name of the custom action. `-t, --title [title]` -: The title of the custom action +: The title of the custom action. `-l, --location [location]` -: The actual location where this custom action need to be added like `CommandUI.Ribbon` +: The actual location where this custom action need to be added like `CommandUI.Ribbon`. `-g, --group [group]` -: The group of the custom action like `SiteActions` +: The group of the custom action like `SiteActions`. `-d, --description [description]` -: The description of the custom action +: The description of the custom action. `--sequence [sequence]` -: Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page +: Sequence of this CustomAction being injected. Use when you have a specific sequence with which to have multiple CustomActions being added to the page. `--actionUrl [actionUrl]` -: The URL, URI or JavaScript function associated with the action. URL example `~site/_layouts/sampleurl.aspx` or `~sitecollection/_layouts/sampleurl.aspx` +: The URL, URI or JavaScript function associated with the action. URL example `~site/_layouts/sampleurl.aspx` or `~sitecollection/_layouts/sampleurl.aspx`. `--imageUrl [imageUrl]` -: The URL of the image associated with the custom action +: The URL of the image associated with the custom action. `-e, --commandUIExtension [commandUIExtension]` -: XML fragment that determines user interface properties of the custom action +: XML fragment that determines user interface properties of the custom action. `--registrationId [registrationId]` -: Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier +: Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier. `--registrationType [registrationType]` -: Specifies the type of object associated with the custom action. Allowed values `None`, `List`, `ContentType`, `ProgId`, `FileType`. Default `None` +: Specifies the type of object associated with the custom action. Allowed values `None`, `List`, `ContentType`, `ProgId`, `FileType`. Default `None`. `--rights [rights]` -: A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `ViewListItems`, `AddListItems`, `EditListItems`, `DeleteListItems`, `ApproveItems`, `OpenItems`, `ViewVersions`, `DeleteVersions`, `CancelCheckout`, `ManagePersonalViews`, `ManageLists`, `ViewFormPages`, `AnonymousSearchAccessList`, `Open`, `ViewPages`, `AddAndCustomizePages`, `ApplyThemeAndBorder`, `ApplyStyleSheets`, `ViewUsageData`, `CreateSSCSite`, `ManageSubwebs`, `CreateGroups`, `ManagePermissions`, `BrowseDirectories`, `BrowseUserInfo`, `AddDelPrivateWebParts`, `UpdatePersonalWebParts`, `ManageWeb`, `AnonymousSearchAccessWebLists`, `UseClientIntegration`, `UseRemoteAPIs`, `ManageAlerts`, `CreateAlerts`, `EditMyUserInfo`, `EnumeratePermissions`, `FullMask`. Default `EmptyMask` +: A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `ViewListItems`, `AddListItems`, `EditListItems`, `DeleteListItems`, `ApproveItems`, `OpenItems`, `ViewVersions`, `DeleteVersions`, `CancelCheckout`, `ManagePersonalViews`, `ManageLists`, `ViewFormPages`, `AnonymousSearchAccessList`, `Open`, `ViewPages`, `AddAndCustomizePages`, `ApplyThemeAndBorder`, `ApplyStyleSheets`, `ViewUsageData`, `CreateSSCSite`, `ManageSubwebs`, `CreateGroups`, `ManagePermissions`, `BrowseDirectories`, `BrowseUserInfo`, `AddDelPrivateWebParts`, `UpdatePersonalWebParts`, `ManageWeb`, `AnonymousSearchAccessWebLists`, `UseClientIntegration`, `UseRemoteAPIs`, `ManageAlerts`, `CreateAlerts`, `EditMyUserInfo`, `EnumeratePermissions`, `FullMask`. Default `EmptyMask`. `-s, --scope [scope]` : Scope of the existing custom action. Allowed values `Site`, `Web`, `All`. Default `All`. Note, this would not update the scope, but might speed up the execution of the scope of the custom action is known. `--scriptBlock [scriptBlock]` -: Specifies a block of script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink +: Specifies a block of script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink. `--scriptSrc [scriptSrc]` -: Specifies a file that contains script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink +: Specifies a file that contains script to be executed. This attribute is only applicable when the Location attribute is set to ScriptLink. `-c, --clientSideComponentId [clientSideComponentId]` -: The Client Side Component Id (GUID) of the custom action +: The Client Side Component Id (GUID) of the custom action. `-p, --clientSideComponentProperties [clientSideComponentProperties]` -: The Client Side Component Properties of the custom action. Specify values as a JSON string : `'{"testMessage":"Test message"}'` +: The Client Side Component Properties of the custom action. Specify values as a JSON string : `'{"testMessage":"Test message"}'`. ``` <Global /> @@ -93,36 +93,40 @@ When using the `--clientSideComponentProperties` option it's possible to enter a ## Examples -Updates tenant-wide SharePoint Framework Application Customizer extension properties in site _https://contoso.sharepoint.com/sites/test_ +Updates tenant-wide SharePoint Framework Application Customizer extension properties in the specified site. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{"testMessage":"Test message"}' ``` -Updates tenant-wide SharePoint Framework **modern List View** Command Set extension in site _https://contoso.sharepoint.com/sites/test_ +Updates tenant-wide SharePoint Framework **modern List View** Command Set extension in the specified site. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}' --sequence 100 ``` -Updates url custom action in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_ +Updates url custom action in the SiteActions menu in the specified site. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --actionUrl "~site/SitePages/Home.aspx" ``` -Updates ScriptLink custom action with script source in **classic pages** in site collection _https://contoso.sharepoint.com/sites/test_ +Updates ScriptLink custom action with script source in **classic pages** in the specified site collection. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --scriptSrc "~sitecollection/SiteAssets/YourScript.js" ``` -Creates custom action with delegated rights in the SiteActions menu in site _https://contoso.sharepoint.com/sites/test_ +Creates custom action with delegated rights in the SiteActions menu in the specified site. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --rights "AddListItems,DeleteListItems,ManageLists" ``` +## Response + +The command won't return a response on success. + ## More information - UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction) diff --git a/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx b/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx index 8c498ab3d17..37f0eb493cb 100644 --- a/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx +++ b/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx @@ -41,34 +41,34 @@ m365 spo eventreceiver get [options] ## Examples -Retrieve event receivers in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_. +Retrieve event receiver in the specified web with given name. ```sh -m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver' +m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver' ``` -Retrieve event receivers in site _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_. +Retrieve event receiver in the specified site with given id. ```sh -m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec +m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec ``` -Retrieve event receivers for list with title _Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_. +Retrieve event receiver for list with given title in the specified web with given name. ```sh -m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver' +m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver' ``` -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_. +Retrieve event receiver for list with given ID in the specified web with given id. ```sh -m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec +m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec ``` -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_. +Retrieve event receiver for list with given url in the specified web with given name. ```sh -m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver' +m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver' ``` ## Response @@ -112,8 +112,23 @@ m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contos ``` </TabItem> -</Tabs> - - - + <TabItem value="Markdown"> + + ```md + # spo eventreceiver get --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --id "c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec" + + Date: 10/2/2023 + + Property | Value + ---------|------- + ReceiverAssembly | Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c + ReceiverClass | Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver + ReceiverId | c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec + ReceiverName | PnP Test Receiver + SequenceNumber | 10000 + Synchronization | 2 + EventType | 10204 + ``` + </TabItem> +</Tabs> diff --git a/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx b/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx index daa94be987f..f1fd3eabe18 100644 --- a/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx +++ b/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx @@ -33,32 +33,91 @@ m365 spo eventreceiver list [options] ## Examples -Retrieves event receivers in web _<https://contoso.sharepoint.com/sites/contoso-sales>_. +Retrieves event receivers in the specified web. ```sh m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales ``` -Retrieves event receivers in site _<https://contoso.sharepoint.com/sites/contoso-sales>_. +Retrieves event receivers in the specified site. ```sh m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site ``` -Retrieves event receivers for list with title _Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_. +Retrieves event receivers for list with given title in the specified web. ```sh m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events ``` -Retrieves event receivers for list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_. +Retrieves event receivers for list with given ID in the specified web. ```sh m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' ``` -Retrieves event receivers for list with url _/sites/contoso-sales/lists/Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_. +Retrieves event receivers for list with given url in the specified web. ```sh m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' ``` + +## Response + +<Tabs> + <TabItem value="JSON"> + + ```json + [ + { + "ReceiverAssembly": "Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c", + "ReceiverClass": "Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver", + "ReceiverId": "c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec", + "ReceiverName": "PnP Test Receiver", + "SequenceNumber": 10000, + "Synchronization": 2, + "EventType": 10204, + "ReceiverUrl": "https://northeurope1-0.pushnp.svc.ms/notifications?token=b4c0def2-a5ea-490a-bb85-c2e423b1384b" + } + ] + ``` + + </TabItem> + <TabItem value="Text"> + + ```text + ReceiverId ReceiverName + ------------------------------------ ------------------------------------------------------------------------- + c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec PnP Test Receiver + ``` + + </TabItem> + <TabItem value="CSV"> + + ```csv + ReceiverAssembly,ReceiverClass,ReceiverId,ReceiverName,SequenceNumber,Synchronization,EventType + "Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c",Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver,c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec,PnP Test Receiver,10000,2,10204 + ``` + + </TabItem> + <TabItem value="Markdown"> + + ```md + # spo eventreceiver list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" + + Date: 10/2/2023 + + Property | Value + ---------|------- + ReceiverAssembly | Microsoft.Office.Server.UserProfiles, Version=16.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c + ReceiverClass | Microsoft.Office.Server.UserProfiles.ContentFollowingWebEventReceiver + ReceiverId | c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec + ReceiverName | PnP Test Receiver + SequenceNumber | 10000 + Synchronization | 2 + EventType | 10204 + ``` + + </TabItem> +</Tabs> diff --git a/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.mdx b/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.mdx index 66eeb282307..4ca47d2c110 100644 --- a/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.mdx +++ b/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.mdx @@ -79,3 +79,7 @@ Remove event receiver in a specific list retrieved by list url by name. ```sh m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver' ``` + +## Response + +The command won't return a response on success. From 63bed7a680d2ca5ae2c42891ec27ccbdfd7e845a Mon Sep 17 00:00:00 2001 From: Nanddeep Nachan <nanddeepnachan@gmail.com> Date: Wed, 4 Oct 2023 11:33:58 +0000 Subject: [PATCH 2/3] review comments --- docs/docs/cmd/aad/m365group/m365group-add.mdx | 2 +- docs/docs/cmd/aad/user/user-add.mdx | 2 +- docs/docs/cmd/planner/task/task-add.mdx | 2 +- docs/docs/cmd/spo/app/app-add.mdx | 6 +++--- docs/docs/cmd/spo/app/app-deploy.mdx | 2 +- docs/docs/cmd/spo/app/app-get.mdx | 2 +- docs/docs/cmd/spo/app/app-install.mdx | 2 +- docs/docs/cmd/spo/app/app-list.mdx | 2 +- docs/docs/cmd/spo/app/app-remove.mdx | 2 +- docs/docs/cmd/spo/app/app-retract.mdx | 2 +- docs/docs/cmd/spo/app/app-uninstall.mdx | 2 +- docs/docs/cmd/spo/app/app-upgrade.mdx | 2 +- docs/docs/cmd/spo/cdn/cdn-set.mdx | 2 +- docs/docs/cmd/spo/contenttype/contenttype-set.mdx | 2 +- .../docs/cmd/spo/customaction/customaction-add.mdx | 14 +++++++------- .../docs/cmd/spo/customaction/customaction-set.mdx | 2 +- .../cmd/spo/eventreceiver/eventreceiver-get.mdx | 10 +++++----- .../cmd/spo/eventreceiver/eventreceiver-list.mdx | 8 ++++---- docs/docs/cmd/spo/file/file-copy.mdx | 2 +- docs/docs/cmd/spo/file/file-move.mdx | 2 +- docs/docs/cmd/spo/folder/folder-copy.mdx | 2 +- docs/docs/cmd/spo/folder/folder-move.mdx | 2 +- .../cmd/tenant/security/security-alerts-list.mdx | 2 +- docs/docs/cmd/todo/task/task-add.mdx | 6 +++--- docs/docs/cmd/todo/task/task-set.mdx | 4 ++-- 25 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/docs/cmd/aad/m365group/m365group-add.mdx b/docs/docs/cmd/aad/m365group/m365group-add.mdx index e725ae72472..d18b7923c4c 100644 --- a/docs/docs/cmd/aad/m365group/m365group-add.mdx +++ b/docs/docs/cmd/aad/m365group/m365group-add.mdx @@ -31,7 +31,7 @@ m365 aad m365group add [options] : Comma-separated list of Microsoft 365 Group members `--visibility [visibility]` -: Specifies the group join policy and group content visibility for groups. Possible values are: `Private`, `Public`, or `HiddenMembership`. Defaults to `Public`. +: Specifies the group join policy and group content visibility for groups. Allowed values: `Private`, `Public`, or `HiddenMembership`. Defaults to `Public`. `--allowMembersToPost [allowMembersToPost]` : Set if only group members should be able to post conversations to the group diff --git a/docs/docs/cmd/aad/user/user-add.mdx b/docs/docs/cmd/aad/user/user-add.mdx index 93cc9ff10bc..0027fe10f9b 100644 --- a/docs/docs/cmd/aad/user/user-add.mdx +++ b/docs/docs/cmd/aad/user/user-add.mdx @@ -22,7 +22,7 @@ m365 aad user add [options] : The user principal name (someuser@contoso.com). `--accountEnabled [accountEnabled]` -: Whether the account is enabled. Possible values: `true`, `false`. Default value is `true`. +: Whether the account is enabled. Allowed values: `true`, `false`. Defaults to `true`. `--mailNickname [mailNickname]` : The mail alias for the user. By default this value will be extracted from `userName`. diff --git a/docs/docs/cmd/planner/task/task-add.mdx b/docs/docs/cmd/planner/task/task-add.mdx index 341c59d4a6d..93c2f2fa2b6 100644 --- a/docs/docs/cmd/planner/task/task-add.mdx +++ b/docs/docs/cmd/planner/task/task-add.mdx @@ -64,7 +64,7 @@ m365 planner task add [options] : Comma-separated categories that should be added to the task. The possible options are: `category1`, `category2`, `category3`, `category4`, `category5` and/or `category6`. Additional info defined [here](https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0). `--previewType [previewType]` -: This sets the type of preview that shows up on the task. The possible values are: `automatic`, `noPreview`, `checklist`, `description`, `reference`. When set to automatic the displayed preview is chosen by the app viewing the task. Default `automatic`. +: This sets the type of preview that shows up on the task. Allowed values: `automatic`, `noPreview`, `checklist`, `description`, `reference`. When set to automatic the displayed preview is chosen by the app viewing the task. Defaults to `automatic`. `--orderHint [orderHint]` : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0). diff --git a/docs/docs/cmd/spo/app/app-add.mdx b/docs/docs/cmd/spo/app/app-add.mdx index 75371618514..02b187d5a08 100644 --- a/docs/docs/cmd/spo/app/app-add.mdx +++ b/docs/docs/cmd/spo/app/app-add.mdx @@ -20,7 +20,7 @@ m365 spo app add [options] : Set to overwrite the existing package file. `-s, --appCatalogScope [appCatalogScope]` -: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. +: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`. `-u, --appCatalogUrl [appCatalogUrl]` : The URL of the app catalog where the solution package will be added. It must be specified when the scope is `sitecollection`. @@ -40,7 +40,7 @@ If you try to upload a package that already exists in the app catalog without sp ## Examples -Add the package from relative path to the tenant app catalog. +Add the package to the tenant app catalog. ```sh m365 spo app add --filePath /Users/pnp/spfx/sharepoint/solution/spfx.sppkg @@ -52,7 +52,7 @@ Overwrite the package in the tenant app catalog with the newer version. m365 spo app add --filePath sharepoint/solution/spfx.sppkg --overwrite ``` -Add the package from absolute path to the site collection app catalog of the specified site. +Add the package to the site collection app catalog of the specified site. ```sh m365 spo app add --filePath c:\spfx.sppkg --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1 diff --git a/docs/docs/cmd/spo/app/app-deploy.mdx b/docs/docs/cmd/spo/app/app-deploy.mdx index 25b7a3262fc..f9079d91517 100644 --- a/docs/docs/cmd/spo/app/app-deploy.mdx +++ b/docs/docs/cmd/spo/app/app-deploy.mdx @@ -26,7 +26,7 @@ m365 spo app deploy [options] : If the app supports tenant-wide deployment, deploy it to the whole tenant. `-s, --appCatalogScope [appCatalogScope]` -: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. +: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`. ``` <Global /> diff --git a/docs/docs/cmd/spo/app/app-get.mdx b/docs/docs/cmd/spo/app/app-get.mdx index 4fc7225d176..fb3aa3f029c 100644 --- a/docs/docs/cmd/spo/app/app-get.mdx +++ b/docs/docs/cmd/spo/app/app-get.mdx @@ -23,7 +23,7 @@ m365 spo app get [options] : 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. Possible values are: `tenant`, `sitecollection`. Default `tenant`. +: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`. ``` <Global /> diff --git a/docs/docs/cmd/spo/app/app-install.mdx b/docs/docs/cmd/spo/app/app-install.mdx index 00906f8428a..78976b82e2e 100644 --- a/docs/docs/cmd/spo/app/app-install.mdx +++ b/docs/docs/cmd/spo/app/app-install.mdx @@ -20,7 +20,7 @@ m365 spo app install [options] : Absolute URL of the site to install the app in. `--appCatalogScope [appCatalogScope]` -: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. +: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`. ``` <Global /> diff --git a/docs/docs/cmd/spo/app/app-list.mdx b/docs/docs/cmd/spo/app/app-list.mdx index 5fbb3a38a0e..0ebc4ac35f0 100644 --- a/docs/docs/cmd/spo/app/app-list.mdx +++ b/docs/docs/cmd/spo/app/app-list.mdx @@ -14,7 +14,7 @@ m365 spo app list [options] ```md definition-list `-s, --appCatalogScope [appCatalogScope]` -: Target app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. +: Target app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`. `-u, --appCatalogUrl [appCatalogUrl]` : URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection`. diff --git a/docs/docs/cmd/spo/app/app-remove.mdx b/docs/docs/cmd/spo/app/app-remove.mdx index 23191bc2f62..43e6da6fd39 100644 --- a/docs/docs/cmd/spo/app/app-remove.mdx +++ b/docs/docs/cmd/spo/app/app-remove.mdx @@ -20,7 +20,7 @@ m365 spo app remove [options] : 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. Possible values are: `tenant`, `sitecollection`. Default `tenant`. +: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`. `-f, --force` : Don't prompt for confirming removing the app. diff --git a/docs/docs/cmd/spo/app/app-retract.mdx b/docs/docs/cmd/spo/app/app-retract.mdx index 99b66c570c6..f12be0daa31 100644 --- a/docs/docs/cmd/spo/app/app-retract.mdx +++ b/docs/docs/cmd/spo/app/app-retract.mdx @@ -20,7 +20,7 @@ m365 spo app retract [options] : 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. Possible values are: `tenant`, `sitecollection`. Default `tenant`. +: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`. `-f, --force` : Don't prompt for confirming retracting the app. diff --git a/docs/docs/cmd/spo/app/app-uninstall.mdx b/docs/docs/cmd/spo/app/app-uninstall.mdx index ead65bb52ea..58e41ef968d 100644 --- a/docs/docs/cmd/spo/app/app-uninstall.mdx +++ b/docs/docs/cmd/spo/app/app-uninstall.mdx @@ -20,7 +20,7 @@ m365 spo app uninstall [options] : Absolute URL of the site to uninstall the app from. `--appCatalogScope [appCatalogScope]` -: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. +: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Default to `tenant`. `-f, --force` : Don't prompt for confirming uninstalling the app. diff --git a/docs/docs/cmd/spo/app/app-upgrade.mdx b/docs/docs/cmd/spo/app/app-upgrade.mdx index da2db46703b..c23db4b0e75 100644 --- a/docs/docs/cmd/spo/app/app-upgrade.mdx +++ b/docs/docs/cmd/spo/app/app-upgrade.mdx @@ -20,7 +20,7 @@ m365 spo app upgrade [options] : Absolute URL of the site to upgrade the app in. `--appCatalogScope [appCatalogScope]` -: Scope of the app catalog. Possible values are: `tenant`, `sitecollection`. Default `tenant`. +: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`. ``` <Global /> diff --git a/docs/docs/cmd/spo/cdn/cdn-set.mdx b/docs/docs/cmd/spo/cdn/cdn-set.mdx index 78a25abe05a..4b3ba994c98 100644 --- a/docs/docs/cmd/spo/cdn/cdn-set.mdx +++ b/docs/docs/cmd/spo/cdn/cdn-set.mdx @@ -17,7 +17,7 @@ m365 spo cdn set [options] : Set to true to enable CDN or to false to disable it. Valid values are `true`, `false`. `-t, --type [type]` -: Type of CDN to manage. Possible values are: `Public`, `Private`, `Both`. Default `Public`. +: Type of CDN to manage. Allowed values: `Public`, `Private`, `Both`. Defaults to `Public`. `--noDefaultOrigins` : pass to not create the default origins. diff --git a/docs/docs/cmd/spo/contenttype/contenttype-set.mdx b/docs/docs/cmd/spo/contenttype/contenttype-set.mdx index f860a04ec84..98d192c494b 100644 --- a/docs/docs/cmd/spo/contenttype/contenttype-set.mdx +++ b/docs/docs/cmd/spo/contenttype/contenttype-set.mdx @@ -20,7 +20,7 @@ m365 spo contenttype set [options] : ID of the content type to update. Specify either `id` or `name` but not both. `-n, --name [name]` -: Name of the content type to update. Specify either `id` or the `name` but not both. +: Name of the content type to update. Specify either `id` or `name` but not both. `--listTitle [listTitle]` : Title of the list if you want to update a list content type. Specify either `listTitle`, `listId` or `listUrl`. diff --git a/docs/docs/cmd/spo/customaction/customaction-add.mdx b/docs/docs/cmd/spo/customaction/customaction-add.mdx index 11e968bfdec..e224c967cde 100644 --- a/docs/docs/cmd/spo/customaction/customaction-add.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-add.mdx @@ -90,13 +90,13 @@ When using the `--clientSideComponentProperties` option it's possible to enter a ## Examples -Adds tenant-wide SharePoint Framework Application Customizer extension in the specified site. +Adds a tenant-wide SharePoint Framework Application Customizer extension in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --name "YourName" --location "ClientSideExtension.ApplicationCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{"testMessage":"Test message"}' ``` -Adds tenant-wide SharePoint Framework **modern List View** Command Set extension in the specified site. +Adds a tenant-wide SharePoint Framework **modern List View** Command Set extension in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourCommandSet" --name "YourName" --location "ClientSideExtension.ListViewCommandSet" --clientSideComponentId db3e6e35-363c-42b9-a254-ca661e437848 --clientSideComponentProperties '{"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}' --registrationId 100 --registrationType List @@ -108,31 +108,31 @@ Creates url custom action in the SiteActions menu in the specified site. m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "Microsoft.SharePoint.StandardMenu" --group "SiteActions" --actionUrl "~site/SitePages/Home.aspx" --sequence 100 ``` -Creates custom action in **classic** Document Library edit context menu in the specified site. +Creates a custom action in the **classic** Document Library edit context menu on the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "EditControlBlock" --actionUrl "javascript:(function(){ return console.log('CLI for Microsoft 365 rocks!'); })();" --registrationId 101 --registrationType List ``` -Creates ScriptLink custom action with script source in **classic pages** in the specified site collection. +Creates a ScriptLink custom action with script source in **classic pages** in the specified site collection. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "ScriptLink" --scriptSrc "~sitecollection/SiteAssets/YourScript.js" --sequence 101 --scope Site ``` -Creates ScriptLink custom action with script block in **classic pages** in the specified site. +Creates a ScriptLink custom action with script block in **classic pages** in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "ScriptLink" --scriptBlock "(function(){ return console.log('Hello CLI for Microsoft 365!'); })();" --sequence 102 ``` -Creates **classic List View** custom action located in the Ribbon in the specified site. +Creates a **classic List View** custom action located in the Ribbon in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "CommandUI.Ribbon" --commandUIExtension '<CommandUIExtension><CommandUIDefinitions><CommandUIDefinition Location="Ribbon.List.Share.Controls._children"><Button Id="Ribbon.List.Share.GetItemsCountButton" Alt="Get list items count" Sequence="11" Command="Invoke_GetItemsCountButtonRequest" LabelText="Get Items Count" TemplateAlias="o1" Image32by32="_layouts/15/images/placeholder32x32.png" Image16by16="_layouts/15/images/placeholder16x16.png" /></CommandUIDefinition></CommandUIDefinitions><CommandUIHandlers><CommandUIHandler Command="Invoke_GetItemsCountButtonRequest" CommandAction="javascript: alert(ctx.TotalListItems);" EnabledScript="javascript: function checkEnable() { return (true);} checkEnable();"/></CommandUIHandlers></CommandUIExtension>' ``` -Creates custom action with delegated rights in the SiteActions menu in the specified site. +Creates a custom action with delegated rights in the SiteActions menu in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "Microsoft.SharePoint.StandardMenu" --group "SiteActions" --actionUrl "~site/SitePages/Home.aspx" --rights "AddListItems,DeleteListItems,ManageLists" diff --git a/docs/docs/cmd/spo/customaction/customaction-set.mdx b/docs/docs/cmd/spo/customaction/customaction-set.mdx index b357279d6d5..609459f30e8 100644 --- a/docs/docs/cmd/spo/customaction/customaction-set.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-set.mdx @@ -14,7 +14,7 @@ m365 spo customaction set [options] ```md definition-list `-u, --webUrl <webUrl>` -: Url of the site or site collection to update the custom action.. +: Url of the site or site collection to update the custom action. `-i, --id <id>` : ID of the custom action to update. diff --git a/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx b/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx index 37f0eb493cb..a02c6359390 100644 --- a/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx +++ b/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx @@ -41,31 +41,31 @@ m365 spo eventreceiver get [options] ## Examples -Retrieve event receiver in the specified web with given name. +Retrieve an event receiver in the specified web with the given name. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver' ``` -Retrieve event receiver in the specified site with given id. +Retrieve an event receiver in the specified site with the given id. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec ``` -Retrieve event receiver for list with given title in the specified web with given name. +Retrieve an event receiver for list with given title in the specified web with the given name. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver' ``` -Retrieve event receiver for list with given ID in the specified web with given id. +Retrieve an event receiver for list with given ID in the specified web with the given id. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec ``` -Retrieve event receiver for list with given url in the specified web with given name. +Retrieve an event receiver for list with given url in the specified web with the given name. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver' diff --git a/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx b/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx index f1fd3eabe18..2d9f4219566 100644 --- a/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx +++ b/docs/docs/cmd/spo/eventreceiver/eventreceiver-list.mdx @@ -33,7 +33,7 @@ m365 spo eventreceiver list [options] ## Examples -Retrieves event receivers in the specified web. +Retrieves event receivers in the specified site. ```sh m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales @@ -45,19 +45,19 @@ Retrieves event receivers in the specified site. m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site ``` -Retrieves event receivers for list with given title in the specified web. +Retrieves event receivers for list with given title in the specified site. ```sh m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events ``` -Retrieves event receivers for list with given ID in the specified web. +Retrieves event receivers for list with given ID in the specified site. ```sh m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' ``` -Retrieves event receivers for list with given url in the specified web. +Retrieves event receivers for list with given url in the specified site. ```sh m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' diff --git a/docs/docs/cmd/spo/file/file-copy.mdx b/docs/docs/cmd/spo/file/file-copy.mdx index 0ba024a71ed..f795ed8bb52 100644 --- a/docs/docs/cmd/spo/file/file-copy.mdx +++ b/docs/docs/cmd/spo/file/file-copy.mdx @@ -29,7 +29,7 @@ m365 spo file copy [options] : New name of the destination file. `--nameConflictBehavior [nameConflictBehavior]` -: Behavior when a document with the same name is already present at the destination. Possible values: `fail`, `replace`, `rename`. Default is `fail`. +: Behavior when a document with the same name is already present at the destination. Allowed values: `fail`, `replace`, `rename`. Defaults to `fail`. `--resetAuthorAndCreated` : Use this option to clear the author and created date. When not specified, the values from the source file are used. diff --git a/docs/docs/cmd/spo/file/file-move.mdx b/docs/docs/cmd/spo/file/file-move.mdx index 3b1942f66e7..abfe0808819 100644 --- a/docs/docs/cmd/spo/file/file-move.mdx +++ b/docs/docs/cmd/spo/file/file-move.mdx @@ -29,7 +29,7 @@ m365 spo file move [options] : The new name of the destination file. `--nameConflictBehavior [nameConflictBehavior]` -: Behavior when a file or folder with the same name is already present at the destination. Possible values: `fail`, `replace`, `rename`. The default is `fail`. +: Behavior when a file or folder with the same name is already present at the destination. Allowed values: `fail`, `replace`, `rename`. Defaults to `fail`. `--retainEditorAndModified` : Use this option to retain the editor and modified date. When not specified, these values are reset when moving to another library. diff --git a/docs/docs/cmd/spo/folder/folder-copy.mdx b/docs/docs/cmd/spo/folder/folder-copy.mdx index cdb0c538195..732b913e4c1 100644 --- a/docs/docs/cmd/spo/folder/folder-copy.mdx +++ b/docs/docs/cmd/spo/folder/folder-copy.mdx @@ -29,7 +29,7 @@ m365 spo folder copy [options] : New name of the destination folder. `--nameConflictBehavior [nameConflictBehavior]` -: Behavior when a file or folder with the same name is already present at the destination. Possible values: `fail`, `rename`. The default is `fail`. +: Behavior when a file or folder with the same name is already present at the destination. Allowed values: `fail`, `rename`. Defaults to `fail`. `--resetAuthorAndCreated` : Use this option to clear the author and created date. When not specified, the values from the source folder are used. diff --git a/docs/docs/cmd/spo/folder/folder-move.mdx b/docs/docs/cmd/spo/folder/folder-move.mdx index 4d15f9233c9..c0e959a8a55 100644 --- a/docs/docs/cmd/spo/folder/folder-move.mdx +++ b/docs/docs/cmd/spo/folder/folder-move.mdx @@ -29,7 +29,7 @@ m365 spo folder move [options] : The new name of the destination folder. `--nameConflictBehavior [nameConflictBehavior]` -: Behavior when a file or folder with the same name is already present at the destination. Possible values: `fail`, `rename`. The default is `fail`. +: Behavior when a file or folder with the same name is already present at the destination. Allowed values: `fail`, `rename`. Defaults to `fail`. `--retainEditorAndModified` : Use this option to retain the editor and modified date. When not specified, these values are reset. diff --git a/docs/docs/cmd/tenant/security/security-alerts-list.mdx b/docs/docs/cmd/tenant/security/security-alerts-list.mdx index b1f7085d8fa..5956e925075 100644 --- a/docs/docs/cmd/tenant/security/security-alerts-list.mdx +++ b/docs/docs/cmd/tenant/security/security-alerts-list.mdx @@ -16,7 +16,7 @@ m365 tenant security alerts list [options] ```md definition-list `--vendor [vendor]` -: The vendor to return alerts for. Possible values `Azure Advanced Threat Protection`, `Azure Security Center`, `Microsoft Cloud App Security`, `Azure Active Directory Identity Protection`, `Azure Sentinel`, `Microsoft Defender ATP`. If omitted, all alerts are returned +: The vendor to return alerts for. Allowed values: `Azure Advanced Threat Protection`, `Azure Security Center`, `Microsoft Cloud App Security`, `Azure Active Directory Identity Protection`, `Azure Sentinel`, `Microsoft Defender ATP`. If omitted, all alerts are returned. ``` <Global /> diff --git a/docs/docs/cmd/todo/task/task-add.mdx b/docs/docs/cmd/todo/task/task-add.mdx index 30750579329..f6d68ba5d78 100644 --- a/docs/docs/cmd/todo/task/task-add.mdx +++ b/docs/docs/cmd/todo/task/task-add.mdx @@ -28,13 +28,13 @@ m365 todo task add [options] : The body content of the task. In the UI this is called 'notes'. `--bodyContentType [bodyContentType]` -: The type of the body content. Possible values are `text` and `html`. Default is `text`. +: The type of the body content. Allowed values: `text` and `html`. Defaults to `text`. `--dueDateTime [dueDateTime]` : The date when the task is due. This should be defined as a valid ISO 8601 string in the UTC time zone. Only date value is needed, time value is always ignored. `--importance [importance]` -: The importance of the task. Possible values are: `low`, `normal`, `high`. Default is `normal`. +: The importance of the task. Allowed values: `low`, `normal`, `high`. Defaults to `normal`. `--reminderDateTime [reminderDateTime]` : The date and time for a reminder alert of the task to occur. This should be defined as a valid ISO 8601 string in the UTC time zone. @@ -49,7 +49,7 @@ m365 todo task add [options] : The date and time when the task is scheduled to start. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z` `--status [status]` -: Indicates the state or progress of the task. The possible values are: `notStarted`, `inProgress`, `completed`, `waitingOnOthers`, `deferred`. +: Indicates the state or progress of the task. Allowed values: `notStarted`, `inProgress`, `completed`, `waitingOnOthers`, `deferred`. ``` <Global /> diff --git a/docs/docs/cmd/todo/task/task-set.mdx b/docs/docs/cmd/todo/task/task-set.mdx index 4d33f00adbe..7d194a006a7 100644 --- a/docs/docs/cmd/todo/task/task-set.mdx +++ b/docs/docs/cmd/todo/task/task-set.mdx @@ -34,10 +34,10 @@ m365 todo task set [options] : The body content of the task. In the UI this is called 'notes'. `--bodyContentType [bodyContentType]` -: The type of the body content. Possible values are `text` and `html`. Default is `text`. +: The type of the body content. Allowed values: `text` and `html`. Defaults to `text`. `--importance [importance]` -: The importance of the task. Possible values are: `low`, `normal`, `high`. +: The importance of the task. Allowed values: `low`, `normal`, `high`. `--dueDateTime [dueDateTime]` : The date and time when the task is due. This should be defined as a valid ISO 8601 string in the UTC time zone. Only date value is needed, time value is always ignored. From b3de7353d23aaa6b6ed329d9f03dc8d177e16dc7 Mon Sep 17 00:00:00 2001 From: Nanddeep Nachan <nanddeepnachan@gmail.com> Date: Wed, 4 Oct 2023 15:22:04 +0000 Subject: [PATCH 3/3] review comments --- docs/docs/cmd/spo/app/app-uninstall.mdx | 2 +- docs/docs/cmd/spo/cdn/cdn-set.mdx | 2 +- .../docs/cmd/spo/customaction/customaction-add.mdx | 2 +- .../docs/cmd/spo/customaction/customaction-set.mdx | 14 +++++++------- .../cmd/spo/eventreceiver/eventreceiver-get.mdx | 10 +++++----- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/docs/cmd/spo/app/app-uninstall.mdx b/docs/docs/cmd/spo/app/app-uninstall.mdx index 58e41ef968d..fda0c2243d4 100644 --- a/docs/docs/cmd/spo/app/app-uninstall.mdx +++ b/docs/docs/cmd/spo/app/app-uninstall.mdx @@ -20,7 +20,7 @@ m365 spo app uninstall [options] : Absolute URL of the site to uninstall the app from. `--appCatalogScope [appCatalogScope]` -: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Default to `tenant`. +: Scope of the app catalog. Allowed values: `tenant`, `sitecollection`. Defaults to `tenant`. `-f, --force` : Don't prompt for confirming uninstalling the app. diff --git a/docs/docs/cmd/spo/cdn/cdn-set.mdx b/docs/docs/cmd/spo/cdn/cdn-set.mdx index 4b3ba994c98..66050b78b1d 100644 --- a/docs/docs/cmd/spo/cdn/cdn-set.mdx +++ b/docs/docs/cmd/spo/cdn/cdn-set.mdx @@ -14,7 +14,7 @@ m365 spo cdn set [options] ```md definition-list `-e, --enabled <enabled>` -: Set to true to enable CDN or to false to disable it. Valid values are `true`, `false`. +: Set to true to enable CDN or to false to disable it. Allowed values: `true`, `false`. `-t, --type [type]` : Type of CDN to manage. Allowed values: `Public`, `Private`, `Both`. Defaults to `Public`. diff --git a/docs/docs/cmd/spo/customaction/customaction-add.mdx b/docs/docs/cmd/spo/customaction/customaction-add.mdx index e224c967cde..c8218dd5c59 100644 --- a/docs/docs/cmd/spo/customaction/customaction-add.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-add.mdx @@ -102,7 +102,7 @@ Adds a tenant-wide SharePoint Framework **modern List View** Command Set extensi m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourCommandSet" --name "YourName" --location "ClientSideExtension.ListViewCommandSet" --clientSideComponentId db3e6e35-363c-42b9-a254-ca661e437848 --clientSideComponentProperties '{"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}' --registrationId 100 --registrationType List ``` -Creates url custom action in the SiteActions menu in the specified site. +Creates a url custom action in the SiteActions menu in the specified site. ```sh m365 spo customaction add --webUrl https://contoso.sharepoint.com/sites/test --title "YourTitle" --name "YourName" --location "Microsoft.SharePoint.StandardMenu" --group "SiteActions" --actionUrl "~site/SitePages/Home.aspx" --sequence 100 diff --git a/docs/docs/cmd/spo/customaction/customaction-set.mdx b/docs/docs/cmd/spo/customaction/customaction-set.mdx index 609459f30e8..ecfad248955 100644 --- a/docs/docs/cmd/spo/customaction/customaction-set.mdx +++ b/docs/docs/cmd/spo/customaction/customaction-set.mdx @@ -50,10 +50,10 @@ m365 spo customaction set [options] : Specifies the identifier of the list or item content type that this action is associated with, or the file type or programmatic identifier. `--registrationType [registrationType]` -: Specifies the type of object associated with the custom action. Allowed values `None`, `List`, `ContentType`, `ProgId`, `FileType`. Default `None`. +: Specifies the type of object associated with the custom action. Allowed values `None`, `List`, `ContentType`, `ProgId`, `FileType`. Defaults to `None`. `--rights [rights]` -: A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `ViewListItems`, `AddListItems`, `EditListItems`, `DeleteListItems`, `ApproveItems`, `OpenItems`, `ViewVersions`, `DeleteVersions`, `CancelCheckout`, `ManagePersonalViews`, `ManageLists`, `ViewFormPages`, `AnonymousSearchAccessList`, `Open`, `ViewPages`, `AddAndCustomizePages`, `ApplyThemeAndBorder`, `ApplyStyleSheets`, `ViewUsageData`, `CreateSSCSite`, `ManageSubwebs`, `CreateGroups`, `ManagePermissions`, `BrowseDirectories`, `BrowseUserInfo`, `AddDelPrivateWebParts`, `UpdatePersonalWebParts`, `ManageWeb`, `AnonymousSearchAccessWebLists`, `UseClientIntegration`, `UseRemoteAPIs`, `ManageAlerts`, `CreateAlerts`, `EditMyUserInfo`, `EnumeratePermissions`, `FullMask`. Default `EmptyMask`. +: A case-sensitive string array that contain the permissions needed for the custom action. Allowed values `EmptyMask`, `ViewListItems`, `AddListItems`, `EditListItems`, `DeleteListItems`, `ApproveItems`, `OpenItems`, `ViewVersions`, `DeleteVersions`, `CancelCheckout`, `ManagePersonalViews`, `ManageLists`, `ViewFormPages`, `AnonymousSearchAccessList`, `Open`, `ViewPages`, `AddAndCustomizePages`, `ApplyThemeAndBorder`, `ApplyStyleSheets`, `ViewUsageData`, `CreateSSCSite`, `ManageSubwebs`, `CreateGroups`, `ManagePermissions`, `BrowseDirectories`, `BrowseUserInfo`, `AddDelPrivateWebParts`, `UpdatePersonalWebParts`, `ManageWeb`, `AnonymousSearchAccessWebLists`, `UseClientIntegration`, `UseRemoteAPIs`, `ManageAlerts`, `CreateAlerts`, `EditMyUserInfo`, `EnumeratePermissions`, `FullMask`. Defaults to `EmptyMask`. `-s, --scope [scope]` : Scope of the existing custom action. Allowed values `Site`, `Web`, `All`. Default `All`. Note, this would not update the scope, but might speed up the execution of the scope of the custom action is known. @@ -93,31 +93,31 @@ When using the `--clientSideComponentProperties` option it's possible to enter a ## Examples -Updates tenant-wide SharePoint Framework Application Customizer extension properties in the specified site. +Updates a tenant-wide SharePoint Framework Application Customizer extension properties in the specified site. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{"testMessage":"Test message"}' ``` -Updates tenant-wide SharePoint Framework **modern List View** Command Set extension in the specified site. +Updates a tenant-wide SharePoint Framework **modern List View** Command Set extension in the specified site. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}' --sequence 100 ``` -Updates url custom action in the SiteActions menu in the specified site. +Updates a url custom action in the SiteActions menu in the specified site. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --actionUrl "~site/SitePages/Home.aspx" ``` -Updates ScriptLink custom action with script source in **classic pages** in the specified site collection. +Updates a ScriptLink custom action with script source in **classic pages** in the specified site collection. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --scriptSrc "~sitecollection/SiteAssets/YourScript.js" ``` -Creates custom action with delegated rights in the SiteActions menu in the specified site. +Creates a custom action with delegated rights in the SiteActions menu in the specified site. ```sh m365 spo customaction set --webUrl https://contoso.sharepoint.com/sites/test --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --rights "AddListItems,DeleteListItems,ManageLists" diff --git a/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx b/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx index a02c6359390..11db0ed03d0 100644 --- a/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx +++ b/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.mdx @@ -41,31 +41,31 @@ m365 spo eventreceiver get [options] ## Examples -Retrieve an event receiver in the specified web with the given name. +Retrieve an event receiver with the given name in the specified site. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver' ``` -Retrieve an event receiver in the specified site with the given id. +Retrieve an event receiver with the given id in the specified site. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec ``` -Retrieve an event receiver for list with given title in the specified web with the given name. +Retrieve an event receiver with the given name for a list with the given title in the specified site. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver' ``` -Retrieve an event receiver for list with given ID in the specified web with the given id. +Retrieve an event receiver with the given id for a list with the given ID in the specified site. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec ``` -Retrieve an event receiver for list with given url in the specified web with the given name. +Retrieve an event receiver with the given name for a list with the given url in the specified site. ```sh m365 spo eventreceiver get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'