Set-AipServiceDocumentRevoked
Revokes access for specified users, to a specified tracked and protected document.
Syntax
Default (Default)
Set-AipServiceDocumentRevoked
[-Force]
-ContentId <Guid>
-
-IssuerName <String>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Relevant for the unified labeling client only
The Set-AipServiceDocumentRevoked cmdlet revokes access to a specified document, based on the document's contentID and Rights Management issuer.
To retrieve the contentID for a specific document, use the Get-AipServiceDocumentLog cmdlet.
Examples
Example 1: Revoke access to a specific protected document
PS C:\>Set-AipServiceDocumentRevoked -ContentId c03bf90c-6e40-4f3f-9ba0-2bcd77524b87 - IssuerName “alice@microsoft.com”
This command revokes access to the document identified using the c03bf90c-6e40-4f3f-9ba0-2bcd77524b87 contentID and This command sets the document state as revoked for the document with contentId as c03bf90c-6e40-4f3f-9ba0-2bcd77524b87 & IssuerName as alice@microsoft.com.
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 email address of a user or group to have administrative rights for the protection service. If the user has no email address, specify the user's Universal Principal Name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
String
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| 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 |
-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.