Clear-AipServiceDocumentRevoked
Unrevokes a specified, protected document that currently has a revoke status.
Syntax
Default (Default)
Clear-AipServiceDocumentRevoked
[-Force]
-ContentId <Guid>
-IssuerName <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Clear-AipServiceDocumentRevoked cmdlet clears the document's revoke status, and unrevokes a
specified protected document, based on the document's contentID and Rights Management issuer.
For example, use this cmdlet if you have accidentally revoked access to the specified document, and want to now grant access again.
Before running this cmdlet you must first load the AipService.dll.
Examples
Example 1: Unrevoke access for a specific document
Import-Module -Name 'C:\Program Files\WindowsPowerShell\Modules\AIPService\1.0.0.4\AipService.dll'
Clear-AipServiceDocumentRevoked -ContentId c03bf90c-6e40-4f3f-9ba0-2bcd77524b87 -IssuerName 'alice@contoso.com'
This command clears the revoked state for a document with a contentID value of
c03bf90c-6e40-4f3f-9ba0-2bcd77524b87, which was protected by a user with the alice@contoso.com
email address.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ContentId
Specifies the contentID value for the document you want to return tracking data for.
To retrieve the contentID for a specific document, use the Get-AipServiceDocumentLog cmdlet.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
String
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IssuerName
Specifies the email of the Rights Management issuer for the document you want to unrevoke access for.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Email address
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| 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.