API de administración del ciclo de vida de las aplicaciones (ALM)

Las API de ALM proporcionan API sencillas para administrar la implementación de complementos y soluciones de SharePoint Framework en un espacio empresarial. Las API de ALM admiten las funcionalidades siguientes:

• Agregar una solución de SharePoint Framework o un complemento de SharePoint al catálogo de aplicaciones de la colección de sitios o el espacio empresarial.
• Quitar una solución de SharePoint Framework o un complemento de SharePoint del catálogo de aplicaciones de la colección de sitios o el espacio empresarial.
• Habilitar una solución de SharePoint Framework o un complemento de SharePoint para que estén disponibles para su instalación en el catálogo de aplicaciones de la colección de sitios o el espacio empresarial.
• Deshabilitar una solución de SharePoint Framework o un complemento de SharePoint para que no estén disponibles para su instalación en el catálogo de aplicaciones de la colección de sitios o el espacio empresarial.
• Instalar en un sitio una solución de SharePoint Framework o un complemento de SharePoint del catálogo de aplicaciones de la colección de sitios o el espacio empresarial.
• Actualizar una solución de SharePoint Framework o un complemento de SharePoint en un sitio que tiene una versión más reciente disponible en el catálogo de aplicaciones de la colección de sitios o el espacio empresarial.
• Desinstalar una solución de SharePoint Framework o un complemento de SharePoint de un sitio.
• Enumerar todo y obtener detalles de las soluciones de SharePoint Framework o complementos de SharePoint en el catálogo de aplicaciones de la colección de sitios o el espacio empresarial.

Las API de ALM se pueden usar para realizar exactamente las mismas operaciones que están disponibles desde la perspectiva de una interfaz de usuario. Al usar estas API, se ejecutan todas las acciones típicas. Estas son algunas de las características de las API de ALM:

• Los eventos Install y UnInstall se activan para los complementos hospedados por el proveedor cuando se producen las operaciones correspondientes.
• Las API de ALM admiten operaciones basadas en aplicaciones solo para soluciones de SharePoint Framework.

Las API de ALM se admiten para las colecciones de sitios con ámbito de espacio empresarial y catálogo de aplicaciones de colección de sitios. Use la dirección URL del catálogo de aplicaciones correspondiente para dirigirse a un catálogo de aplicaciones específico. Primero debe habilitar un catálogo de aplicaciones de colección de sitios antes de seleccionarlo como destino con las acciones documentadas en esta página.

Opciones para trabajar con las API de ALM

Las API de ALM se proporcionan de forma nativa mediante las API de REST, pero hay extensiones del modelo de objetos de cliente (CSOM) y cmdlets de PowerShell adicionales y la CLI de Microsoft 365 multiplataforma que están disponibles a través de los canales de la comunidad de SharePoint PnP.

API de REST de SharePoint

Las API de ALM se proporcionan de forma nativa como puntos de conexión en la API rest de SharePoint.

El catálogo de aplicaciones debe incluirse en todas las solicitudes HTTP cuando se usa la API de REST, como se muestra en los ejemplos siguientes. Reemplace el marcador de posición {app-catalog-scope} en el punto de conexión por el ámbito del catálogo de aplicaciones. Las opciones de ámbito disponibles son tenantappcatalog y sitecollectionappcatalog.

Por ejemplo:

• al establecer como destino el catálogo de aplicaciones del espacio empresarial ubicado en https://contoso.sharepoint.com/sites/AppCatalog, el punto de conexión sería **

Más información aquí: API de REST de SharePoint

CSOM de PnP (también conocido como: PnP Sites Core)

El CSOM de PnP implementa las API de ALM mediante una llamada a la API de REST de SharePoint.

Antes de usar cualquiera de las API de ALM en el CSOM de PnP, debe obtener un contexto de cliente autenticado mediante el Microsoft.SharePointOnline.CSOM. Después, use el contexto de cliente autenticado para obtener una instancia del objeto AppManager del CSOM de PnP para llamar a los comandos de 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
}

En todos los métodos de PnP Core, se supone que la solicitud tiene como destino el catálogo de aplicaciones de espacio empresarial en el espacio empresarial al que se conecta mediante el objeto ClientContext de CSOM de SharePoint. puede invalidar el ámbito de todos los comandos con un argumento de ámbito opcional, por ejemplo

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

Más información aquí: PowerShell de PnP

PowerShell de PnP

PowerShell de PnP implementa las API de ALM mediante una llamada al CSOM de PnP.

Antes de usar cualquiera de los cmdlets del módulo PowerShell de PnP, primero debe conectarse a SharePoint Online mediante el cmdlet Connect-PnPOnline.

En todos los cmdlets de PowerShell de PnP, se supone que la solicitud tiene como destino el catálogo de aplicaciones de espacio empresarial del espacio empresarial al que se conecta mediante el cmdlet Connect-PnPOnline. Puede invalidar el ámbito del comando mediante el parámetro -Scope para establecer como destino un catálogo de aplicaciones de colección de sitios.

Más información aquí: PowerShell de PnP

CLI de Microsoft 365

La CLI de Microsoft 365 es una interfaz de línea de comandos multiplataforma que se puede usar en cualquier plataforma, incluidas Windows, macOS y Linux. La CLI implementa las API de ALM mediante una llamada a la API de REST de SharePoint.

Antes de usar cualquiera de los comandos de la CLI de Microsoft 365, primero debe conectar el espacio empresarial de Microsoft 365 mediante el comando m365 login.

Más información aquí: CLI de Microsoft 365

Agregar paquete de solución

En primer lugar, agregue un paquete de aplicación (*.sppkg o *.app) a un catálogo de aplicaciones para que esté disponible para los sitios de 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

Implementar paquetes de solución

La implementación de la solución hace que esté disponible para su instalación en sitios.

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

Retirar paquetes de solución

Este es el opuesto del paso para implementar anterior. Una vez retirada, la solución no se puede instalar en los sitios.

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

Quitar paquetes de solución

Este es el opuesto del paso para agregar anterior. Una vez quitada del catálogo de aplicaciones, la solución no se puede implementar.

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

Enumerar paquetes disponibles

Esta operación devolverá una lista de todas las soluciones o complementos de SharePoint Framework disponibles en el catálogo de aplicaciones.

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

Obtener una solución específica

Esta acción devolverá detalles sobre una solución o complemento de SharePoint Framework específico disponible en el catálogo de aplicaciones.

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

Instalar el paquete de solución en un sitio

Instale un paquete de solución con un identificador específico del catálogo de aplicaciones en el sitio, según el contexto de la 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>

Actualizar paquetes de solución instalados

Actualizar un paquete de solución desde el sitio a una versión más reciente disponible en el catálogo de aplicaciones.

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>

Desinstalar paquetes de solución de un sitio

Esta acción es la opuesta del comando de instalación anterior.

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>

Sincronizar una solución con el catálogo de aplicaciones de Microsoft Teams

Esta acción requiere que haga referencia al Id. del elemento de lista de la solución en el sitio del catálogo de aplicaciones.

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

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

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

Vea también

• Introducción al servicio REST para SharePoint
• PowerShell de PnP
• CLI de Microsoft 365