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=2020-03-01
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
|
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.
|
Other Status Codes
|
Error
|
Error.
|
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
Sample Request
POST https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59/start?api-version=2020-03-01
{
"outputStartMode": "CustomTime",
"outputStartTime": "2012-12-12T12:12:12Z"
}
import com.azure.core.util.Context;
import com.azure.resourcemanager.streamanalytics.models.OutputStartMode;
import com.azure.resourcemanager.streamanalytics.models.StartStreamingJobParameters;
import java.time.OffsetDateTime;
/** Samples for StreamingJobs Start. */
public final class Main {
/*
* x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_CustomTime.json
*/
/**
* Sample code: Start a streaming job with CustomTime output start mode.
*
* @param manager Entry point to StreamAnalyticsManager.
*/
public static void startAStreamingJobWithCustomTimeOutputStartMode(
com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
manager
.streamingJobs()
.start(
"sjrg6936",
"sj59",
new StartStreamingJobParameters()
.withOutputStartMode(OutputStartMode.CUSTOM_TIME)
.withOutputStartTime(OffsetDateTime.parse("2012-12-12T12:12:12Z")),
Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armstreamanalytics_test
import (
"context"
"log"
"time"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_CustomTime.json
func ExampleStreamingJobsClient_BeginStart_startAStreamingJobWithCustomTimeOutputStartMode() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewStreamingJobsClient().BeginStart(ctx, "sjrg6936", "sj59", &armstreamanalytics.StreamingJobsClientBeginStartOptions{StartJobParameters: &armstreamanalytics.StartStreamingJobParameters{
OutputStartMode: to.Ptr(armstreamanalytics.OutputStartModeCustomTime),
OutputStartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2012-12-12T12:12:12.000Z"); return t }()),
},
})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Starts a streaming job. Once a job is started it will start processing input events and produce output.
*
* @summary Starts a streaming job. Once a job is started it will start processing input events and produce output.
* x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_CustomTime.json
*/
async function startAStreamingJobWithCustomTimeOutputStartMode() {
const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
const resourceGroupName = "sjrg6936";
const jobName = "sj59";
const startJobParameters = {
outputStartMode: "CustomTime",
outputStartTime: new Date("2012-12-12T12:12:12Z"),
};
const options = { startJobParameters };
const credential = new DefaultAzureCredential();
const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
const result = await client.streamingJobs.beginStartAndWait(resourceGroupName, jobName, options);
console.log(result);
}
startAStreamingJobWithCustomTimeOutputStartMode().catch(console.error);
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Start a streaming job with JobStartTime output start mode
Sample Request
POST https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59/start?api-version=2020-03-01
{
"outputStartMode": "JobStartTime"
}
import com.azure.core.util.Context;
import com.azure.resourcemanager.streamanalytics.models.OutputStartMode;
import com.azure.resourcemanager.streamanalytics.models.StartStreamingJobParameters;
/** Samples for StreamingJobs Start. */
public final class Main {
/*
* x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_JobStartTime.json
*/
/**
* Sample code: Start a streaming job with JobStartTime output start mode.
*
* @param manager Entry point to StreamAnalyticsManager.
*/
public static void startAStreamingJobWithJobStartTimeOutputStartMode(
com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
manager
.streamingJobs()
.start(
"sjrg6936",
"sj59",
new StartStreamingJobParameters().withOutputStartMode(OutputStartMode.JOB_START_TIME),
Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armstreamanalytics_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_JobStartTime.json
func ExampleStreamingJobsClient_BeginStart_startAStreamingJobWithJobStartTimeOutputStartMode() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewStreamingJobsClient().BeginStart(ctx, "sjrg6936", "sj59", &armstreamanalytics.StreamingJobsClientBeginStartOptions{StartJobParameters: &armstreamanalytics.StartStreamingJobParameters{
OutputStartMode: to.Ptr(armstreamanalytics.OutputStartModeJobStartTime),
},
})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Starts a streaming job. Once a job is started it will start processing input events and produce output.
*
* @summary Starts a streaming job. Once a job is started it will start processing input events and produce output.
* x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_JobStartTime.json
*/
async function startAStreamingJobWithJobStartTimeOutputStartMode() {
const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
const resourceGroupName = "sjrg6936";
const jobName = "sj59";
const startJobParameters = {
outputStartMode: "JobStartTime",
};
const options = { startJobParameters };
const credential = new DefaultAzureCredential();
const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
const result = await client.streamingJobs.beginStartAndWait(resourceGroupName, jobName, options);
console.log(result);
}
startAStreamingJobWithJobStartTimeOutputStartMode().catch(console.error);
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Start a streaming job with LastOutputEventTime output start mode
Sample Request
POST https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59/start?api-version=2020-03-01
{
"outputStartMode": "LastOutputEventTime"
}
import com.azure.core.util.Context;
import com.azure.resourcemanager.streamanalytics.models.OutputStartMode;
import com.azure.resourcemanager.streamanalytics.models.StartStreamingJobParameters;
/** Samples for StreamingJobs Start. */
public final class Main {
/*
* x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_LastOutputEventTime.json
*/
/**
* Sample code: Start a streaming job with LastOutputEventTime output start mode.
*
* @param manager Entry point to StreamAnalyticsManager.
*/
public static void startAStreamingJobWithLastOutputEventTimeOutputStartMode(
com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
manager
.streamingJobs()
.start(
"sjrg6936",
"sj59",
new StartStreamingJobParameters().withOutputStartMode(OutputStartMode.LAST_OUTPUT_EVENT_TIME),
Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armstreamanalytics_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_LastOutputEventTime.json
func ExampleStreamingJobsClient_BeginStart_startAStreamingJobWithLastOutputEventTimeOutputStartMode() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewStreamingJobsClient().BeginStart(ctx, "sjrg6936", "sj59", &armstreamanalytics.StreamingJobsClientBeginStartOptions{StartJobParameters: &armstreamanalytics.StartStreamingJobParameters{
OutputStartMode: to.Ptr(armstreamanalytics.OutputStartModeLastOutputEventTime),
},
})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
log.Fatalf("failed to pull the result: %v", err)
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Starts a streaming job. Once a job is started it will start processing input events and produce output.
*
* @summary Starts a streaming job. Once a job is started it will start processing input events and produce output.
* x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Start_LastOutputEventTime.json
*/
async function startAStreamingJobWithLastOutputEventTimeOutputStartMode() {
const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
const resourceGroupName = "sjrg6936";
const jobName = "sj59";
const startJobParameters = {
outputStartMode: "LastOutputEventTime",
};
const options = { startJobParameters };
const credential = new DefaultAzureCredential();
const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
const result = await client.streamingJobs.beginStartAndWait(resourceGroupName, jobName, options);
console.log(result);
}
startAStreamingJobWithLastOutputEventTimeOutputStartMode().catch(console.error);
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Definitions
Name |
Description |
Error
|
Common error representation.
|
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.
|
Error
Common error representation.
Name |
Type |
Description |
error
|
Error
|
Error definition properties.
|
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
|
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.
|