Resource Type: dsc_spuserprofileproperty

Defined in:

lib/puppet/type/dsc_spuserprofileproperty.rb

Providers:

powershell

Overview

The DSC SPUserProfileProperty resource type. Automatically generated from ‘SharePointDsc/DSCResources/MSFT_SPUserProfileProperty/MSFT_SPUserProfileProperty.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_description

  Description - The description of the property

• dsc_displayname

  DisplayName - The display name of the property

• dsc_displayorder

  DisplayOrder - The display order to put the property in to the list at

• dsc_ensure

  Ensure - Present if the property should exist, absent if it should be removed Valid values are Present, Absent.

• dsc_installaccount

  InstallAccount - POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5

• dsc_isalias

  IsAlias - Is this field an alias that can be used to refer to a user by

  Supported values:

  • true
  • false
• dsc_iseventlog

  IsEventLog - Is this field used for event logging

  Supported values:

  • true
  • false
• dsc_issearchable

  IsSearchable - Is this field able to be searched upon

  Supported values:

  • true
  • false
• dsc_isusereditable

  IsUserEditable - Is this field able to be edited by a user, or only an administrator

  Supported values:

  • true
  • false
• dsc_isvisibleoneditor

  IsVisibleOnEditor - Is this field visible when editing a users profile, or hidden from editing

  Supported values:

  • true
  • false
• dsc_isvisibleonviewer

  IsVisibleOnViewer - Is this field visible when viewing a users profile

  Supported values:

  • true
  • false
• dsc_length

  Length - The length of the field

• dsc_mappingconnectionname

  MappingConnectionName - The name of the UPS connect to map this property to

• dsc_mappingdirection

  MappingDirection - The direction of the mapping, either Import or Export

• dsc_mappingpropertyname

  MappingPropertyName - The name of the property from the UPS connection to map to

• dsc_name

  Name - The internal name of the user profile property

• dsc_policysetting

  PolicySetting - The policy setting to apply to the property Valid values are Mandatory, Optin, Optout, Disabled.

• dsc_privacysetting

  PrivacySetting - The privacy setting for the property Valid values are Public, Contacts, Organization, Manager, Private.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_termgroup

  TermGroup - The name of the term store group that terms are in for this field

• dsc_termset

  TermSet - The name of the term set to allow values to be selected from

• dsc_termstore

  TermStore - The name of the term store to look up managed terms from

• dsc_type

  Type - The type of the property Valid values are Big Integer, Binary, Boolean, Date, DateNoYear, Date Time, Email, Float, HTML, Integer, Person, String (Single Value), String (Multi Value), TimeZone, Unique Identifier, URL.

• dsc_useroverrideprivacy

  UserOverridePrivacy - Can users override the default privacy policy

  Supported values:

  • true
  • false
• dsc_userprofileservice

  UserProfileService - The name of the user profile service application

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_spuserprofileproperty` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.