Skip to content

Commit 4e65e89

Browse files
authored
Minor edits to ALM topic (SharePoint#1408)
* Fixed typos Please note that the changes I've made are per standard English conventions and the Microsoft Writing Style Guide, and ensure consistency across our doc set. * Removed redundant words Removed "also" and and changed passive to active in places * Made wording in sections consistent
1 parent 936237b commit 4e65e89

File tree

1 file changed

+31
-32
lines changed

1 file changed

+31
-32
lines changed

docs/apis/alm-api-for-spfx-add-ins.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,27 @@ ms.assetid: fdf7ecb2-8851-425b-b058-3285fba77b68
1010

1111
ALM APIs provide simple APIs to manage deployment of your SharePoint Framework solutions and add-ins across your tenant. ALM APIs support the following capabilities:
1212

13-
- Add SharePoint Framework solution or SharePoint add-in to tenant app catalog
14-
- Enable SharePoint Framework solution or SharePoint add-in to be available for installation in tenant app catalog
15-
- Disable SharePoint Framework solution or SharePoint add-in not to be available for installation in tenant app catalog
16-
- Install SharePoint Framework solution or SharePoint add-in from tenant app catalog to a site
17-
- Upgrade SharePoint Framework solution or SharePoint add-in to a site, which has a newer version available in the tenant app catalog
18-
- Uninstall SharePoint Framework solution or SharePoint add-in from the site
19-
- List all and get details on SharePoint Framework solutions or SharePoint add-ins in the tenant app catalog
13+
- Add SharePoint Framework solution or SharePoint Add-in to tenant app catalog.
14+
- Enable SharePoint Framework solution or SharePoint Add-in to be available for installation in tenant app catalog.
15+
- Disable SharePoint Framework solution or SharePoint Add-in not to be available for installation in tenant app catalog.
16+
- Install SharePoint Framework solution or SharePoint Add-in from tenant app catalog to a site.
17+
- Upgrade SharePoint Framework solution or SharePoint Add-in to a site, which has a newer version available in the tenant app catalog.
18+
- Uninstall SharePoint Framework solution or SharePoint Add-in from the site.
19+
- List all and get details about SharePoint Framework solutions or SharePoint Add-ins in the tenant app catalog.
2020

2121
ALM APIs can be used to perform exactly the same operations that are available from a UI perspective. When these APIs are used, all typical actions are performed. Following are some of the characteristics of ALM APIs:
2222

2323
- `Install` and `UnInstall` events are being fired for provider-hosted add-ins when corresponding operations occur.
2424
- ALM APIs support app-only-based operations.
2525

26-
ALM APIs are natively provided using REST APIs, but there is also additional CSOM extensions, PowerShell cmdlets, and the cross-platform Office 365 CLI available through SharePoint Patterns and Practices.
26+
ALM APIs are natively provided by using REST APIs, but there are additional CSOM extensions, PowerShell cmdlets, and the cross-platform Office 365 CLI available through SharePoint Patterns and Practices.
2727

2828
> [!NOTE]
2929
> ALM APIs are not currently supported for the [site collection app catalog](../general-development/site-collection-app-catalog.md). Support will be added in early 2018.
3030
3131
## REST API
3232

33-
### Add solution package to tenant app catalog
33+
### Add solution package to the tenant app catalog
3434

3535
This API is designed to be executed in the context of the tenant app catalog site.
3636

@@ -58,7 +58,7 @@ Content-Type: 'application/json;odata=nometadata;charset=utf-8'
5858
```
5959

6060
> [!NOTE]
61-
> This operation is required to be completed after Add before you can install packages to specific sites.
61+
> This operation is required to be completed after Add, before you can install packages to specific sites.
6262
6363
### Retract solution packages in the tenant app catalog
6464

@@ -73,7 +73,7 @@ Accept: 'application/json;odata=nometadata'
7373
```
7474

7575
> [!NOTE]
76-
> If you run this operation after you have installed solutions to the site, they will stop working because the solution is disabled from the tenant level.
76+
> If you run this operation after you have installed solutions to the site, they stop working because the solution is disabled from the tenant level.
7777
7878
### Remove solution packages from the tenant app catalog
7979

@@ -100,7 +100,7 @@ Authorization: Bearer <access token>
100100
Accept: 'application/json;odata=nometadata'
101101
```
102102

103-
### Details about individual solution packages in the tenant app catalog
103+
### Get details about individual solution packages in the tenant app catalog
104104

105105
Use this REST API for getting details about individual SharePoint Framework solutions or add-ins available in the tenant app catalog.
106106

@@ -154,14 +154,14 @@ Accept: 'application/json;odata=nometadata'
154154

155155
By using [PnP PowerShell](https://docs.microsoft.com/en-us/powershell/sharepoint/sharepoint-pnp/sharepoint-pnp-cmdlets?view=sharepoint-ps), you can automate deploying, publishing, installing, upgrading, and retracting your apps.
156156

157-
### Adding and publishing your app to the app catalog
158-
Adding your app (.sppkg file, .app file) to the tenant app catalog is a per-requisite to later on make your app available for use in your SharePoint sites. Doing so can be done using the following simple cmdlet:
157+
### Add and publish your app to the app catalog
158+
Adding your app (.sppkg file, .app file) to the tenant app catalog is a prerequisite to making your app available for use on your SharePoint sites. You can do this by using the following cmdlet:
159159

160160
```PowerShell
161161
Add-PnPApp -Path ./myapp.sppkg
162162
```
163163

164-
Once added you'll need to continue with publishing your app, effectively making the app available to be used by the users of your tenant. The following PnP PowerShell cmdlet show how this can be done:
164+
Once added, you need to continue with publishing your app, effectively making the app available to be used by the users of your tenant. The following PnP PowerShell cmdlet shows how this can be done:
165165

166166
```PowerShell
167167
Publish-PnPApp -Identity <app id> -SkipFeatureDeployment
@@ -217,78 +217,77 @@ You can get a list of apps that can be added to the site by using:
217217
Get-PnPApp
218218
```
219219

220-
## Office 365 CLI commands to add, deploy and Manage SharePoint Apps Cross-Platform
220+
## Office 365 CLI commands to add, deploy, and manage SharePoint apps cross-platform
221221

222-
Using the [Office 365 CLI](https://sharepoint.github.io/office365-cli?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) you can automate the deployment, publishing, installing, upgrading and retracting your apps. The Office 365 CLI is a cross-platform command line interface that can be used on any platform, including Windows, MacOS and Linux. Checkout below chapter to learn more about these commands.
222+
Using the [Office 365 CLI](https://sharepoint.github.io/office365-cli?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs), you can automate deploying, publishing, installing, upgrading, and retracting your apps. The Office 365 CLI is a cross-platform command-line interface that can be used on any platform, including Windows, MacOS, and Linux. To learn more about these commands, see the following sections.
223223

224-
### Adding and publishing your app to the app catalog
225-
Adding your app (.sppkg file, .app file) to the tenant app catalog is a per-requisite to later on make your app available for use in your SharePoint sites. use the [add](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-add/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command to do this:
224+
### Add and publish your app to the app catalog
225+
Adding your app (.sppkg file, .app file) to the tenant app catalog is a prerequisite to making your app available for use on your SharePoint sites. Use the [add](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-add/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command to do this:
226226

227227
```shell
228228
spo app add --filePath ./spfx.sppkg
229229
```
230230

231-
Once added you'll need to continue with publishing your app, effectively making the app available to be used by the users of your tenant. Use the [deploy](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-deploy/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command to do this:
231+
Once added, you need to continue with publishing your app, effectively making the app available to be used by the users of your tenant. Use the [deploy](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-deploy/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command to do this:
232232

233233
```shell
234234
spo app deploy --id <app id> --skipFeatureDeployment
235235
```
236236

237237

238238
> [!NOTE]
239-
> Use the **SkipFeatureDeployment** flag to allow an app that was developed for tenant wide deployment to be actually available as a tenant wide deployed app.
239+
> Use the **SkipFeatureDeployment** flag to allow an app that was developed for tenant-wide deployment to be actually available as a tenant-wide deployed app.
240240
241241

242242

243-
### Removing the app from the app catalog
244-
Obviously you might also want to remove an earlier added app and that can be done using the [remove](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-remove/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
243+
### Remove the app from the app catalog
244+
You may want to remove an app that you added earlier, and you can do this by using the [remove](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-remove/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
245245

246246
```shell
247247
spo app remove --id <app id>
248248
```
249249

250250

251-
### Using apps on your site
252-
Once the app was added to the app catalog and published you can continue with installing the app to your site. Install apps using the command [install](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-install/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs)
251+
### Use apps on your site
252+
After the app is added to the app catalog and published, you can install the app to your site by using the [install](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-install/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
253253

254254
```shell
255255
spo app install --id <app id> --siteUrl <url>
256256
```
257257

258258

259-
An added app also needs be upgraded which can be achieved using the [upgrade](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-upgrade/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command
259+
To upgrade the app, use the [upgrade](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-upgrade/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
260260

261261
```shell
262262
spo app upgrade --id <app id> --siteUrl <url>
263263
```
264264

265265

266-
And you off course also uninstall the app again from your site using the [uninstall](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-uninstall/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
266+
To uninstall the app from your site, use the [uninstall](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-uninstall/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
267267

268268
```shell
269269
spo app uninstall --id <app id> --siteUrl <url>
270270
```
271271

272272

273273
> [!NOTE]
274-
> When you uninstall an app from your site the app is completely deleted, so it will not end up in the site's recycle bin.
274+
> When you uninstall an app from your site, the app is completely deleted, so it will not end up in the site's recycle bin.
275275
276276

277-
### Listing and Getting apps in the app catalog
278-
You can also see what apps have been added to the app catalog using the [list](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-list/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
277+
### List and get apps in the app catalog
278+
You can see what apps have been added to the app catalog by using the [list](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-list/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
279279

280280
```shell
281281
spo app list
282282
```
283283

284284

285-
And you can also get a single app's details using the [get](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-get/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
285+
You can get a single app's details by using the [get](https://sharepoint.github.io/office365-cli/cmd/spo/app/app-get/?utm_source=msft_docs&utm_medium=page&utm_campaign=Application+Lifecycle+Management+ALM+APIs) command:
286286

287287
```shell
288288
spo app get --id <app id>
289289
```
290290

291-
=======
292291
## See also
293292

294293
- [Get to know the SharePoint REST service](../sp-add-ins/get-to-know-the-sharepoint-rest-service.md)

0 commit comments

Comments
 (0)