< Back

Start-AzureRmStreamAnalyticsJob

Sat Jan 11, 2020 10:44 am

NAME Start-AzureRmStreamAnalyticsJob



SYNOPSIS

Starts a Stream Analytics job.





SYNTAX

Start-AzureRmStreamAnalyticsJob [-ResourceGroupName] <String> [-Name] <String> [[-OutputStartMode] <String>]

[[-OutputStartTime] <DateTime>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]





DESCRIPTION

The Start-AzureRmStreamAnalyticsJob cmdlet asynchronously deploys and starts a Stream Analytics job in Azure.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the Azure Stream Analytics job to start.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OutputStartMode <String>

Specifies the start mode for the job. Valid values are:



- JobStartTime - This value indicates that the starting point of the output event stream should start when the

job is started.



- CustomTime - This value indicates that the starting point of the output event stream should start at a

custom time that is specified in the OutputStartTime parameter. -- LastOutputEventTime - This value

indicates that the starting point of the output event stream should start from the last event output time.



If the property is absent, the default is JobStartTime.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-OutputStartTime <DateTime>

Specifies the output start time. This 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.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the resource group to which the Azure Stream Analytics job belongs.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

System.Object







NOTES









EXAMPLE 1: Start a Stream Analytics job



PS C:\\>Start-AzureRmStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -Name "StreamingJob"

-OutputStartMode "CustomTime" -OutputStartTime "2014-07-03T01:00Z"



This command starts the job StreamingJob and specifies that the output event stream should start at timestamp

2014-07-03T01:00Z.







RELATED LINKS

Online Version:

https://docs.microsoft.com/en-us/powers ... alyticsjob

Get-AzureRmStreamAnalyticsJob

New-AzureRmStreamAnalyticsJob

Remove-AzureRmStreamAnalyticsJob

Stop-AzureRmStreamAnalyticsJob