Get-SPOTerm

Retrieves a Term or Terms matching the specified criteria.

Get-SPOTerm -Identity <String> [-StringMatchOption [<StringMatchOption>]] [-DefaultLabelOnly [<SwitchParameter>]] [-TrimUnavailable [<SwitchParameter>]] [-TrimDeprecated [<SwitchParameter>]] [-ResultCollectionSize [<Int32>]]

Parameters

1

ParameterRequiredTypeDescription
IdentityTrueString

The Term to retrieve.

StringMatchOptionFalseStringMatchOption

Retrieve terms that match the value exactly or just start with the value. The default value is ExactMatch.

DefaultLabelOnlyFalseSwitchParameter

If specified,only default labels should be matched against in the search.

TrimUnavailableFalseSwitchParameter

If specified, trim Terms that are unavailable.

TrimDeprecatedFalseSwitchParameter

If specified, trim out Term objects that have Term.IsDeprecated set to true.

ResultCollectionSizeFalseInt32

Indicates the maximum number of objects to include in the returned collection. The default value is 1.

Detailed Description

Retrieves a Term or Terms matching the specified criteria.

Copyright 2016 Falchion Consulting, LLC

> For more information on this cmdlet and others:

> http://blog.falchionconsulting.com/

> Use of this cmdlet is at your own risk.

> Gary Lapointe assumes no liability.

Examples

------------------EXAMPLE------------------

PS C:\> Get-SPOTerm -Identity "My Term" -StringMatchOption "ExactMatch"

This example retrieves one or more Terms matching the value My Term.