az stream-analytics job

Commands to manage stream-analytics streaming job.

Commands

az stream-analytics job create

Create a streaming job or replaces an already existing streaming job.

az stream-analytics job delete

Delete a streaming job.

az stream-analytics job list

List all of the streaming jobs in the specified resource group.

az stream-analytics job show

Get details about the specified streaming job.

az stream-analytics job start

Start a streaming job.

az stream-analytics job stop

Stop a running streaming job.

az stream-analytics job update

Update existing streaming job.

az stream-analytics job wait

Place the CLI in a waiting state until a condition of the streaming job is met.

az stream-analytics job create

Create a streaming job or replaces an already existing streaming job.

az stream-analytics job create --name
                               --resource-group
                               [--compatibility-level {1.0}]
                               [--data-locale]
                               [--events-late-arrival-max-delay]
                               [--events-outoforder-max-delay]
                               [--events-outoforder-policy {Adjust, Drop}]
                               [--location]
                               [--no-wait]
                               [--output-error-policy {Drop, Stop}]
                               [--sku {Standard}]
                               [--tags]

Examples

Create a streaming job

az stream-analytics job create --resource-group MyResourceGroup --name MyJobName \
--location "West US" --output-error-policy "Drop" --events-outoforder-policy "Drop" \
--events-outoforder-max-delay 5 --events-late-arrival-max-delay 16 --data-locale "en-US"

Required Parameters

--name -n

The name of the streaming job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--compatibility-level

Controls certain runtime behaviors of the streaming job.

accepted values: 1.0
default value: 1.0
--data-locale

The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to "en-US" if none specified.

--events-late-arrival-max-delay

The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely.

--events-outoforder-max-delay

The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.

--events-outoforder-policy

Indicates the policy to apply to events that arrive out of order in the input event stream.

accepted values: Adjust, Drop
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

Do not wait for the long-running operation to finish.

--output-error-policy

Indicates the policy to apply to events that arrive at the output.

accepted values: Drop, Stop
--sku

The name of the SKU.

accepted values: Standard
default value: Standard
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az stream-analytics job delete

Delete a streaming job.

az stream-analytics job delete --name
                               --resource-group
                               [--no-wait]

Examples

Delete a streaming job

az stream-analytics job delete --resource-group MyResourceGroup --name MyJobName

Required Parameters

--name -n

The name of the streaming job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az stream-analytics job list

List all of the streaming jobs in the specified resource group.

az stream-analytics job list [--expand]
                             [--resource-group]

Examples

List all streaming jobs in current subscription

az stream-analytics job list

List all streaming jobs in a resource group

az stream-analytics job list --resource-group MyResourceGroup

List all streaming jobs and expand their inputs, outputs, transformation, and functions

az stream-analytics job list --resource-group MyResourceGroup --expand

Optional Parameters

--expand

Expand inputs, transformation, outputs and functions of the streaming job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az stream-analytics job show

Get details about the specified streaming job.

az stream-analytics job show --name
                             --resource-group
                             [--expand]

Examples

Get a streaming job

az stream-analytics job show --resource-group MyResourceGroup --name MyJobName

Get a streaming job and expand its inputs, outputs, transformation, and functions

az stream-analytics job show --resource-group MyResourceGroup --name MyJobName --expand

Required Parameters

--name -n

The name of the streaming job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--expand

Expand inputs, transformation, outputs and functions of the streaming job.

az stream-analytics job start

Start a streaming job.

az stream-analytics job start --name
                              --resource-group
                              [--no-wait]
                              [--output-start-mode {CustomTime, JobStartTime, LastOutputEventTime}]
                              [--output-start-time]

Examples

Start a streaming job with LastOutputEventTime output start mode

az stream-analytics job start --resource-group MyResourceGroup --name MyJobName --output-start-mode LastOutputEventTime

Start a streaming job with JobStartTime output start mode

az stream-analytics job start --resource-group MyResourceGroup --name MyJobName --output-start-mode JobStartTime

Start a streaming job with CustomTime output start mode

az stream-analytics job start --resource-group MyResourceGroup --name MyJobName --output-start-mode CustomTime --output-start-time 2020-01-01T00:00:00Z

Required Parameters

--name -n

The name of the streaming job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

--output-start-mode

Output start mode.

accepted values: CustomTime, JobStartTime, LastOutputEventTime
default value: JobStartTime
--output-start-time

Output start time, must have a value if --output-start-mode is set to CustomTime.

az stream-analytics job stop

Stop a running streaming job.

az stream-analytics job stop --name
                             --resource-group
                             [--no-wait]

Examples

Stop a streaming job

az stream-analytics job stop --resource-group MyResourceGroup --name MyJobName

Required Parameters

--name -n

The name of the streaming job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

az stream-analytics job update

Update existing streaming job.

az stream-analytics job update --name
                               --resource-group
                               [--data-locale]
                               [--events-late-arrival-max-delay]
                               [--events-outoforder-max-delay]
                               [--events-outoforder-policy {Adjust, Drop}]
                               [--output-error-policy {Drop, Stop}]
                               [--tags]

Examples

Update a streaming job

az stream-analytics job update --resource-group MyResourceGroup --name MyJobName \
--events-outoforder-max-delay 21 --events-late-arrival-max-delay 13

Required Parameters

--name -n

The name of the streaming job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--data-locale

The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx.

--events-late-arrival-max-delay

The maximum tolerable delay in seconds where events arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely.

--events-outoforder-max-delay

The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.

--events-outoforder-policy

Indicates the policy to apply to events that arrive out of order in the input event stream.

accepted values: Adjust, Drop
--output-error-policy

Indicates the policy to apply to events that arrive at the output.

accepted values: Drop, Stop
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az stream-analytics job wait

Place the CLI in a waiting state until a condition of the streaming job is met.

az stream-analytics job wait --name
                             --resource-group
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--expand]
                             [--interval]
                             [--timeout]
                             [--updated]

Examples

Pause executing next line of CLI script until the streaming job is successfully provisioned.

az stream-analytics job wait --resource-group MyResourceGroup --name MyJobName --created

Required Parameters

--name -n

The name of the streaming job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--expand

The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.