DOCSEARCHbyAlgolia
Submit Docs

PnP Framework API Reference

website·Indexed 29 days ago

https://pnp.github.io/cli-microsoft365/

API documentation for PnP.Framework.dll, featuring namespaces for modernization, provisioning, and diagnostics. Includes tools for SharePoint page transformation, client-side web part mapping, publishing page analysis, and provisioning object handlers.

Tokens
2.8M
Snippets
12.8K
Records
18K
Agent score
73%

What's inside PnP Framework

  1. Overview of SharePoint Add-In and Azure ACS Assessment Tool

    The Microsoft 365 Assessment Tool is designed to help tenant administrators manage the retirement of SharePoint Add-Ins and Azure ACS. It provides two primary functions: extracting usage data for SharePoint Add-Ins and Azure ACS principals, and generating a Power BI report to visualize and analyze the collected information.

  3. Overview of PnP.Core.Model Domain Model Interfaces

    The PnP.Core.Model namespace defines a set of core interfaces used to implement domain model objects and their behaviors. Key interfaces include:

    • IDataModel<TModel>: The base interface for every domain model object.
    • IDataModelWithKey: Provides identifying key behavior for model objects.
    • IDataModelWithContext: Integrates the PnPContext into model objects.
    • IDataModelParent: Implements parent-child relationships between model objects.
    • IMetadataExtensible: Supports objects that provide metadata, potentially with deferred loading.
    • IExpandoDataModel: Allows objects to be extended via a dictionary of properties.

  4. Overview of the PnP React Hero SPFx Web Part

    The React Hero Web Part is a SharePoint Framework (SPFx) component designed to display a rich, configurable Hero banner. It supports 7 different layout modes, image or video backgrounds, call-to-action (CTA) links, and auto-rotation. The component is built using @spteck/react-controls-v2 and supports full Fluent UI v9 theming. It is compatible with SharePoint Online, Microsoft Teams, and Microsoft 365 (Office) hosts.

  5. Overview of Microsoft Graph Subscriptions in PnPjs

    The @pnp/graph/subscriptions module allows client applications to receive notifications about changes to data in Microsoft Graph. Subscriptions are currently supported for resources including Outlook mail/events/contacts, Office Group conversations, OneDrive drive root items, Azure Active Directory users and groups, and Microsoft Graph Security API alerts.

  6. Overview of the AdaptiveCardHost control

    The AdaptiveCardHost is a React control for SPFx that renders Adaptive Cards (version 1.5) using Fluent UI React instead of standard HTML. It provides automatic integration with SharePoint and Microsoft Teams themes and supports Adaptive Cards Templating when a data object is provided.

    When the context property (SPFx context) is passed, the control injects an @context field into the data object, allowing Adaptive Cards templating syntax to access the following information:

    • theme: The current theme applied to the card.
    • aadInfo: Azure AD information.
    • cultureInfo: Culture information.
    • userInfo: User information.
    • spListInfo: Current List information.
    • spListItemInfo: Current List item information.
    • spSiteInfo: Current Site information.
    • spWebInfo: Current Web information.

  7. Overview of Microsoft Graph Subscriptions in @pnp/graph

    v3

    The @pnp/graph/subscriptions module allows client applications to receive notifications about data changes in Microsoft Graph. Subscriptions are currently supported for the following resources:

    • Outlook: Mail, events, and contacts
    • Office Groups: Conversations
    • OneDrive: Drive root items
    • Azure Active Directory: Users and Groups
    • Microsoft Graph Security API: Alerts

  8. Overview of the Tenant Governance Compliance Report solution

    The Tenant Governance Compliance Report is an automation tool for Microsoft 365 and Azure environments. It is designed for compliance officers and IT administrators to maintain security and health by providing the following capabilities:

    • Stale Content Detection: Identifies inactive Teams and SharePoint sites based on configurable criteria.
    • Label Statistics: Reports on the usage of sensitivity labels across the tenant.
    • Purview Integration: Aggregates Microsoft Purview scan results for compliance reporting.
    • Multi-Tool Integration: Uses CLI for Microsoft 365, Microsoft Graph PowerShell, and Azure CLI to gather data.
    • Reporting: Outputs data in CSV, JSON, and HTML formats.

  9. Overview of PnP.Framework.Provisioning.Connectors.OpenXML.Model namespace

    The PnP.Framework.Provisioning.Connectors.OpenXML.Model namespace contains the core models used to represent and manage PnP OpenXML files. Key components include:

    • PnPInfo: The global container for the PnP OpenXML file.
    • PnPManifest: The manifest associated with a PnP OpenXML file.
    • PnPFileInfo: A descriptor for individual files within the OpenXML package.
    • PnPFilesMap: Manages the mapping between original filenames and their OpenXML internal names.
    • PnPProperties: Contains properties of the PnP OpenXML container.
    • PackageType: An enumeration defining the types of packages supported.

  10. Overview of the Management of Content competency in M365

    The Management of Content competency focuses on the end-to-end lifecycle of digital items in Microsoft 365. This includes not only discrete files (Office documents) but also web pages, list items, emails, conversations, tasks, and media. The competency covers how content is presented, identified, stored, and managed from creation to disposal ('cradle to grave'). It specifically excludes the management of 'content containers' such as SharePoint sites, Teams channels, or Planner plans.

  11. Overview of PnPjs

    v3
    PnPjs is a collection of fluent, type-safe JavaScript libraries used to consume SharePoint, Microsoft Graph, and Office 365 REST APIs. It is compatible with the SharePoint Framework (SPFx), Node.js, and other general JavaScript projects.

  12. Overview of LegalLens SPFx Solution

    LegalLens is an AI-powered contract management and e-signature platform built on SharePoint Online. It consists of two primary components: an SPFx web part designed for internal users and a vendor-facing signing flow powered by Azure Functions, which allows external signers to interact with the system without requiring SharePoint access.
    Source code available at: https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/react-legallens