You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
12
12
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.
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
18
- Uninstall SharePoint Framework solution or SharePoint Add-in from the site.
19
19
20
20
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:
@@ -25,13 +25,13 @@ ALM APIs can be used to perform exactly the same operations that are available f
25
25
ALM APIs are natively provided by using REST APIs, but there are also additional CSOM extensions and PowerShell cmdlets available through SharePoint Patterns and Practices.
26
26
27
27
> [!NOTE]
28
-
> 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.
28
+
> 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.
29
29
30
30
## REST API
31
31
32
-
### Add solution packages to the tenant App Catalog
32
+
### Add solution packages to the tenant app catalog
33
33
34
-
This API is designed to be executed in the context of the tenant App Catalog site.
34
+
This API is designed to be executed in the context of the tenant app catalog site.
### Deploy solution packages in the tenant App Catalog
43
+
### Deploy solution packages in the tenant app catalog
44
44
45
-
This enables the solution to be available to install to specific sites. This API is designed to be executed in the context of the tenant App Catalog site.
45
+
This enables the solution to be available to install to specific sites. This API is designed to be executed in the context of the tenant app catalog site.
> 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.
64
64
65
-
### Remove solution packages from the tenant App Catalog
65
+
### Remove solution packages from the tenant app catalog
66
66
67
-
This API is designed to be executed in the context of the tenant App Catalog site.
67
+
This API is designed to be executed in the context of the tenant app catalog site.
### Install solution package from the tenant App Catalog to a SharePoint site
94
+
### Install solution package from the tenant app catalog to a SharePoint site
95
95
96
-
Install a solution package with a specific identifier from the tenant App Catalog to the site based on URL context. This REST call can be executed in the context of the site where the install operation should happen.
96
+
Install a solution package with a specific identifier from the tenant app catalog to the site based on URL context. This REST call can be executed in the context of the site where the install operation should happen.
### Upgrade solution packages on the SharePoint site
104
104
105
-
Upgrade a solution package from the site to a newer version available in the tenant App Catalog. This REST call can be executed in the context of the site where the upgrade operation should happen.
105
+
Upgrade a solution package from the site to a newer version available in the tenant app catalog. This REST call can be executed in the context of the site where the upgrade operation should happen.
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.
127
127
128
-
### Add and publish your app to the App Catalog
128
+
### Add and publish your app to the app catalog
129
129
130
-
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 so by using the following cmdlet:
130
+
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 so by using the following cmdlet:
Copy file name to clipboardExpand all lines: docs/general-development/site-collection-app-catalog.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -112,4 +112,4 @@ Before deploying solutions to site collection app catalogs, site collection admi
112
112
113
113
## See also
114
114
115
-
-[Manage the Site Collection App Catalog](https://support.office.com/en-us/article/Manage-the-Site-Collection-App-Catalog-928b9b61-a9de-4563-a7d1-6231aa9d4d19)
115
+
-[Manage the Site Collection app catalog](https://support.office.com/en-us/article/Manage-the-Site-Collection-App-Catalog-928b9b61-a9de-4563-a7d1-6231aa9d4d19)
Copy file name to clipboardExpand all lines: docs/solution-guidance/Branding-and-site-provisioning-solutions-for-SharePoint.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -76,7 +76,7 @@ Conceptually, the hierarchy of SharePoint objects is expressed in terms of conta
76
76
## add-ins for SharePoint
77
77
<aname="sectionSection3"> </a>
78
78
79
-
add-ins for SharePoint are lightweight solutions that don't install on the SharePoint host server, which means they don't make excessive API calls to the host server. You can build add-ins for SharePoint by using the Cloud Add-in Model. Users can discover and download add-ins from the Office Store or from the enterprise's App Catalog. For more information, see [Overview of add-ins for SharePoint](http://msdn.microsoft.com/library/cd1eda9e-8e54-4223-93a9-a6ea0d18df70.aspx).
79
+
add-ins for SharePoint are lightweight solutions that don't install on the SharePoint host server, which means they don't make excessive API calls to the host server. You can build add-ins for SharePoint by using the Cloud Add-in Model. Users can discover and download add-ins from the Office Store or from the enterprise's app catalog. For more information, see [Overview of add-ins for SharePoint](http://msdn.microsoft.com/library/cd1eda9e-8e54-4223-93a9-a6ea0d18df70.aspx).
80
80
81
81
## File system and content databases, and how they work together
Copy file name to clipboardExpand all lines: docs/solution-guidance/development-experience-tenant-apponly-permissions-in-sharepoint-online.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ Supply the **Client ID** and **Client Secret **created in Step 1.
45
45
Since you want to debug the add-in, ensure that you supply https://localhost.com including the port as depicted below.
46
46

47
47
48
-
Now deploy the add-in in the App Catalog site.
48
+
Now deploy the add-in in the app catalog site.
49
49
50
50
### Step 5: Install your add-in in your developer site collection
51
51
@@ -55,7 +55,7 @@ Navigate to the developer site and add the app. Click on **App Details**.
55
55
If you clicked on the app tile, you will have to click on "**Find out why**" and request your app
56
56

57
57
58
-
Once the request has been submitted the status will be in a pending state until the SharePoint Administrator or the App Catalog Administrator approves the request. To approve the request, navigate to the app catalog, App Requests and approve the request.
58
+
Once the request has been submitted the status will be in a pending state until the SharePoint Administrator or the app catalog Administrator approves the request. To approve the request, navigate to the app catalog, App Requests and approve the request.
Copy file name to clipboardExpand all lines: docs/solution-guidance/feature-stapling-sharepoint-add-in.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -50,12 +50,12 @@ The following article describes how to staple features to a site definition.
50
50
51
51
Staple Add-ins
52
52
--------------
53
-
In this pattern you deploy Add-ins stored in the App Catalog to specific site collections, managed paths, and site templates.
53
+
In this pattern you deploy Add-ins stored in the app catalog to specific site collections, managed paths, and site templates.
54
54
55
55
- See the [SharePoint 2013 App Deployment through 'App Stapling' (MSDN Blog Article - Richard DiZerega)](http://blogs.msdn.com/b/richard_dizeregas_blog/archive/2013/09/18/10399333.aspx) for more details about the Add-in stapling model.
56
56
- Because the add-in is pushed by an administrator, site owners will not be able to remove the add-in from a site that meets the deployment criteria. Not even a site collection administrator can remove the add-in.
57
-
- This centralized deployment also shares the same centralized add-in resources (Add-in Web and Remote Web). Essentially, the Add-in is deployed, but not installed in the sites. All sites will leverage the Add-in Web and Remote Web from the instance installed in the App Catalog.
58
-
- Because of centralized deployment, remote events such as 'Handle App Installed', 'Handle App Uninstalled', and 'Handle App Upgrade' will only fire once (when the Add-In is installed in the App Catalog).
57
+
- This centralized deployment also shares the same centralized add-in resources (Add-in Web and Remote Web). Essentially, the Add-in is deployed, but not installed in the sites. All sites will leverage the Add-in Web and Remote Web from the instance installed in the app catalog.
58
+
- Because of centralized deployment, remote events such as 'Handle App Installed', 'Handle App Uninstalled', and 'Handle App Upgrade' will only fire once (when the Add-In is installed in the app catalog).
59
59
+ This can make it difficult to use the Add-in stapling pattern to automatically apply changes to sites where it is deployed because these events do not fire when it is deployed to sites.
60
60
- Add-in parts are not supported when Add-ins are stapled to sites.
61
61
- This pattern requires manual user actions to deploy the Add-ins.
Copy file name to clipboardExpand all lines: docs/sp-add-ins/access-sharepoint-data-from-add-ins-using-the-cross-___domain-library.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -361,7 +361,7 @@ To switch the context site in your code, use the **AppContextSite** endpoint (RE
361
361
362
362
Here is a reminder of the REST endpoint: /_api/SP.AppContextSite(@target)/web/title?@target='weburl', and an example on how to instantiate the object in JSOM: `appContextSite = new SP.AppContextSite(context, weburl);`.
363
363
364
-
As a developer, you can only deploy tenant-scoped add-ins from the add-in catalog. You can provision an add-in catalog to your on-premises or SharePoint Online environments. Uploading your add-in to the add-in catalog is as simple as uploading a file to a document library. For detailed instructions, see [Use the App Catalog to make custom business apps available for your SharePoint Online environment](https://support.office.com/en-us/article/Use-the-App-Catalog-to-make-custom-business-apps-available-for-your-SharePoint-Online-environment-0b6ab336-8b83-423f-a06b-bcc52861cba0?CorrelationId=94979966-ff7b-4e00-985a-5c9e614b35c9&ui=en-US&rs=en-US&ad=US&ocmsassetID=HA102772362).
364
+
As a developer, you can only deploy tenant-scoped add-ins from the add-in catalog. You can provision an add-in catalog to your on-premises or SharePoint Online environments. Uploading your add-in to the add-in catalog is as simple as uploading a file to a document library. For detailed instructions, see [Use the app catalog to make custom business apps available for your SharePoint Online environment](https://support.office.com/en-us/article/Use-the-App-Catalog-to-make-custom-business-apps-available-for-your-SharePoint-Online-environment-0b6ab336-8b83-423f-a06b-bcc52861cba0?CorrelationId=94979966-ff7b-4e00-985a-5c9e614b35c9&ui=en-US&rs=en-US&ad=US&ocmsassetID=HA102772362).
365
365
366
366
From the add-in catalog, you can deploy the add-in to one or more websites in the tenant. Because your add-in has permissions to access data in the tenant, you only have to deploy to one website to access data on the whole tenant. For instructions on how to deploy an add-in from the add-in catalog, see [Deploy a custom add-in](https://support.office.com/en-us/article/Use-the-App-Catalog-to-make-custom-business-apps-available-for-your-SharePoint-Online-environment-0b6ab336-8b83-423f-a06b-bcc52861cba0?CorrelationId=94979966-ff7b-4e00-985a-5c9e614b35c9&ui=en-US&rs=en-US&ad=US&ocmsassetID=HA102772362)
Copy file name to clipboardExpand all lines: docs/spfx/call-microsoft-graph-using-graphhttpclient.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -179,8 +179,8 @@ The code needs to call the **GraphHttpClient** application that runs on SharePoi
179
179
```
180
180
181
181
2. Deploy the solution to your SharePoint tenant:
182
-
* Go to your site's App Catalog.
183
-
* Upload or drag and drop the **hellograph-webpart.sppkg** to the App Catalog.
182
+
* Go to your site's app catalog.
183
+
* Upload or drag and drop the **hellograph-webpart.sppkg** to the app catalog.
184
184
* When prompted, if you trust the **hellograph-webpart-client-side-solution**, select **Make this solution available to all sites in the organization**, and select **Deploy**.
185
185
186
186
3. Use gulp serve to host the web part.
@@ -282,8 +282,8 @@ Again, you need to modify the HTML to add a button that creates a new group.
282
282
```
283
283
284
284
2. Deploy the solution to your SharePoint tenant:
285
-
* Go to your site's App Catalog.
286
-
* Upload or drag and drop the **hellograph-webpart.sppkg** to the App Catalog.
285
+
* Go to your site's app catalog.
286
+
* Upload or drag and drop the **hellograph-webpart.sppkg** to the app catalog.
287
287
* Because your solution is already registered, you are prompted as to whether you want to replace it. Select **Replace it**.
288
288
* When prompted as to whether you trust the solution, select **Deploy**.
0 commit comments