Edit

Start-AzStreamAnalyticsJob

  • Reference
Module:
Az.StreamAnalytics

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

Syntax

Start-AzStreamAnalyticsJob
     -Name <String>
     -ResourceGroupName <String>
     [-SubscriptionId <String>]
     [-OutputStartMode <OutputStartMode>]
     [-OutputStartTime <DateTime>]
     [-DefaultProfile <PSObject>]
     [-AsJob]
     [-NoWait]
     [-PassThru]
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]
Start-AzStreamAnalyticsJob
     -InputObject <IStreamAnalyticsIdentity>
     [-OutputStartMode <OutputStartMode>]
     [-OutputStartTime <DateTime>]
     [-DefaultProfile <PSObject>]
     [-AsJob]
     [-NoWait]
     [-PassThru]
     [-Confirm]
     [-WhatIf]
     [<CommonParameters>]

Description

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

Examples

Example 1: Start a Stream Analytics job

Start-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-01-portal

This command starts the job StreamingJob.

Example 2: Start a Stream Analytics job by pipeline

Get-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-01-portal | Start-AzStreamAnalyticsJob

This command starts the job StreamingJob by pipeline.

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IStreamAnalyticsIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

The name of the streaming job.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:OutputStartMode
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutputStartTime

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.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The ID of the target subscription.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IStreamAnalyticsIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IStreamAnalyticsIdentity>: Identity Parameter

  • [ClusterName <String>]: The name of the cluster.
  • [FunctionName <String>]: The name of the function.
  • [Id <String>]: Resource identity path
  • [InputName <String>]: The name of the input.
  • [JobName <String>]: The name of the streaming job.
  • [Location <String>]: The region in which to retrieve the subscription's quota information. You can find out which regions Azure Stream Analytics is supported in here: https://azure.microsoft.com/en-us/regions/
  • [OutputName <String>]: The name of the output.
  • [ResourceGroupName <String>]: The name of the resource group. The name is case insensitive.
  • [SubscriptionId <String>]: The ID of the target subscription.
  • [TransformationName <String>]: The name of the transformation.