API ALM (Application Lifecycle Management)

Les API ALM sont un moyen simple de gérer le déploiement de vos solutions et compléments SharePoint Framework sur l’ensemble de votre client. Elles prennent en charge les fonctionnalités suivantes :

• Ajout d’une solution SharePoint Framework ou d’un complément SharePoint au catalogue d’applications client ou de la collection de sites.
• Suppression d’une solution SharePoint Framework ou d’un complément SharePoint du catalogue d’applications client ou de la collection de sites.
• Activation de la solution SharePoint Framework ou du complément SharePoint pour qu’il soit disponible pour installation dans le catalogue d’applications client ou de la collection de sites.
• Désactivation de la solution SharePoint Framework ou du complément SharePoint pour qu’il ne soit pas disponible pour installation dans le catalogue d’applications client ou de la collection de sites.
• Installation de la solution SharePoint Framework ou du complément SharePoint à partir du catalogue d’applications client ou de la collection de sites sur un site.
• Mise à niveau de la solution SharePoint Framework ou du complément SharePoint sur un site, qui comporte une version plus récente disponible dans le catalogue d’applications client ou de la collection de sites.
• Désinstallation d’une solution SharePoint Framework ou d’un complément SharePoint du site.
• Répertorie et obtient l’ensemble des détails sur les solutions SharePoint Framework ou les compléments SharePoint dans le catalogue d’applications client ou de la collection de sites.

Les API ALM permettent d’effectuer exactement les mêmes opérations que celles disponibles depuis la perspective de l’interface utilisateur. Lorsque ces API sont utilisés, toutes les actions classiques sont effectuées. Voici quelques-unes des caractéristiques des API ALM :

• Les événements Install et UnInstall sont déclenchés par les compléments hébergés par le fournisseur lorsque les opérations correspondantes ont lieu.
• Les API ALM prennent uniquement en charge les opérations basées sur l’application pour les solutions SharePoint Framework.

Les API ALM sont prises en charge pour les collections de sites étendues au locataire et catalogue d’applications de collection de sites. Utilisez l’URL du catalogue d’applications correspondant pour cibler un catalogue d’applications spécifique. Vous devez d’abord activer un catalogue d’applications de collection de sites avant de le cibler avec les actions documentées sur cette page.

Options d’utilisation des API ALM

Les API ALM sont fournies en mode natif à l’aide d’API REST, mais il existe des extensions de modèle objet côté client (CSOM), des applets de commande PowerShell et l’interface CLI multiplateforme pour Microsoft 365 disponibles via les canaux de la communauté PnP SharePoint.

API REST SharePoint

Les API ALM sont fournies en mode natif en tant que points de terminaison sur l’API REST SharePoint.

Le catalogue d’applications doit être inclus dans toutes les requêtes HTTP lors de l’utilisation de l’API REST, comme indiqué dans les exemples ci-dessous. Remplacez l’espace réservé {app-catalog-scope} dans le point de terminaison par l’étendue du catalogue d’applications. Les options d’étendue disponibles sont tenantappcatalog et sitecollectionappcatalog.

Par exemple :

• lors du ciblage du catalogue d’applications client situé à https://contoso.sharepoint.com/sites/AppCatalog, le point de terminaison serait **

En savoir plus ici : l’API REST SharePoint

Modèle CSOM PnP (également appelé : PnP Sites Core)

Le modèle CSOM PnP implémente les API ALM en appelant l’API REST SharePoint.

Avant d’utiliser l’une des API ALM dans le modèle CSOM PnP, vous devez obtenir un contexte client authentifié à l’aide de la Microsoft.SharePointOnline.CSOM. Utilisez ensuite le contexte client authentifié pour obtenir une instance de l’objet AppManager du CSOM PnP pour appeler les commandes ALM :

using Microsoft.SharePoint.Client;
using OfficeDevPnP.Core.ALM;

// ...

using (var context = new ClientContext(webURL)) {
  context.Credentials = new SharePointOnlineCredentials(username, securePassword);
  var appManager = new AppManager(context);
  // execute PnP CSOM ALM command
}

Dans toutes les méthodes PnP Core, il est supposé que la requête cible le catalogue d’applications client dans le locataire auquel vous vous connectez à l’aide de l’objet ClientContext CSOM SharePoint. vous pouvez remplacer l’étendue de toutes les commandes par un argument d’étendue facultatif, par exemple

appManager.Install('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx', AppCatalogScope.Site);

En savoir plus ici : PowerShell PnP

PnP PowerShell

PnP PowerShell implémente les API ALM en appelant le modèle CSOM PnP.

Avant d’utiliser l’une des applets de commande dans le module PowerShell PnP, vous devez d’abord vous connecter à SharePoint Online à l’aide de l’applet de commande Connect-PnPOnline.

Dans toutes les applets de commande PowerShell PnP, il est supposé que la requête cible le catalogue d’applications client dans le locataire auquel vous vous connectez à l’aide de l’applet de commande Connect-PnPOnline. Vous pouvez remplacer l’étendue de la commande à l’aide du paramètre -Scope pour cibler un catalogue d’applications de collection de sites.

En savoir plus ici : PowerShell PnP

Interface CLI pour Microsoft 365

