Resource Type: dsc_sposearchmanagedproperty

Defined in:
lib/puppet/type/dsc_sposearchmanagedproperty.rb

Overview

The DSC SPOSearchManagedProperty resource type. Automatically generated from version 1.21.1222.1

Properties

  • dsc_aliases

    Define an alias for a managed property if you want to use the alias instead of the managed property name in queries and in search results. Use the original managed property and not the alias to map to a crawled property. Use an alias if you don’t want to or don’t have permission to create a new managed property.

  • dsc_allowmultiplevalues

    Allow multiple values of the same type in this managed property. For example, if this is the ‘author’ managed property, and a document has multiple authors, each author name will be stored as a separate value in this managed property.

  • dsc_applicationid

    Id of the Azure Active Directory application to authenticate with.

  • dsc_applicationsecret

    Secret of the Azure Active Directory application to authenticate with.

  • dsc_certificatepath

    Path to certificate used in service principal usually a PFX file.

  • dsc_certificatethumbprint

    Thumbprint of the Azure Active Directory application’s authentication certificate to use for authentication.

  • dsc_companynameextraction

    Enables the system to extract company name entities from the managed property when crawling new or updated items. Afterwards, the extracted entities can be used to set up refiners in the web part.

  • dsc_completematching

    By default, search returns partial matches between queries against this managed property and its content. Select Complete Matching for search to return exact matches instead. If a managed property ‘Title’ contains ‘Contoso Sites’, only the query Title: ‘Contoso Sites’ will give a result.

  • dsc_description

    Description of the Managed Property

  • dsc_ensure

    Present ensures the Search Managed Property exists.

  • dsc_finerquerytokenization

    By default, search tokenizes queries coarser than content. If a managed property ‘ID’ contains the string ‘1-23-456#7’, and you query ID:‘1-23’, you might not get a partial match because search didn’t break the query into small enough parts. Consider selecting finer query tokenization if the content of this managed property contains separators such as dots and dashes. Finer query tokenization makes queries against this managed property slower.

  • dsc_fulltextcontext

    Defines the context of a managed property within its full-text index.

  • dsc_fulltextindex

    Defines which full-text index the Managed Property is stored in.

  • dsc_languageneutraltokenization

    By default, search depends on language when it breaks queries and content into parts (tokenization). Select language neutral tokenization if you have multilingual content and this managed property contains tags that are based on metadata term sets or other identifiers.

  • dsc_mappedcrawledproperties

    Names of the crawled properties that are mapped to this managed property

  • dsc_queryable

    Enables querying against the specific Managed Property. The Managed Property field name must be included in the query, either specified in the query itself or included in the query programmatically. If the Managed Property is ‘author’, the query must contain ‘author:Smith’.

  • dsc_refinable

    Yes: Enables using the property as a refiner for search results in the front end. You must manually configure the refiner in the web part. Yes - latent: Enables switching refinable to active later, without having to do a full re-crawl when you switch. Both options require a full crawl to take effect.

  • dsc_retrievable

    Enables the content of this managed property to be returned in search results. Enable this setting for managed properties that are relevant to present in search results.

  • dsc_safe

    Enables this managed property to be returned for queries executed by anonymous users. Enable this setting for managed properties that do not contain sensitive information and are appropriate for anonymous users to view.

  • dsc_searchable

    Enables querying against the content of the managed property. The content of this managed property is included in the full-text index. For example, if the property is ‘author’, a simple query for ‘Smith’ returns items containing the word ‘Smith’ and items whose author property contains ‘Smith’.

  • dsc_sortable

    Yes: Enables sorting the result set based on the property before the result set is returned. Use for example for large result sets that cannot be sorted and retrieved at the same time. Yes - latent: Enables switching sortable to active later, without having to do a full re-crawl when you switch. Both options require a full crawl to take effect.

  • dsc_tenantid

    Name of the Azure Active Directory tenant used for authentication. Format contoso.onmicrosoft.com

  • dsc_tokennormalization

    Enable to return results independent of letter casing and diacritics(for example accented characters) used in the query.

Parameters

  • dsc_certificatepassword

    Username can be made up to anything but password will be used for certificatePassword

  • dsc_credential

    Credentials of the account to authenticate with.

  • dsc_name (namevar)

    The Name of the Managed Property

  • dsc_psdscrunascredential
  • dsc_type (namevar)

    The Type of the Managed Property

  • name (namevar)

    Description of the purpose for this resource declaration.

  • validation_mode (defaults to: property)

    Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).