MSFT_FSRMFMJAction class
Represents a file management job action object.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[dynamic, provider("FSRMWmiProvider")]
class MSFT_FSRMFMJAction
{
uint32 Type;
string ExpirationFolder;
boolean RMSFolderOwner;
string RMSFullControlUser[] = {};
string RMSReadUser[] = {};
string RMSWriteUser[] = {};
string RMSTemplate = "";
string Command;
string WorkingDirectory = "";
string CommandParameters = "";
uint32 SecurityLevel = 2;
};
Members
The MSFT_FSRMFMJAction class has these types of members:
Methods
The MSFT_FSRMFMJAction class has these methods.
| Method | Description |
|---|---|
| CreateFMJAction | Creates a new MSFT_FSRMFMJAction instance. |
| EnumRmsTemplates | Enumerates the available RMS templates. |
Properties
The MSFT_FSRMFMJAction class has these properties.
-
Command
-
-
Data type: string
-
Access type: Read/write
A string that refers to a valid executable file. Must not exceed the length of MAX_PATH (260). Required.
This property is only valid when the Type property is 2 (Custom).
-
-
CommandParameters
-
-
Data type: string
-
Access type: Read/write
A string up to 10KB in size. The default value is an empty string. Optional.
This property is required when the Type property is 2 (Custom). See the Arguments property of IFsrmActionCommand.
-
-
ExpirationFolder
-
-
Data type: string
-
Access type: Read/write
A string representing a path to a local or remote folder. Optional. Size must not exceed the value of MAX_PATH (260).
This property is only valid when the Type property is 1 (Expiration).
-
-
RMSFolderOwner
-
-
Data type: boolean
-
Access type: Read/write
Add the FolderOwner to the full control list if True. Has no effect if no FolderOwner is available for the file.
This property is only valid when the Type property is 3 (RMS) and the RMSTemplate property is not specified.
-
-
RMSFullControlUser
-
-
Data type: string array
-
Access type: Read/write
An array of user email addresses to provide with full control. Each string must be less than 1KB in size. This parameter is optional. The default value is an empty list.
This property is required when the Type property is 3 (RMS) and the RMSTemplate property is empty or not specified.
-
-
RMSReadUser
-
-
Data type: string array
-
Access type: Read/write
A list of user email addresses to provide with read access. Each string must be less than 1KB in size. This parameter is optional. The default value is an empty list.
This property is only valid when the Type property is 3 (RMS) and the RMSTemplate property is empty or not specified.
-
-
RMSTemplate
-
-
Data type: string
-
Access type: Read/write
The name of an RMS template. Must be fewer than 1000 characters. This parameter is optional. The default value is an empty string.
This property is required the Type property is 3 (RMS) and the RMSFullControlUser property is empty or not specified. If this property is specified then the RMSFolderOwner, RMSFullControlUser, RMSReadUser, and RMSWriteUser properties must not be specified.
-
-
RMSWriteUser
-
-
Data type: string array
-
Access type: Read/write
A list of user email addresses to provide with write access. Each string must be less than 1KB in size. This parameter is optional. The default value is an empty list.
This property is only valid when the Type property is 3 (RMS) and the RMSTemplate property is empty or not specified.
-
-
SecurityLevel
-
-
Data type: uint32
-
Access type: Read/write
The account under which the executable program or script will be run. This property is only valid when the Type property is 2 (Custom). The default value is 2 (LocalService). See the FsrmAccountType enumeration.
-
-
None (0)
-
The security level is not specified.
-
NetworkService (1)
-
The action is run in the context of the NetworkService Account.
-
LocalService (2)
-
The action is run in the context of the LocalService Account.
-
LocalSystem (3)
-
The action is run in the context of the LocalSystem Account.
Type
-
Data type: uint32
-
Access type: Read/write
Specifies the type of the action. Not all types support all properties. Properties that are not supported must be cleared if the Type property value is changed. See the Remarks section for a table that shows which properties are supported for each type.
Expiration (1)
The action is an expiration action.
Custom (2)
The action is a custom action.
RMS (3)
The action is a Rights Managed Services (RMS) action.
WorkingDirectory
-
Data type: string
-
Access type: Read/write
A string that refers to a valid path to a folder. The length must not exceed MAX_PATH (260). Remote paths are not supported. The default value is an empty string.
This property is only valid when the Type property is 2 (Custom). See the WorkingDirectory property of IFsrmActionCommand.
Remarks
Not all action types support every property in the class. The table below indicates which properties in this class are supported by each action type in the Type property.
| Property/Type | Expiration (1) | Custom (2) | RMS (3) |
|---|---|---|---|
| ExpirationFolder | Yes | No | No |
| RMSFolderOwner | No | No | Yes |
| RMSFullControlUser | No | No | Yes |
| RMSReadUser | No | No | Yes |
| RMSWriteUser | No | No | Yes |
| RMSTemplate | No | Yes | Yes |
| Command | No | Yes | No |
| WorkingDirectory | No | Yes | No |
| Parameters | No | Yes | No |
| SecurityLevel | No | Yes | No |
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\Microsoft\Windows\FSRM |
| MOF |
|
| DLL |
|