Search Results for

    Show / Hide Table of Contents

    Get-PnPSiteCollectionAppCatalog

    SYNOPSIS

    Returns all site collection scoped app catalogs that exist on the tenant

    SYNTAX

    Get-PnPSiteCollectionAppCatalog [-CurrentSite <SwitchParameter>] [-ExcludeDeletedSites <SwitchParameter>] [-SkipUrlValidation <SwitchParameter>] [-Connection <PnPConnection>] [-Verbose] 
    

    DESCRIPTION

    Returns all the site collection scoped app catalogs that exist on the tenant

    EXAMPLES

    EXAMPLE 1

    Get-PnPSiteCollectionAppCatalog
    

    Will return all the site collection app catalogs that exist on the tenant, including those that may be in the tenant recycle bin

    EXAMPLE 2

    Get-PnPSiteCollectionAppCatalog -CurrentSite
    

    Will return the site collection app catalog for the currently connected to site, if it has one. Otherwise it will yield no result.

    EXAMPLE 3

    Get-PnPSiteCollectionAppCatalog -ExcludeDeletedSites
    

    Will return all the site collection app catalogs that exist on the tenant excluding the site collections having App Catalogs that are in the tenant recycle bin

    PARAMETERS

    -Connection

    Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

    Type: PnPConnection
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -CurrentSite

    When provided, it will check if the currently connected to site has a site collection App Catalog and will return information on it. If the current site holds no site collection App Catalog, an empty response will be returned.

    Type: SwitchParameter
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -ExcludeDeletedSites

    When provided, all site collections having site collection App Catalogs but residing in the tenant recycle bin, will be excluded

    Type: SwitchParameter
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -SkipUrlValidation

    When provided, the site collection app catalog Urls will not be validated for if they have been renamed since their creation. This makes the cmdlet a lot faster, but it could also lead to URLs being returned that no longer exist. If not provided, for each site collection app catalog, it will look up the actual URL of the site collection app catalog and return that instead of the URL that was used when the site collection app catalog was created.

    Type: SwitchParameter
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Verbose

    When provided, additional debug statements will be shown while executing the cmdlet.

    Type: SwitchParameter
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    RELATED LINKS

    Microsoft 365 Patterns and Practices

    Back to top Generated by DocFX spacer