Data stream
Update-DataStream
Synopsis
Update specific aspects of a stream.
Syntax
Update-DataStream [-StreamID] <Int32> [-Body] <Object> [-Activate] [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Description
Updates selected details of an existing stream using JSON Patch syntax. Running this operation creates a stream version that replaces the current one. Currently, you can patch a stream using only the REPLACE operation.
When updating configuration objects, such as destination or deliveryConfiguration, pass the complete object. Thanks to this, you can avoid overwriting current details with the default values for omitted parameters, such as tags, uploadFilePrefix, and uploadFileSuffix.
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 |
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 |
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. |
‑BodyRequired |
A request body, either as a |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑StreamIDRequired |
Your stream's ID. |
Related Links
Updated 10 days ago