Get-SPUsageApplication
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Returns a specified usage application.
Get-SPUsageApplication [[-Identity] <SPUsageApplicationPipeBind>] [-AssignmentCollection <SPAssignmentCollection>] [-UsageService <SPUsageServicePipeBind>]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Optional | Microsoft.SharePoint.PowerShell.SPUsageApplicationPipeBind | Specifies the usage application to get. If the Identity parameter is not specified, the cmdlet returns the local usage application. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage application (for example, UsageApplication1); or an instance of a valid SPUsageApplication object. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | 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.
| ||
| UsageService | Optional | Microsoft.SharePoint.PowerShell.SPUsageServicePipeBind | Filters to return the usage application with the specified parent SPUsageService object. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a usage service (for example, UsageService1); or an instance of a valid SPUsageService object. |
Detailed Description
The Get-SPUsageApplication cmdlet return a specified usage application. If the Identity parameter is not specified, the cmdlet returns the local usage application.
Input Types
Return Types
---------------EXAMPLE------------------
Get-SPUsageApplication -Identity "Usage and Health data collection"
This example returns the usage application named, Usage and Health data collection
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: