az stream-analytics output

Commands to manage stream-analytics output.

Commands

az stream-analytics output create

Create an output or replaces an already existing output under an existing streaming job.

az stream-analytics output delete

Delete an output from the streaming job.

az stream-analytics output list

List all of the outputs under the specified streaming job.

az stream-analytics output show

Get details about the specified output.

az stream-analytics output test

Test an output.

az stream-analytics output create

Create an output or replaces an already existing output under an existing streaming job.

az stream-analytics output create --datasource
                                  --job-name
                                  --name
                                  --resource-group
                                  [--serialization]

Examples

Create an output

az stream-analytics output create --resource-group MyResourceGroup --job-name MyJobName \
--name MyOutputName --datasource @datasource.json --serialization @serialization.json
 (below is an example of DataLake for "datasource.json")
 {
     "type": "Microsoft.DataLake/Accounts",
     "properties": {
         "accountName": "someaccount",
         "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd",
         "refreshToken": "someRefreshToken==",
         "tokenUserPrincipalName": "bobsmith@contoso.com",
         "tokenUserDisplayName": "Bob Smith",
         "filePathPrefix": "{date}/{time}",
         "dateFormat": "yyyy/MM/dd",
         "timeFormat": "HH"
     }
 }
 (below is an example of SQL Database for "datasource.json")
 {
     "type": "Microsoft.Sql/Server/Database",
     "properties": {
         "server": "someServer",
         "database": "someDatabase",
         "user": "someUser",
         "password": "somePassword",
         "table": "someTable"
     }
 }
 (below is an example of Table Storage for "datasource.json")
 {
     "type": "Microsoft.Storage/Table",
     "properties": {
         "accountName": "someAccountName",
         "accountKey": "accountKey==",
         "table": "samples",
         "partitionKey": "partitionKey",
         "rowKey": "rowKey",
         "columnsToRemove": [
             "column1",
             "column2"
         ],
         "batchSize": 25
     }
 }
 (below is an example of Blob Storage for "datasource.json")
 {
     "type": "Microsoft.Storage/Blob",
     "properties": {
         "storageAccounts": [
             {
                 "accountName": "someAccountName",
                 "accountKey": "accountKey=="
             }
         ],
         "container": "state",
         "pathPattern": "{date}/{time}",
         "dateFormat": "yyyy/MM/dd",
         "timeFormat": "HH"
     }
 }
 (below is an example of DocumentDB for "datasource.json")
 {
     "type": "Microsoft.Storage/DocumentDB",
     "properties": {
         "accountId": "someAccountId",
         "accountKey": "accountKey==",
         "database": "db01",
         "collectionNamePattern": "collection",
         "partitionKey": "key",
         "documentId": "documentId"
     }
 }
 (below is an example of Event Hub for "datasource.json")
 {
     "type": "Microsoft.ServiceBus/EventHub",
     "properties": {
         "serviceBusNamespace": "sdktest",
         "sharedAccessPolicyName": "RootManageSharedAccessKey",
         "sharedAccessPolicyKey": "sharedAccessPolicyKey=",
         "eventHubName": "sdkeventhub",
         "partitionKey": "partitionKey"
     }
 }
 (below is an example of PowerBI for "datasource.json")
 {
     "type": "PowerBI",
     "properties": {
         "dataset": "someDataset",
         "table": "someTable",
         "refreshToken": "someRefreshToken==",
         "tokenUserPrincipalName": "bobsmith@contoso.com",
         "tokenUserDisplayName": "Bob Smith",
         "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95",
         "groupName": "MyPowerBIGroup"
     }
 }
 (below is an example of Service Bus Queue for "datasource.json")
 {
     "type": "Microsoft.ServiceBus/Queue",
     "properties": {
         "serviceBusNamespace": "sdktest",
         "sharedAccessPolicyName": "RootManageSharedAccessKey",
         "sharedAccessPolicyKey": "sharedAccessPolicyKey=",
         "queueName": "sdkqueue",
         "propertyColumns": [
             "column1",
             "column2"
         ]
     }
 }
 (below is an example of Service Bus Topic for "datasource.json")
 {
     "type": "Microsoft.ServiceBus/Topic",
     "properties": {
         "serviceBusNamespace": "sdktest",
         "sharedAccessPolicyName": "RootManageSharedAccessKey",
         "sharedAccessPolicyKey": "sharedAccessPolicyKey=",
         "topicName": "sdktopic",
         "propertyColumns": [
             "column1",
             "column2"
         ]
     }
 }
 (below is an example of Csv for "serialization.json")
 {
     "type": "Csv",
     "properties": {
         "fieldDelimiter": ",",
         "encoding": "UTF8"
     }
 }
 (below is an example of Json for "serialization.json")
 {
     "type": "Json",
     "properties": {
         "encoding": "UTF8",
         "format": "Array"
     }
 }
 (below is an example of Avro for "serialization.json")
 {
     "type": "Avro"
 }

Required Parameters

--datasource

The datasource of the output.

--job-name

The name of the streaming job.

--name -n

The name of the output.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--serialization

The serialization of the output.

az stream-analytics output delete

Delete an output from the streaming job.

az stream-analytics output delete --job-name
                                  --name
                                  --resource-group

Examples

Delete an output

az stream-analytics output delete --resource-group MyResourceGroup --job-name MyJobName --name \
MyOutputName

Required Parameters

--job-name

The name of the streaming job.

--name -n

The name of the output.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az stream-analytics output list

List all of the outputs under the specified streaming job.

az stream-analytics output list --job-name
                                --resource-group

Examples

List all outputs in a streaming job

az stream-analytics output list --resource-group MyResourceGroup --job-name MyJobName

Required Parameters

--job-name

The name of the streaming job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az stream-analytics output show

Get details about the specified output.

az stream-analytics output show --job-name
                                --name
                                --resource-group

Examples

Get details about an output

az stream-analytics output show --resource-group MyResourceGroup --job-name MyJobName --name \
MyOutputName

Required Parameters

--job-name

The name of the streaming job.

--name -n

The name of the output.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az stream-analytics output test

Test an output.

az stream-analytics output test --job-name
                                --name
                                --resource-group
                                [--no-wait]

Examples

Test the connection for an output

az stream-analytics output test --resource-group MyResourceGroup --job-name MyJobName --name \
MyOutputName

Required Parameters

--job-name

The name of the streaming job.

--name -n

The name of the output.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.