Get-AzStreamAnalyticsJob

Reference

Module:: Az.StreamAnalytics

Gets details about the specified streaming job.

Syntax

Get-AzStreamAnalyticsJob
   [-SubscriptionId <String[]>]
   [-Expand <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStreamAnalyticsJob
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Expand <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStreamAnalyticsJob
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Expand <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzStreamAnalyticsJob
   -InputObject <IStreamAnalyticsIdentity>
   [-Expand <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Gets details about the specified streaming job.

Examples

Example 1: Get information about all jobs in a subscription

Get-AzStreamAnalyticsJob

Location        Name          Type                                    ETag
--------        ----          ----                                    ----
West Central US sajob-02-pwsh Microsoft.StreamAnalytics/streamingjobs
West Central US sajob-01-pwsh Microsoft.StreamAnalytics/streamingjobs

This command returns information about all the Stream Analytics jobs in the Azure subscription.

Example 2: Get information about all jobs in a resource group

Get-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test

Location        Name          Type                                    ETag
--------        ----          ----                                    ----
West Central US sajob-02-pwsh Microsoft.StreamAnalytics/streamingjobs
West Central US sajob-01-pwsh Microsoft.StreamAnalytics/streamingjobs

This command returns information about all the Stream Analytics jobs in the resource group.

Example 3: Get information about a specific job in a resource group

Get-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-02-pwsh

Location        Name          Type                                    ETag
--------        ----          ----                                    ----
West Central US sajob-02-pwsh Microsoft.StreamAnalytics/streamingjobs ac26a506-a4cb-4a7d-9ec8-c3149b8589bd

This command returns information about the Stream Analytics job StreamingJob in the resource group.

Example 4: Get information about a specific job in a resource group by pipeline

New-AzStreamAnalyticsJob -ResourceGroupName lucas-rg-test -Name sajob-02-pwsh -Location westcentralus -SkuName Standard | Get-AzStreamAnalyticsJob

Location        Name          Type                                    ETag
--------        ----          ----                                    ----
West Central US sajob-02-pwsh Microsoft.StreamAnalytics/streamingjobs ac26a506-a4cb-4a7d-9ec8-c3149b8589bd

This command returns information about the Stream Analytics job StreamingJob in the resource group.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

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

-Expand

The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'.

Type:	String
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

-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

Inputs

IStreamAnalyticsIdentity

Outputs

IStreamingJob

Share via