Guide

Stream

New-MSLStream

Suggest Edits

Synopsis

Create a stream.

Syntax

New-MSLStream [-Body] <Object> [[-CloneInternalSettingsFromStreamID] <String>] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Provisions a new stream. The process of creating or updating any stream changes its status to PENDING. When all of the steps are complete, the stream status changes to PROVISIONED. If any of the steps fail, the stream status changes to FAILED. It takes two to three hours to provision a stream.

Note: Due to the complexity of the request body, it may be easier to retrieve an existing stream (if one exists), edit the details locally and pipe 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 string. This parameter supports pipelining.
‑CloneInternalSettingsFromStreamID
String Pipeline input: False

The stream to clone the internal settings from.
‑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 6 days ago