Edit

Set-SPAppAcquisitionConfiguration

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

Sets app acquisition settings.

Syntax

Set-SPAppAcquisitionConfiguration
   -Enable <Boolean>
   -SiteSubscription <SPSiteSubscriptionPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
Set-SPAppAcquisitionConfiguration
   -Enable <Boolean>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Confirm]
   -WebApplication <SPWebApplicationPipeBind>
   [-WhatIf]
   [<CommonParameters>]

Description

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet parameter sets.

Use the Set-SPAppAcquisitionConfiguration cmdlet to set app acquisition settings from the SharePoint Store or App Catalog.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at Windows PowerShell for SharePoint Server 2016, SharePoint Server 2019 reference (https://go.microsoft.com/fwlink/p/?LinkId=671715).

Examples

--------------------EXAMPLE 1---------------------

Set-SPAppAcquisitionConfiguration -WebApplication https://localhost -Enable:$false

This example disabled app purchases for the specified Web Application.

--------------------EXAMPLE 2---------------------

Set-SPAppAcquisitionConfiguration -SiteSubscription https://localhost/sites/SharePointOnlineAdmin1 -Enable:$false

This example disables app purchases for the specified tenant.

Parameters

-AssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:SPAssignmentCollection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Enable

Specifies whether acquisition is enabled or disabled.

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-SiteSubscription

Specifies the site collection for which to set app acquisition settings.

Type:SPSiteSubscriptionPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WebApplication

Specifies the web application for which acquisitions settings are to be set.

Type:SPWebApplicationPipeBind
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

Inputs

Microsoft.SharePoint.PowerShell.SPWebApplicationPipeBind

Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object