Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Includes response output: spo app until spo eventreceiver commands. Closes #3929 #5540

Closed
wants to merge 3 commits into from
Closed

Includes response output: spo app until spo eventreceiver commands. Closes #3929 #5540

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
03269b6
response output
nanddeepn Oct 2, 2023
63bed7a
review comments
nanddeepn Oct 4, 2023
b3de735
review comments
nanddeepn Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 92 additions & 7 deletions docs/docs/cmd/spo/app/app-add.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ m365 spo app add [options]

```md definition-list
`-p, --filePath <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`.
nanddeepn marked this conversation as resolved.
Show resolved Hide resolved

`-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`.
```

<Global />
Expand All @@ -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.
nanddeepn marked this conversation as resolved.
Show resolved Hide resolved

```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.
nanddeepn marked this conversation as resolved.
Show resolved Hide resolved

```sh
m365 spo app add --filePath c:\spfx.sppkg --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
```

## Response

<Tabs>
<TabItem value="JSON">

```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"
}
```

</TabItem>
<TabItem value="Text">

```text
e0f53330-61ec-4fee-882d-fadfb74b2033
```

</TabItem>
<TabItem value="CSV">

```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
```

</TabItem>
<TabItem value="Markdown">

```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
```

</TabItem>
</Tabs>

## 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)
18 changes: 11 additions & 7 deletions docs/docs/cmd/spo/app/app-deploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
nanddeepn marked this conversation as resolved.
Show resolved Hide resolved
```

<Global />
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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)
123 changes: 115 additions & 8 deletions docs/docs/cmd/spo/app/app-get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
nanddeepn marked this conversation as resolved.
Show resolved Hide resolved
```

<Global />
Expand All @@ -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

<Tabs>
<TabItem value="JSON">

```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"
}
```

</TabItem>
<TabItem value="Text">

```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
```

</TabItem>
<TabItem value="CSV">

```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
```

</TabItem>
<TabItem value="Markdown">

```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
```

</TabItem>
</Tabs>

## 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)
14 changes: 9 additions & 5 deletions docs/docs/cmd/spo/app/app-install.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ m365 spo app install [options]

```md definition-list
`-i, --id <id>`
: ID of the app to install
: ID of the app to install.

`-s, --siteUrl <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`.
```

<Global />
Expand All @@ -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)
Loading