Table of Contents

New-PnPTerm

SYNOPSIS

Creates a taxonomy term

SYNTAX

New-PnPTerm -Name <String> [-Id <Guid>] [-Lcid <Int32>] [-TermSet] <TaxonomyTermSetPipeBind>
 -TermGroup <TaxonomyTermGroupPipeBind> [-Description <String>] [-CustomProperties <Hashtable>]
 [-LocalCustomProperties <Hashtable>] [-TermStore <TaxonomyTermStorePipeBind>]
 

DESCRIPTION

This cmdlet adds a new taxonomy term to a given termset.

EXAMPLES

Example 1

New-PnPTerm -TermSet "Departments" -TermGroup "Corporate" -Name "Finance"

Creates a new taxonomy term named "Finance" in the termset Departments which is located in the "Corporate" termgroup

Example 2

New-PnPTerm -TermSet "Departments" -TermGroup "Corporate" -Name "Finance" -CustomProperties @{"IsCorporate"="True"}

Creates a new taxonomy term named "Finance" in the termset Departments which is located in the "Corporate" termgroup and sets a custom property on the termset.

PARAMETERS

-CustomProperties

Sets custom properties.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description

Descriptive text to help users understand the intended use of this term.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

The Id to use for the term; if not specified, or provided with an empty GUID, a random GUID is generated and used.

Type: Guid
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Lcid

The locale id to use for the term. Defaults to the default language of the termstore.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LocalCustomProperties

Sets local custom properties

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of the term.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TermGroup

The termgroup to create the term in.

Type: TaxonomyTermGroupPipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TermSet

The termset to add the term to.

Type: TaxonomyTermSetPipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TermStore

Term store to use; if not specified the default term store is used.

Type: TaxonomyTermStorePipeBind
Parameter Sets: (All)
Aliases: TermStoreName

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Microsoft 365 Patterns and Practices