Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 39 additions & 15 deletions sharepoint/sharepoint-ps/sharepoint-online/Get-SPOApplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ online version: https://learn.microsoft.com/powershell/module/sharepoint-online/
applicable: SharePoint
title: Get-SPOApplication
schema: 2.0.0
author: cindylay
ms.author: cindylay
author: ShreyasSar26
ms.author: shsaravanan
ms.reviewer:
---

Expand All @@ -18,21 +18,35 @@ Returns a list of SharePoint Embedded applications in the specified tenant.

## SYNTAX

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

### ParamSet1

```powershell
Get-SPOApplication [[-OwningApplicationId] <OwningApplicationid>] [<CommonParameters>]
Get-SPOApplication [<CommonParameters>]
```

### ParamSet2

```powershell
Get-SPOApplication [[-OwningApplicationId] <OwningApplicationid>] [[-ApplicationId] <ApplicationId>]
Get-SPOApplication [[-OwningApplicationId] <Guid>] [<CommonParameters>]
```

### ParamSet3

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

## DESCRIPTION

The `Get-SPOApplication` cmdlet retrieves and returns SharePoint Embedded applications of all publishers registered in a tenant that match the given criteria. You must be a SharePoint Administrator to run the cmdlet. For permissions and the most current information about Windows PowerShell, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell?view=sharepoint-ps).
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

Expand All @@ -50,7 +64,7 @@ Example 1 returns all SharePoint Embedded applications registered in the specifi
Get-SPOApplication -OwningApplicationId <OwningApplicationId>
```

Example 2 provides details about the owning application 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 and the OverrideTenantSharingCapability status
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

Expand All @@ -59,6 +73,15 @@ Get-SPOApplication -OwningApplicationId <OwningApplicationId> -ApplicationId <Ap
```

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

### Example 4

```powershell
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

### -OwningApplicationId
Expand All @@ -76,15 +99,16 @@ The following details are returned:
- SharingCapability

- OverrideTenantSharingCapability

- CopilotEmbeddedChatHosts

```yaml
Type: String
Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: SharePoint

Required: False
Position: Named
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Expand All @@ -95,18 +119,17 @@ Accept wildcard characters: False
Use this parameter to enumerate app-only permissions of the guest application id with access to the specified owning application.

```yaml
Type: String
Parameter Sets: ParamSet2
Type: Guid
Parameter Sets: (All)
Aliases:
Applicable: SharePoint

Required: False
Position: Named
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -115,4 +138,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
## RELATED LINKS

[Get-SPOContainer](./Get-SPOContainer.md)

[Set-SPOApplication](./Set-SPOApplication.md)
84 changes: 69 additions & 15 deletions sharepoint/sharepoint-ps/sharepoint-online/Set-SPOApplication.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,41 @@ online version: https://learn.microsoft.com/powershell/module/sharepoint-online/
Applicable: SharePoint Embedded
title: Set-SPOApplication
schema: 2.0.0
author: FarreltinF
ms.author: fanyi
author: ShreyasSar26
ms.author: shsaravanan
ms.reviewer:
---

# Set-SPOApplication

## SYNOPSIS

Sets or updates one or more property values for a SharePoint application.
Sets or updates one or more configuration of a SharePoint Embedded application.

## SYNTAX

```
Set-SPOApplication [-OwningApplicationId] <Guid> [[-SharingCapability] <SharingCapabilities>]
[[-OverrideTenantSharingCapability] <Boolean>]
[[-CopilotEmbeddedChatHosts] <System.Collections.Generic.List`1[System.String]>] [<CommonParameters>]
```

### ParamSet1

```powershell
Set-SPOApplication
[-OwningApplicationId <OwningApplicationId>]
[–SharingCapability <SharingCapability>]
[-OverrideTenantSharingCapability <Boolean>]
[[-OwningApplicationId] <Guid>]
[[–SharingCapability] <SharingCapability>]
[[-OverrideTenantSharingCapability] <Boolean>]
[[-CopilotEmbeddedChatHosts] <String>]
```

## DESCRIPTION

`Set-SPOApplication` adjusts the sharing settings at the SharePoint Embedded application level, determining if this SharePoint Embedded application content can be shared with external guests.
`Set-SPOApplication` cmdlet is used to set the configuration properties of a specific application, determined by the `OwningApplicationId`.

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

You must be a SharePoint Embedded Administrator or Global Administrator to run the cmdlet.
> [!NOTE]
> The OwningApplicationId for Microsoft Loop is `a187e399-0c36-4b98-8f04-1edc167a0996`.
> The OwningApplicationId for Microsoft Designer is `5e2795e3-ce8c-4cfb-b302-35fe5cd01597`.
Expand Down Expand Up @@ -64,8 +72,48 @@ Set-SPOApplication -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -Ov
```
This example demonstrates how to enable file sharing within the SharePoint Embedded application for external users. Note that B2B integration must be enabled to allow guest invitations to SharePoint Embedded apps.

### Example 4

```powershell
Set-SPOApplication -OwningApplicationId 423poi45 -CopilotEmbeddedChatHosts "http://localhost:3000 https://contoso.sharepoint.com https://fabrikam.com"
```
This example sets the host URLs for the application with Id 423poi45.

## PARAMETERS

### -CopilotEmbeddedChatHosts

This parameter is used to add host URLs allowed to use the SharePoint Embedded application's declarative agent experience.

```yaml
Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -OwningApplicationId

This parameter specifies the ID of the SharePoint Embedded application.

```yaml
Type: Guid
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```


### -SharingCapability

Determines what level of sharing is available for the SharePoint Embedded Application.
Expand All @@ -83,9 +131,10 @@ The default setting is None, meaning the application follows the SharePoint Onli
Type: SharingCapabilities
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Embedded
Required: True
Position: Named
Accepted values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Expand All @@ -100,14 +149,19 @@ This setting allows the application to independently set its sharing capabilitie

```yaml
Type: Boolean
Applicable: SharePoint Embedded
Required: True
Position: Named
Default value: False
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## RELATED LINKS

[Get-SPOApplication](Get-SPOApplication.md)
Expand Down