Guide

Data stream

Get-DataStream

Suggest Edits

Synopsis

Get a stream.

Syntax

Get-DataStream [-GroupID <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-DataStream [-StreamID <Int32>] [-Version <Int32>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all streams or returns a specific stream by its ID. If retrieving a specific stream, you can optionally specify its version. Without specifying it, the latest version is returned by default. When listing all streams, you can filter the results by group ID or property name.

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.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑GroupID
Int Parameter sets: all Pipeline input: False

Your group's ID.
‑Section
String Pipeline input: False

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

Your stream's ID.
‑Version
Int Parameter sets: single Pipeline input: False

Your stream's version. If omitted, the operation returns the latest stream version.

Related Links

Updated 8 days ago