Guide

Data stream

Set-DataStream

Suggest Edits

Synopsis

Edit a stream.

Syntax

Set-DataStream [-StreamID] <Int32> [-Body] <Object> [-Activate] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates the latest version of a stream. Running this operation creates a version of the stream that replaces the existing one. Note that only active streams can collect and send logs to their destinations.

You need to add the -Activate switch parameter when patching active streams, and optionally for inactive streams if you want to activate them upon request.

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.
‑Activate
Switch Pipeline input: False

Add this switch to activate the stream at the time of the request. When you edit a stream that is active, you need to disable this switch.
‑Body
Required
Object Pipeline input: ByValue

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

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

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑StreamID
Required
Int Pipeline input: False

Your stream's ID.

Related Links

Updated 8 days ago