Msft_SyncShare class

Article
05/31/2018

Represents a Work Folders sync share, which is a file share that is managed by Work Folders.

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

Syntax

[dynamic, provider("SyncShareServerWmiProvider")]
class Msft_SyncShare
{
  string  Name;
  string  Description;
  string  Type;
  string  Path;
  string  UserFolderName;
  string  User[];
  boolean InheritParentFolderPermission;
  boolean Enabled;
  string  StagingFolder;
  uint64  MaxUploadFile;
  boolean RequireEncryption;
  boolean RequirePasswordAutoLock;
  string  FallbackEnterpriseID;
  string  PasswordAutolockExcludeDomain[];
};

Members

The Msft_SyncShare class has these types of members:

Methods
Properties

Methods

The Msft_SyncShare class has these methods.

Method	Description
Disable	Disables the Work Folders share.
Enable	Enables the Work Folders share.
Repair	Resets the Work Folders sync share metadata for the specified user.

Properties

The Msft_SyncShare class has these properties.

Description

Data type: string
Access type: Read/write

Gets or sets the description of the Work Folders sync share.

Enabled

Data type: boolean
Access type: Read-only

Gets a value that indicates whether the Work Folders sync share is enabled. True if the Work Folders sync share is enabled; otherwise false.

FallbackEnterpriseID

Data type: string
Access type: Read/write

Specifies the fallback Enterprise ID that the sync share uses if it cannot successfully query Active Directory Domain Services (AD DS). If the server cannot successfully query AD DS, the server uses the fully qualified domain name (FQDN) of the sync server as the fallback Enterprise ID unless you specify a different Enterprise ID by using this property. The Enterprise ID is issued by the Work Folders client to encrypt data on the PC or device. The Enterprise ID is typically constructed by querying AD DS for the primary SMTP address of the user, removing the username and ampersand (user@), and sending the remainder to the client as the Enterprise ID. For example, "EvanNarvaez@Contoso.com" yields the "contoso.com" Enterprise ID.

InheritParentFolderPermission

Data type: boolean
Access type: Read/write

Indicates that the sync share inherits the permissions of the parent folder. If you specify this property, the user folder inherits permissions from the parent folder of the sync share, and administrators can access the data. If you do not specify this property, by default each user is granted exclusive access to their user folder, and administrators have no access rights.

MaxUploadFile

Data type: uint64
Access type: Read/write

Gets or sets the maximum file size for an upload to the Work Folders sync share, in bytes.

Name

Data type: string
Access type: Read/write
Qualifiers: key

Gets or sets the name of the Work Folders sync share. The Name property has the following requirements:

Must be unique on the sync server.
Can have a maximum of 75 characters.
Cannot start or end a name with a space.
Cannot end a name with a period.
Cannot use a reserved name, such as COM1, LPT1, NUL, etc.
Cannot contain the following characters: <>:\"/\\|?*.

PasswordAutolockExcludeDomain

Data type: string array
Access type: Read/write

Specifies a list of domain names in fully qualified domain name (FQDN) format whose clients are to be exempted from the password policy. If the RequirePasswordAutoLock property on the sync share is False, then this property has no effect. If the RequirePasswordAutoLock property is True, then clients that are members of the specified domains are not requested by Work Folders to enforce password length and lock policies on the device. It is assumed that their security is managed by the Group Policy of their domain.

Windows 8.1 and Windows Server 2012 R2: This property is not supported before Windows 8.1 Update and Windows Server 2012 R2 Update.

Path

Data type: string
Access type: Read/write

Specifies the path to the Work Folders sync share. Once the sync share is created the path cannot be changed.

RequireEncryption

Data type: boolean
Access type: Read/write

Gets or sets a value that indicates whether this Work Folders sync share requires encryption. True if the Work Folders sync share requires encryption; otherwise false.

RequirePasswordAutoLock

Data type: boolean
Access type: Read/write

Indicates whether the device meets the following policies:

Password minimum length of six characters.
Lock screen activates after a maximum of 15 minutes.
User account lockout after a maximum of 10 failed sign-in attempts.

StagingFolder

Data type: string
Access type: Read-only

Gets the path to the staging directory for the Work Folders sync share.

Type

Data type: string
Access type: Read/write

Retrieves the type of the Work Folders sync share.

User

Data type: string array
Access type: Read/write

Specifies an array of user names or security groups who are allowed to sync data with this sync share. Add accounts or security groups in Security Accounts Manager (SAM) account format.

UserFolderName

Data type: string
Access type: Read/write

Specifies a folder-naming format for the user folder on the sync share. To maintain compatibility with existing user folders that use aliases for their names, specify user, which is required, or omit this property. To eliminate conflicts between identical user aliases in different domains, specify user@domain. You can also specify a relative path under the sync share root; for example, UserData\user. Sync share creates each user folder during the first sync operation, if it doesn t already exist. If the user folder exists, confirm that the user has Read/Write or Full Control permissions and is the owner of their folder, unless the folder is owned by an Administrators group.

Requirements


Minimum supported client	Windows 8.1
Minimum supported server	Windows Server 2012 R2
Namespace	Root\Microsoft\Windows\SyncShareServer
MOF	ECSServer.Mof
DLL	SyncShareSvc.dll