Guide

Domain

Set-GTMDomain

Suggest Edits

Synopsis

Update a domain.

Syntax

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

Description

Updates a specific GTM domain. You can use this function to update all aspects of a GTM domain at once. However, for such operations, it's recommended that you pull down the existing domain, 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: ByPropertyName

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

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑IncludeStatus
Switch Pipeline input: False

Returns the complete API response, rather than scoping to the 'resource' member. Note: You can't then pipe this object to another invocation of this function.
‑Section
String Pipeline input: False

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

Related Links

Updated 8 days ago