Get-RmsRequestInfo
Get-RmsRequestInfo
Generates a report containing information about a particular user request for the Active Directory Rights Management Services (AD RMS) cluster.
Syntax
Parameter Set: Default
Get-RmsRequestInfo [-Path] <String[]> -RequestId <Int64> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
This cmdlet generates a report that contains detailed information about a particular user request on the Active Directory Rights Management Services (AD RMS) cluster.
To obtain the report, specify the RequestID of the user request for which you want a report and then set the Path parameter to the AD RMS provider drive subpath “<PSDrive>:\Report” where <PSDrive> is the provider drive ID. You can also specify a relative path. For example, “.” specifies the current location.
Use the Get-RmsUserRequestReport cmdlet to obtain the RequestID of the user request for which you want a detailed report.
Parameters
-Path<String[]>
Specifies a provider drive and path or relative path on the current drive. This parameter is required. Use a dot (.) to specify the current location. This parameter does not accept wildcards and has no default value.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RequestId<Int64>
Specifies the unique internal ID of a user request.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<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 --------------
This command displays information about a particular user request.
C:\PS>Get-RmsRequestInfo -Path . -RequestID 1000
-------------- EXAMPLE 2 --------------
This command displays detailed information about a user's request to acquire a license. The Get-RmsUserRequestReport cmdlet retrieves the user's license request and then pipes the results to the Get-RmsRequestInfo cmdlet to display the details of the request.
C:\PS>Get-RmsUserRequestReport -Path . -RequestType AcquireLicense -UserID 1 | Get-RmsRequestInfo -Path .
Related topics
com/fwlink/?LinkId=136806