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, -IploadFilePrefix, 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

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run the Get-AccountSwitchKey command to list the account switch keys available to you.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Activate

Activates the stream at the time of the request, false by default. When you edit a stream that is active, you need to set this member to true.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Body

Request body, either as a PSCustomObject or string. This parameter supports pipelining.

Type: Object
Parameter Sets: (All)
Aliases: None
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StreamID

Uniquely identifies the stream.

Type: Int32
Parameter Sets: (All)
Aliases: None
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Object

Outputs