Edit

Share via


Get-SPAccessServicesDatabase

Returns an Access Services database.

Syntax

Default (Default)

Get-SPAccessServicesDatabase
    [[-Identity] <AccessServicesDatabasePipeBind>]
    [[-ContentDb] <SPContentDatabasePipeBind>]
    [[-AccessAppsOnly] <Boolean>]
    [-AssignmentCollection <SPAssignmentCollection>]
    [<CommonParameters>]

Description

Returns an Access Services database.

Examples

Example 1

Get-SPAccessServicesDatabase -Identity https://apps-eec88dc5f597c6.contoso-apps.com/sites/team/accessApp

Using the App Web, this example returns the Access database named 'accessApp'.

Example 2

Get-SPAccessServicesDatabase -ContentDb WSS_Content

This example returns all Access databases associated with sites in the content database, WSS_Content.

Parameters

-AccessAppsOnly

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Returns only Access Apps.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-AssignmentCollection

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-ContentDb

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

The Content Database to return Access Apps from.

Parameter properties

Type:SPContentDatabasePipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Identity

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

The URL to the Access App. Must be the App Web URL.

Parameter properties

Type:AccessServicesDatabasePipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Office.Access.Services.PowerShell.AccessServicesDatabasePipeBind

Microsoft.SharePoint.PowerShell.SPContentDatabasePipeBind System.Boolean Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object