New-TeamViewerDeviceCustomFieldConfiguration.md

---

external help file: TeamViewerPS-help.xml Module Name: TeamViewerPS online version: https://github.com/teamviewer/TeamViewerPS/blob/main/Docs/Help/New-TeamViewerDeviceCustomFieldConfiguration.md schema: 2.0.0

New-TeamViewerDeviceCustomFieldConfiguration

SYNOPSIS

Creates a device custom field definition for the company.

SYNTAX

New-TeamViewerDeviceCustomFieldConfiguration [-APIToken] <SecureString> [-FieldKey] <String> [[-Description] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a company-level device custom field definition. The API supports up to 50 definitions per company.

PARAMETERS

-APIToken

The TeamViewer API access token.

Type: SecureString
Parameter Sets: (All)
Aliases: None

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

-FieldKey

The name of the custom field.

Type: String
Parameter Sets: (All)
Aliases: None

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

-Description

An optional description of the custom field.

Type: String
Parameter Sets: (All)
Aliases: None

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

EXAMPLES

Example 1

New-TeamViewerDeviceCustomFieldConfiguration -APIToken $apiToken -FieldKey 'AssetTag' -Description 'Device asset tag'

Creates an AssetTag device custom field with a description.

Example 2

New-TeamViewerDeviceCustomFieldConfiguration -FieldKey 'Location'

Creates a Location device custom field without a description.

Example 3

'AssetTag', 'Location', 'Owner' | ForEach-Object { New-TeamViewerDeviceCustomFieldConfiguration -FieldKey $_ }

Creates multiple device custom field definitions in a single pipeline.

OUTPUTS

TeamViewerPS.DeviceCustomFieldConfiguration

Returns the created device custom field definition.