Edit

New-AzureRmStreamAnalyticsOutput

  • Reference
Module:
AzureRM.StreamAnalytics

Creates or updates outputs for a Stream Analytics job.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

New-AzureRmStreamAnalyticsOutput
   [-JobName] <String>
   [[-Name] <String>]
   [-File] <String>
   [-Force]
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzureRmStreamAnalyticsOutput cmdlet creates an output within a Stream Analytics job or updates an existing output. The name of the output can be specified in the .JSON file or on the command line. If both are specified, the name on command line must match the name in the file. If you specify an output that already exists and do not specify the Force parameter, the cmdlet will ask whether or not to replace the existing output. If you specify the Force parameter and specify an existing output name, the output will be replaced without confirmation.

Examples

EXAMPLE 1: Add an output to a job

PS C:\>New-AzureRmStreamAnalyticsOutput -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\Output.json" -JobName "StreamingJob" -Name "Output"

This command creates a new output called Output in the job called StreamingJob. If an existing output with this name is already defined, the cmdlet will ask whether or not to replace it.

EXAMPLE 2: Replace a job output definition

PS C:\>New-AzureRmStreamAnalyticsOutput -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\Output.json" -JobName "StreamingJob" -Name "Output" -Force

This command replaces the definition for Output in the job called StreamingJob without confirmation.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-DefaultProfile

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

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

-File

Specifies the path to a JSON file that contains the JSON representation of the Azure Stream Analytics output to create.

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

-Force

Forces the command to run without asking for user confirmation.

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

-JobName

Specifies the name of the Azure Stream Analytics job under which to create the Azure Stream Analytics output.

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

-Name

Specifies the name of the Azure Stream Analytics output to create.

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

-ResourceGroupName

Specifies the name of the resource group under which to create the Azure Stream Analytics output.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
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:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

PSOutput