Edit

Share via

Get-SPOApplication

  • Reference
Module:
Microsoft.Online.SharePoint.PowerShell
Applies to:
SharePoint

Returns a list of SharePoint Embedded applications in the specified tenant.

Syntax

Get-SPOApplication
   [[-OwningApplicationId] <Guid>]
   [[-ApplicationId] <Guid>]
   [<CommonParameters>]
Get-SPOApplication []
Get-SPOApplication
   [[-OwningApplicationId] <Guid>]
   [<CommonParameters>]
Get-SPOApplication
   [[-OwningApplicationId] <Guid>]
   [[-ApplicationId] <Guid>][<CommonParameters>]

Description

This cmdlet is used to retrieve and return SharePoint Embedded applications from all publishers registered within a tenant. This cmdlet can be further customized by pairing it with the OwningApplicationId parameter to target a specific application.

In addition to providing details about the application name, this cmdlet also returns essential information about guest applications and their associated permissions on the owning application. The cmdlet displays data related to the sharing capabilities, including the OverrideTenantSharingCapability status. Furthermore, the cmdlet lists all host URLs allowed to use the SharePoint Embedded application's declarative agent experience.

You must be a SharePoint Embedded Administrator to run the cmdlet.

Examples

Example 1

Get-SPOApplication

Example 1 returns all SharePoint Embedded applications registered in the specified tenant by their OwningApplicationId and OwningApplicationName.

Example 2

Get-SPOApplication -OwningApplicationId <OwningApplicationId>

Example 2 provides details about the application corresponding to the owning application Id in the specified tenant. It returns applications, which includes the list of guest application IDs with permissions to the owning application, as well as the SharingCapability settings, the OverrideTenantSharingCapability status and the list of all Copilot embedded chat host URLs.

Example 3

Get-SPOApplication -OwningApplicationId <OwningApplicationId> -ApplicationId <ApplicationId>

Example 3 enumerates app-only permissions of the guest application specified in ApplicationId.

Example 4

Get-SPOApplication -OwningApplicationId <OwningApplicationId> | Select-Object CopilotEmbeddedChatHosts

Example 4 enumerates the entire list of the host URLs driving the Copilot embedded chat capability on the SharePoint Embedded application.

Parameters

-ApplicationId

Use this parameter to enumerate app-only permissions of the guest application id with access to the specified owning application.

Type:Guid
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OwningApplicationId

Use this parameter to get details about applications registered in the specified tenant.

The following details are returned:

  • OwningApplicationId

  • OwningApplicationName

  • Applications (by id)

  • SharingCapability

  • OverrideTenantSharingCapability

  • CopilotEmbeddedChatHosts

Type:Guid
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False