Az.StreamAnalytics Module

The Az.StreamAnalytics module provides cmdlets for managing Azure Stream Analytics resources. This documentation covers the reference for commands within this module.

Get-AzStreamAnalyticsJob

Gets a Stream Analytics job.

Get-AzStreamAnalyticsJob
    [-ResourceGroupName <String>]
    [-Name <String>]
    [-SubscriptionId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [Toggle]

Parameters

Parameter Description Type Required
-ResourceGroupName The name of the resource group for the job. System.String No
-Name The name of the Stream Analytics job. System.String No
-SubscriptionId The ID of the subscription. System.String No
-DefaultProfile The default Azure context. Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer No

Example

# Get a specific Stream Analytics job
Get-AzStreamAnalyticsJob -ResourceGroupName "MyResourceGroup" -Name "MyStreamingJob"

# List all Stream Analytics jobs in a resource group
Get-AzStreamAnalyticsJob -ResourceGroupName "MyResourceGroup"

# List all Stream Analytics jobs in the subscription
Get-AzStreamAnalyticsJob

New-AzStreamAnalyticsJob

Creates a Stream Analytics job.

New-AzStreamAnalyticsJob
    -ResourceGroupName <String>
    -Name <String>
    -Location <String>
    [-SkuName <SkuName>]
    [-EventsOutOfOrderPolicy <EventsOutOfOrderPolicy>]
    [-OutputErrorPolicy <OutputErrorPolicy>]
    [-EventsLateArrivalMaxDelayInSecond <Int32>]
    [-CompatibilityLevel <Int32>]
    [-Tags <IDictionary>]
    [-SubscriptionId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [Toggle]

Parameters

Parameter Description Type Required
-ResourceGroupName The name of the resource group. System.String Yes
-Name The name of the Stream Analytics job. System.String Yes
-Location The Azure region for the job. System.String Yes
-SkuName The SKU name for the job. Microsoft.Azure.Commands.StreamAnalytics.Models.SkuName No
-EventsOutOfOrderPolicy Policy to handle out-of-order events. Microsoft.Azure.Commands.StreamAnalytics.Models.EventsOutOfOrderPolicy No
-OutputErrorPolicy Policy to handle output errors. Microsoft.Azure.Commands.StreamAnalytics.Models.OutputErrorPolicy No
-EventsLateArrivalMaxDelayInSecond Maximum delay in seconds for late arrivals. System.Int32 No
-CompatibilityLevel The compatibility level for the job. System.Int32 No
-Tags A hash table of tags to assign to the job. System.Collections.IDictionary No
-SubscriptionId The ID of the subscription. System.String No
-DefaultProfile The default Azure context. Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer No

Example

New-AzStreamAnalyticsJob -ResourceGroupName "MyResourceGroup" -Name "MyNewStreamingJob" -Location "West US" -SkuName "Standard" -EventsOutOfOrderPolicy "Adjust" -OutputErrorPolicy "Drop" -EventsLateArrivalMaxDelayInSecond 10 -CompatibilityLevel 1.2

Update-AzStreamAnalyticsJob

Updates an existing Stream Analytics job.

Update-AzStreamAnalyticsJob
    -ResourceGroupName <String>
    -Name <String>
    [-SkuName <SkuName>]
    [-EventsOutOfOrderPolicy <EventsOutOfOrderPolicy>]
    [-OutputErrorPolicy <OutputErrorPolicy>]
    [-EventsLateArrivalMaxDelayInSecond <Int32>]
    [-CompatibilityLevel <Int32>]
    [-Tags <IDictionary>]
    [-SubscriptionId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [Toggle]

Parameters

Parameter Description Type Required
-ResourceGroupName The name of the resource group. System.String Yes
-Name The name of the Stream Analytics job. System.String Yes
-SkuName The SKU name for the job. Microsoft.Azure.Commands.StreamAnalytics.Models.SkuName No
-EventsOutOfOrderPolicy Policy to handle out-of-order events. Microsoft.Azure.Commands.StreamAnalytics.Models.EventsOutOfOrderPolicy No
-OutputErrorPolicy Policy to handle output errors. Microsoft.Azure.Commands.StreamAnalytics.Models.OutputErrorPolicy No
-EventsLateArrivalMaxDelayInSecond Maximum delay in seconds for late arrivals. System.Int32 No
-CompatibilityLevel The compatibility level for the job. System.Int32 No
-Tags A hash table of tags to assign to the job. System.Collections.IDictionary No
-SubscriptionId The ID of the subscription. System.String No
-DefaultProfile The default Azure context. Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer No

Example

Update-AzStreamAnalyticsJob -ResourceGroupName "MyResourceGroup" -Name "MyStreamingJob" -EventsOutOfOrderPolicy "Pause"

Remove-AzStreamAnalyticsJob

Deletes a Stream Analytics job.

Remove-AzStreamAnalyticsJob
    -ResourceGroupName <String>
    -Name <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [Toggle]

Parameters

Parameter Description Type Required
-ResourceGroupName The name of the resource group. System.String Yes
-Name The name of the Stream Analytics job. System.String Yes
-SubscriptionId The ID of the subscription. System.String No
-DefaultProfile The default Azure context. Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer No

Example

Remove-AzStreamAnalyticsJob -ResourceGroupName "MyResourceGroup" -Name "MyStreamingJobToDelete"