Get-UalUserAccess
Get-UalUserAccess
Gets UAL records of client requests per user.
Syntax
Parameter Set: ByName
Get-UalUserAccess [-ActivityCount <UInt32[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-FirstSeen <DateTime[]> ] [-LastSeen <DateTime[]> ] [-ProductName <String[]> ] [-RoleGuid <String[]> ] [-RoleName <String[]> ] [-TenantIdentifier <String[]> ] [-ThrottleLimit <Int32> ] [-Username <String[]> ] [ <CommonParameters>]
Detailed Description
The Get-UalUserAccess cmdlet gets User Access Logging (UAL) records for client requests, by user, for services on a server. Use the CimSession parameter to run the cmdlet on a remote server.
This cmdlet organizes information by user. For each user that accesses a service on a server, the cmdlet returns a record that specifies the user, the server role that the client requested, and the name of the server product. If the service uses a tenant client, the record includes a tenant identifier. The record also includes the first time the client accessed the service, the most recent time the client accessed the service, and the total number of times the client accessed the service.
You can specify parameter values to narrow the records that this cmdlet returns. For instance, you can get records for only a specified user or role.
For more information about UAL, see the User Access Logging Overview topic in the TechNet library at https://technet.microsoft.com/library/hh849634.aspx.
Parameters
-ActivityCount<UInt32[]>
Specifies an array of the number of access requests by a client for a service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-FirstSeen<DateTime[]>
Specifies an array of dates, as DateTime objects. A time represents when the client accessed the service for the first time.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-LastSeen<DateTime[]>
Specifies an array of dates, as DateTime objects. A time represents when the client most recently accessed the service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ProductName<String[]>
Specifies an array of names of products. The installed role or specific product in the request is a component of this product.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-RoleGuid<String[]>
Specifies an array of GUIDs for roles that clients access.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-RoleName<String[]>
Specifies an array of names for roles that clients access.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
-TenantIdentifier<String[]>
Specifies an array of GUIDs. Each GUID identifies a tenant client of an installed role or product, if a tenant client exists.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0
is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Username<String[]>
Specifies an array of user names that request a service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
true |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Get access information for a specific user
This command gets the UAL records for a client user with a specified name. The results show a single service that the user accesses for the first time on 8/22/2012 and most recently on 9/29/2012.
PS C:\> Get-UalUserAccess -Username "western\sarahjones"