Streaming Jobs - Start

Starts a streaming job. Once a job is started it will start processing input events and produce output.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/start?api-version=2017-04-01-preview

URI Parameters

Name In Required Type Description
jobName
path True
  • string

The name of the streaming job.

resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

Request Body

Name Type Description
outputStartMode

Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.

outputStartTime
  • string

Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.

Responses

Name Type Description
200 OK

The streaming job was successfully started.

202 Accepted

The start streaming job request was successfully initiated.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Start a streaming job with CustomTime output start mode
Start a streaming job with JobStartTime output start mode
Start a streaming job with LastOutputEventTime output start mode

Start a streaming job with CustomTime output start mode

Sample Request

POST https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/start?api-version=2017-04-01-preview
{
  "outputStartMode": "CustomTime",
  "outputStartTime": "2012-12-12T12:12:12Z"
}

Sample Response

Start a streaming job with JobStartTime output start mode

Sample Request

POST https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/start?api-version=2017-04-01-preview
{
  "outputStartMode": "JobStartTime"
}

Sample Response

Start a streaming job with LastOutputEventTime output start mode

Sample Request

POST https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/start?api-version=2017-04-01-preview
{
  "outputStartMode": "LastOutputEventTime"
}

Sample Response

Definitions

OutputStartMode

Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.

StartStreamingJobParameters

Parameters supplied to the Start Streaming Job operation.

OutputStartMode

Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.

Name Type Description
CustomTime
  • string
JobStartTime
  • string
LastOutputEventTime
  • string

StartStreamingJobParameters

Parameters supplied to the Start Streaming Job operation.

Name Type Description
outputStartMode

Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time.

outputStartTime
  • string

Value is either an ISO-8601 formatted time stamp that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.