MSFT_FSRMADRSettings class

Returns an object containing event settings as supplied by the server.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[dynamic, provider("FSRMWmiProvider")]
class MSFT_FSRMADRSettings
{
  uint32  Event;
  boolean Enabled = False;
  string  DisplayMessage;
  string  EmailMessage;
  boolean AllowRequests = False;
  boolean MailToOwner = True;
  boolean MailCCAdmin = True;
  string  MailTo = "";
  boolean IncludeDeviceClaims = True;
  boolean IncludeUserClaims = True;
  boolean EventLog = True;
  boolean DeviceTroubleShooting = True;
  boolean SetByPolicy = False;
};

Members

The MSFT_FSRMADRSettings class has these types of members:

Properties

The MSFT_FSRMADRSettings class has these properties.

AllowRequests

Data type: boolean

Access type: Read/write

An optional value that specifies whether users are allowed to request access by sending email. The default value is False.

DeviceTroubleShooting

Data type: boolean

Access type: Read/write

An optional value that specifies whether to show the user the offending device claims during the interaction. The default value is True.

DisplayMessage

Data type: string

Access type: Read/write

An optional message sent to a user upon receiving the event. The length of the string must not exceed 10KB.

EmailMessage

Data type: string

Access type: Read/write

An optional message sent to a user upon receiving the event. The length of the string must not exceed 10KB.

Enabled

Data type: boolean

Access type: Read/write

Specifies whether to enable remediation for the event on this server. The default value is False.

Event

Data type: uint32

Access type: Read-only

Qualifiers: key

Describes the type of failure handled by ADR.

AccessDenied (1)

The failure was an access denied error.

FileNotFound (2)

The failure was an file not found error.

EventLog

Data type: boolean

Access type: Read/write

An optional value that specifies whether to create an Event Log entry for each access email sent. The default value is True.

IncludeDeviceClaims

Data type: boolean

Access type: Read/write

An optional value that specifies whether to include device claims in a request. The default value is True.

IncludeUserClaims

Data type: boolean

Access type: Read/write

An optional value that specifies whether to include user claims in a request. The default value is True.

MailCCAdmin

Data type: boolean

Access type: Read/write

An optional value that specifies whether the system administrator is included on the CC line when a request is sent. The default value is True.

MailTo

Data type: string

Access type: Read/write

An optional semicolon-separated list of email addresses to which the request will be sent. The string is empty by default.

MailToOwner

Data type: boolean

Access type: Read/write

An optional value that specifies whether the data owner is contacted when a request is sent. The default value is True.

SetByPolicy

Data type: boolean

Access type: Read-only

Indicates whether these settings were set by group policy. The default value is False.

Remarks

Not all combinations of properties are supported. The Name property is always required. The UpdateDerived and UpdateDerivedMatching properties are mutually exclusive if one is provided then the other must not be set. Only one of Description, Size, SoftLimit, and Threshold must be provided. The table below indicates which combinations of properties in this class are supported.

Property

Valid combinations

Name

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Description

Yes

Yes

No

No

No

No

No

No

Size

No

No

Yes

Yes

No

No

No

No

SoftLimit

No

No

No

No

Yes

Yes

No

No

Threshold

No

No

No

No

No

No

Yes

Yes

UpdateDerived

Yes

No

Yes

No

Yes

No

Yes

No

UpdateDerivedMatching

No

Yes

No

Yes

No

Yes

No

Yes

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\Microsoft\Windows\FSRM
MOF
MSFT_FSRM.mof
DLL
SrmSvc.dll

See also

FSRM WMI Classes

IFsrmAccessDeniedRemediationClient