Skip to content

Set-SPOApplication.md

Latest commit

 

History

History
169 lines (120 loc) · 5.44 KB

Set-SPOApplication.md

File metadata and controls

169 lines (120 loc) · 5.44 KB
external help file sharepointonline.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/sharepoint-online/Set-SPOApplication
Applicable SharePoint Embedded
title Set-SPOApplication
schema 2.0.0
author ShreyasSar26
ms.author shsaravanan
ms.reviewer

Set-SPOApplication

SYNOPSIS

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

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

DESCRIPTION

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.

Note

The OwningApplicationId for Microsoft Loop is a187e399-0c36-4b98-8f04-1edc167a0996. The OwningApplicationId for Microsoft Designer is 5e2795e3-ce8c-4cfb-b302-35fe5cd01597.

To invite people outside your organization, please make sure Microsoft Entra B2B is enabled.

EXAMPLES

Example 1

Set-SPOApplication -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -OverrideTenantSharingCapability $false

This example disables the override sharing capability, aligning this SharePoint Embedded application's sharing settings with sharing capability of the SharePoint Online.

Example 2

Set-SPOApplication -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -OverrideTenantSharingCapability $true -SharingCapability -Disabled

This example enables the override, restricting file sharing within the SharePoint Embedded application to internal company users only, regardless of the broader SharePoint Online tenant settings.

Example 3

Set-SPOTenant -EnableAzureADB2BIntegration $true
Set-SPOApplication -OwningApplicationId 423poi45-jikl-9bnm-b302-1234ghy56789 -OverrideTenantSharingCapability $true -SharingCapability -ExternalUserandGuestSharing

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

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.

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.

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.

The valid values are:

  • ExternalUserAndGuestSharing (default) - External user sharing (share by email) and guest link sharing are both enabled.
  • Disabled - External user sharing (share by email) and guest link sharing are both disabled.
  • ExternalUserSharingOnly - External user sharing (share by email) is enabled, but guest link sharing is disabled.
  • ExistingExternalUserSharingOnly - Only guests already in your organization's directory.

The default setting is None, meaning the application follows the SharePoint Online tenant-level sharing settings. Use the Get-SPOTenant cmdlet to view these settings.

Type: SharingCapabilities
Parameter Sets: (All)
Aliases:
Accepted values: Disabled, ExternalUserSharingOnly, ExternalUserAndGuestSharing, ExistingExternalUserSharingOnly

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

-OverrideTenantSharingCapability

This setting allows the application to independently set its sharing capabilities, overriding the tenant-level settings of SharePoint Online. Options:

  • False (default) - The application follows the tenant-level sharing capability
  • True - The application's sharing settings are independent of the tenant level sharing capability
Type: Boolean
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.

RELATED LINKS

Get-SPOApplication

Set-SPOTenant