Guide

Property

Set-GTMProperty

Suggest Edits

Synopsis

Create or update a property.

Syntax

Set-GTMProperty [-DomainName] <String> [-PropertyName] <String> [-Body] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates or updates a GTM property. This function is identical to the New-GTMProperty operation. If the specified property doesn't already exist, it'll be created.

Note: Due to the complexity of the request body, it's recommended that you pull down the existing property, edit it locally, and pipe the object to this function.

Parameters

‑AccountSwitchKey
String Pipeline input: False

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
‑Body
Required
Object Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑DomainName
Required
String Pipeline input: False

The full GTM domain name.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑PropertyName
Required
String Pipeline input: ByPropertyName

The name of Traffic Management property.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

Related Links

Updated 4 months ago