Guide

Stream

Set-MSLStream

Suggest Edits

Synopsis

Update a stream.

Syntax

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

Description

Modifies an existing stream. The request body object needs to be identical in structure to the Get-Stream response object.

You can edit the name, ingestAccelerated, password, dvrWindow, allowedIps, and additionalEmailIds members. If you try to edit any other member, the API returns a 400 error.

Note: This function supports the pipeline, and can also read the -StreamID from the piped object.

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.
‑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: ByPropertyName

Your stream's ID.

Related Links

Updated about 5 hours ago