Skip to content

SPAppCatalog

dscbot edited this page Mar 17, 2023 · 19 revisions

SPAppCatalog

Parameters

Parameter Attribute DataType Description Allowed Values
SiteUrl Key String The URL of the site collection that will be the app catalog for the web app that it is in

Description

Type: Distributed Requires CredSSP: Yes

This resource will ensure that a specific site collection is marked as the app catalog for the web application that the site is in. The catalog site needs to have been created using the correct template (APPCATALOG#0).

This resource should NOT be run using the farm account. The resource will retrieve the farm credentials from SharePoint and use that to update the AppCatalog. This does mean it requires CredSSP to be setup!

Examples

Example 1

This example shows how to configure the AppCatalog in the farm

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPAppCatalog MainAppCatalog
        {
            SiteUrl              = "https://content.sharepoint.contoso.com/sites/AppCatalog"
            PsDscRunAsCredential = $SetupAccount
        }
    }
}
Clone this wiki locally