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
Get-RmsRequestInfo -RequestId <Int64> [-Path] <String[]> [-WhatIf] [-Confirm] [<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
-RequestId <Int64>
Specifies the unique internal ID of a user request.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
named |
-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.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue, ByPropertyName) |
Position? |
1 |
-WhatIf <SwitchParameter>
Describes what would happen if you executed the command without executing the command.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Confirm <SwitchParameter>
Prompts you for confirmation before executing the command.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see About Common Parameter
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Input Type |
. |
Return Type |
. |
Notes
Examples
EXAMPLE 1
C:\PS>Get-RmsRequestInfo -Path . -RequestID 1000
This command displays information about a particular user request.
EXAMPLE 2
C:\PS>Get-RmsUserRequestReport -Path . -RequestType AcquireLicense -UserID 1 | Get-RmsRequestInfo -Path .
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.