Guide

Data stream

New-DataStream

Suggest Edits

Synopsis

Create a stream.

Syntax

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

Description

Creates a stream configuration. Within a stream configuration, you can select properties to monitor in the stream, data set fields to collect in logs, and a destination to send these log files to. Apart from the log and delivery frequency configurations, you can decide whether to activate the stream on making the request or later using the -Activate switch parameter.

Note: Only active streams can collect and send logs to their destinations.

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.

Related Links

Updated about 5 hours ago