L’interface CLI pour Microsoft 365 est une interface de ligne de commande multiplateforme qui peut être utilisée sur n’importe quelle plateforme, y compris Windows, macOS et Linux. L’interface CLI implémente les API ALM en appelant l’API REST SharePoint.

Avant d’utiliser l’une des commandes de l’interface CLI pour Microsoft 365, vous devez d’abord connecter votre client Microsoft 365 à l’aide de la commande m365 login.

En savoir plus ici : CLI pour Microsoft 365

Ajouter un package de solution

Tout d’abord, ajoutez un package d’application (*.sppkg ou *.app) à un catalogue d’applications afin de le rendre disponible pour les sites SharePoint.

POST /_api/web/{scope}appcatalog/Add(overwrite=true, url='sharepoint-solution-package.sppkg')

// read file
var filePath = "c:\path\to\file\sharepoint-solution-package.sppkg";
// get an instance of the PnP CSOM's AppManager as shown above
var result = appManager.Add(filePath);

Add-PnPApp -Path ./sharepoint-solution-package.sppkg

m365 spo app add --filePath ./sharepoint-solution-package.sppkg

Déployer des packages de solutions

Le déploiement de la solution le rend disponible pour l’installation sur les sites.

POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Deploy

{
  "skipFeatureDeployment": true
}

appManager.Deploy('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')

Publish-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

m365 spo app deploy --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

Retirer les packages de solution

Il s’agit de l’inverse de l’étape déployer ci-dessus. Une fois retirée, la solution ne peut pas être installée sur les sites.

POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Retract

// get an app package
appManager.Retract('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')

Unpublish-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

m365 spo app retract --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

Supprimer les packages de solution

Il s’agit de l’inverse de l'étape ajouter ci-dessus. Supprimé du catalogue d’applications, la solution ne peut pas être déployée.

POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Remove

appManager.Remove('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')

Remove-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

m365 spo app remove --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

Répertorier les packages disponibles

Cette opération retourne la liste de toutes les solutions ou compléments SharePoint Framework disponibles dans le catalogue d’applications.

GET /_api/web/{scope}appcatalog/AvailableApps

{
  "value": [
    {
      "AadAppId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
      "ContainsTenantWideExtension": false,
      "CurrentVersionDeployed": true,
      "Deployed": true,
      "ID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
      "IsClientSideSolution": true,
      "IsEnabled": true,
      "IsPackageDefaultSkipFeatureDeployment": false,
      "IsValidAppPackage": true,
      "ShortDescription": "",
      "SkipDeploymentFeature": false,
      "Title": "sharepoint-solution-package"
    },
    {
      "AadAppId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
      "ContainsTenantWideExtension": false,
      "CurrentVersionDeployed": true,
      "Deployed": true,
      "ID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
      "IsClientSideSolution": true,
      "IsEnabled": true,
      "IsPackageDefaultSkipFeatureDeployment": false,
      "IsValidAppPackage": true,
      "ShortDescription": "",
      "SkipDeploymentFeature": false,
      "Title": "sharepoint-solution-package2"
    }
  ]
}

var allAppPackages = appManager.GetAvailable();

Get-PnPApp

m365 spo app list

Obtenir une solution spécifique

Cette action renvoie des détails sur une solution ou un complément SharePoint Framework spécifique disponible dans le catalogue d’applications.

GET /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')

{
  "AadAppId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
  "ContainsTenantWideExtension": false,
  "CurrentVersionDeployed": true,
  "Deployed": true,
  "ID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
  "IsClientSideSolution": true,
  "IsEnabled": true,
  "IsPackageDefaultSkipFeatureDeployment": false,
  "IsValidAppPackage": true,
  "ShortDescription": "",
  "SkipDeploymentFeature": false,
  "Title": "sharepoint-solution-package"
}

var appPackage = appManager.GetAvailable('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx');

Get-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

m365 spo app get --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

Installer le package de solution dans un site

Installez un package de solution du catalogue d’applications doté d’un identifiant spécifique sur le site en fonction du contexte de l’URL.

POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Install

// get an app package
appManager.Install('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')

Install-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

m365 spo app install --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx --siteUrl <url>

Mettre à niveau les packages de solutions installés

Mettez à niveau un package de solution du site vers une version plus récente disponible dans le catalogue d’applications.

POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Upgrade

// get an app package
var appPackage = appManager.GetAvailable('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx');
if (appPackage.CanUpgrade) {
  appManager.Upgrade(appPackage)
}

Update-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

m365 spo app upgrade --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx --siteUrl <url>

Désinstaller des packages de solutions à partir d’un site

Cette action est l’inverse de la commande installer ci-dessus.

POST /_api/web/{scope}appcatalog/AvailableApps/GetById('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')/Uninstall

appManager.Uninstall('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')

Uninstall-PnPApp -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

m365 spo app uninstall --id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx --siteUrl <url>

Synchroniser une solution avec le catalogue d’applications Microsoft Teams

Cette action nécessite que vous référiez l’ID d’élément de liste de la solution dans le site du catalogue d’applications.

POST /_api/web/{scope}appcatalog/SyncSolutionToTeams(id=xxxxx)

appManager.SyncToTeams('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx')

Sync-PnPAppToTeams -Identity xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx

Voir aussi

• Découverte du service REST SharePoint
• PowerShell PnP
• CLI pour Microsoft 365