你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Streaming Jobs - Create Or Replace

服务:: Stream Analytics

API 版本:: 2020-03-01

创建流式处理作业或替换现有的流式处理作业。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}?api-version=2020-03-01

URI 参数

名称	在	必需	类型	说明
jobName	path	True	string	流式处理作业的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求头

名称	必需	类型	说明
If-Match		string	流式处理作业的 ETag。省略此值以始终覆盖当前记录集。指定最后一次看到的 ETag 值，以防止意外覆盖并发更改。
If-None-Match		string	设置为“*”以允许创建新的流式处理作业，但为了防止更新现有记录集。其他值将导致 412 预条件失败响应。

请求正文

名称	类型	说明
identity	Identity	描述分配给此作业的系统分配的托管标识，该标识可用于通过输入和输出进行身份验证。
location	string	资源所在的地理位置
properties.cluster	ClusterInfo	将运行流式处理作业的群集。
properties.compatibilityLevel	CompatibilityLevel	控制流式处理作业的某些运行时行为。
properties.contentStoragePolicy	ContentStoragePolicy	有效值为 JobStorageAccount 和 SystemAccount。如果设置为 JobStorageAccount，则这要求用户也指定 jobStorageAccount 属性。 .
properties.dataLocale	string	流分析作业的数据区域设置。值应是集 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx中支持的 .NET 区域性的名称。如果未指定，则默认为“en-US”。
properties.eventsLateArrivalMaxDelayInSeconds	integer (int32)	可以包含到达延迟的事件的最大可容忍延迟（以秒为单位）。支持的范围 -1 为1814399（20.23：59：59 天），-1 用于无限期指定等待。如果该属性不存在，则解释为值为 -1。
properties.eventsOutOfOrderMaxDelayInSeconds	integer (int32)	可以调整无序事件以按顺序返回的最大可容忍延迟（以秒为单位）。
properties.eventsOutOfOrderPolicy	EventsOutOfOrderPolicy	指示要应用于输入事件流中无序到达的事件的策略。
properties.functions	Function[]	流式处理作业的一个或多个函数的列表。在 PUT 请求中指定此属性时，需要每个函数的名称属性。此属性不能通过 PATCH 操作进行修改。必须使用可用于单个转换的 PATCH API。
properties.inputs	Input[]	流式处理作业的一个或多个输入的列表。在 PUT 请求中指定此属性时，需要每个输入的名称属性。此属性不能通过 PATCH 操作进行修改。必须使用可用于单个输入的 PATCH API。
properties.jobStorageAccount	JobStorageAccount	与 MSI 的 Azure 存储帐户关联的属性
properties.jobType	JobType	描述作业的类型。有效模式 `Cloud` 和“Edge”。
properties.outputErrorPolicy	OutputErrorPolicy	指示要应用于到达输出的事件的策略，并且由于格式不正确（缺少列值、类型错误或大小的列值缺失）而无法写入外部存储。
properties.outputStartMode	OutputStartMode	仅当需要创建作业时立即启动该作业时，才应使用此属性。值可以是 JobStartTime、CustomTime 或 LastOutputEventTime，以指示在启动作业时，输出事件流的起始点是否应启动，从通过 outputStartTime 属性指定的自定义用户时间戳开始，还是从上一个事件输出时间开始。
properties.outputStartTime	string (date-time)	值是一个 ISO-8601 格式的时间戳，指示输出事件流的起始点，或为 null，以指示每当启动流式处理作业时输出事件流将启动。如果 outputStartMode 设置为 CustomTime，此属性必须具有值。
properties.outputs	Output[]	流式处理作业的一个或多个输出的列表。在 PUT 请求中指定此属性时，需要每个输出的名称属性。此属性不能通过 PATCH 操作进行修改。必须使用可用于单个输出的 PATCH API。
properties.sku	Sku	描述流式处理作业的 SKU。 PUT （CreateOrReplace）请求时是必需的。
properties.transformation	Transformation	指示要用于流式处理作业的查询和流单元数。在 PUT 请求中指定此属性时，需要转换的名称属性。此属性不能通过 PATCH 操作进行修改。必须使用可用于单个转换的 PATCH API。
tags	object	资源标记。

响应

名称	类型	说明
200 OK	StreamingJob	已成功创建或替换流式处理作业。标头 ETag: string
201 Created	StreamingJob	已成功创建或替换流式处理作业。标头 ETag: string
Other Status Codes	Error	错误。

名称

类型

说明

200 OK

StreamingJob

已成功创建或替换流式处理作业。

标头

ETag: string

201 Created

StreamingJob

已成功创建或替换流式处理作业。

标头

ETag: string

Other Status Codes

Error

错误。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)

Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)

Create a complete streaming job (a streaming job with a transformation, at least 1 input and at least 1 output)

示例请求

PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804?api-version=2020-03-01

{
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "yourAccountName",
                  "accountKey": "yourAccountKey=="
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          }
        },
        "name": "inputtest"
      }
    ],
    "transformation": {
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest"
      },
      "name": "transformationtest"
    },
    "outputs": [
      {
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "user": "<user>",
              "password": "userPassword",
              "table": "tableName"
            }
          }
        },
        "name": "outputtest"
      }
    ],
    "functions": []
  },
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  }
}


import com.azure.resourcemanager.streamanalytics.fluent.models.InputInner;
import com.azure.resourcemanager.streamanalytics.fluent.models.OutputInner;
import com.azure.resourcemanager.streamanalytics.fluent.models.TransformationInner;
import com.azure.resourcemanager.streamanalytics.models.AzureSqlDatabaseOutputDataSource;
import com.azure.resourcemanager.streamanalytics.models.BlobStreamInputDataSource;
import com.azure.resourcemanager.streamanalytics.models.CompatibilityLevel;
import com.azure.resourcemanager.streamanalytics.models.Encoding;
import com.azure.resourcemanager.streamanalytics.models.EventsOutOfOrderPolicy;
import com.azure.resourcemanager.streamanalytics.models.JsonSerialization;
import com.azure.resourcemanager.streamanalytics.models.OutputErrorPolicy;
import com.azure.resourcemanager.streamanalytics.models.Sku;
import com.azure.resourcemanager.streamanalytics.models.SkuName;
import com.azure.resourcemanager.streamanalytics.models.StorageAccount;
import com.azure.resourcemanager.streamanalytics.models.StreamInputProperties;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for StreamingJobs CreateOrReplace.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/
     * StreamingJob_Create_CompleteJob.json
     */
    /**
     * Sample code: Create a complete streaming job (a streaming job with a transformation, at least 1 input and at
     * least 1 output).
     * 
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void createACompleteStreamingJobAStreamingJobWithATransformationAtLeast1InputAndAtLeast1Output(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.streamingJobs().define("sj7804").withRegion("West US").withExistingResourceGroup("sjrg3276")
            .withTags(mapOf("key1", "fakeTokenPlaceholder", "key3", "fakeTokenPlaceholder", "randomKey",
                "fakeTokenPlaceholder"))
            .withSku(new Sku().withName(SkuName.STANDARD)).withEventsOutOfOrderPolicy(EventsOutOfOrderPolicy.DROP)
            .withOutputErrorPolicy(OutputErrorPolicy.DROP).withEventsOutOfOrderMaxDelayInSeconds(0)
            .withEventsLateArrivalMaxDelayInSeconds(5).withDataLocale(
                "en-US")
            .withCompatibilityLevel(CompatibilityLevel.ONE_ZERO)
            .withInputs(Arrays.asList(new InputInner().withProperties(new StreamInputProperties()
                .withSerialization(new JsonSerialization().withEncoding(Encoding.UTF8))
                .withDatasource(new BlobStreamInputDataSource()
                    .withStorageAccounts(Arrays.asList(
                        new StorageAccount().withAccountName("yourAccountName").withAccountKey("fakeTokenPlaceholder")))
                    .withContainer("containerName").withPathPattern("")))
                .withName("inputtest")))
            .withTransformation(new TransformationInner().withName("transformationtest").withStreamingUnits(1)
                .withQuery("Select Id, Name from inputtest"))
            .withOutputs(Arrays.asList(new OutputInner().withName("outputtest").withDatasource(
                new AzureSqlDatabaseOutputDataSource().withServer("serverName").withDatabase("databaseName")
                    .withUser("<user>").withPassword("fakeTokenPlaceholder").withTable("tableName"))))
            .withFunctions(Arrays.asList()).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_CompleteJob.json
func ExampleStreamingJobsClient_BeginCreateOrReplace_createACompleteStreamingJobAStreamingJobWithATransformationAtLeast1InputAndAtLeast1Output() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStreamingJobsClient().BeginCreateOrReplace(ctx, "sjrg3276", "sj7804", armstreamanalytics.StreamingJob{
		Location: to.Ptr("West US"),
		Tags: map[string]*string{
			"key1":      to.Ptr("value1"),
			"key3":      to.Ptr("value3"),
			"randomKey": to.Ptr("randomValue"),
		},
		Properties: &armstreamanalytics.StreamingJobProperties{
			CompatibilityLevel:                 to.Ptr(armstreamanalytics.CompatibilityLevelOne0),
			DataLocale:                         to.Ptr("en-US"),
			EventsLateArrivalMaxDelayInSeconds: to.Ptr[int32](5),
			EventsOutOfOrderMaxDelayInSeconds:  to.Ptr[int32](0),
			EventsOutOfOrderPolicy:             to.Ptr(armstreamanalytics.EventsOutOfOrderPolicyDrop),
			Functions:                          []*armstreamanalytics.Function{},
			Inputs: []*armstreamanalytics.Input{
				{
					Name: to.Ptr("inputtest"),
					Properties: &armstreamanalytics.StreamInputProperties{
						Type: to.Ptr("Stream"),
						Serialization: &armstreamanalytics.JSONSerialization{
							Type: to.Ptr(armstreamanalytics.EventSerializationTypeJSON),
							Properties: &armstreamanalytics.JSONSerializationProperties{
								Encoding: to.Ptr(armstreamanalytics.EncodingUTF8),
							},
						},
						Datasource: &armstreamanalytics.BlobStreamInputDataSource{
							Type: to.Ptr("Microsoft.Storage/Blob"),
							Properties: &armstreamanalytics.BlobStreamInputDataSourceProperties{
								Container:   to.Ptr("containerName"),
								PathPattern: to.Ptr(""),
								StorageAccounts: []*armstreamanalytics.StorageAccount{
									{
										AccountKey:  to.Ptr("yourAccountKey=="),
										AccountName: to.Ptr("yourAccountName"),
									}},
							},
						},
					},
				}},
			OutputErrorPolicy: to.Ptr(armstreamanalytics.OutputErrorPolicyDrop),
			Outputs: []*armstreamanalytics.Output{
				{
					Name: to.Ptr("outputtest"),
					Properties: &armstreamanalytics.OutputProperties{
						Datasource: &armstreamanalytics.AzureSQLDatabaseOutputDataSource{
							Type: to.Ptr("Microsoft.Sql/Server/Database"),
							Properties: &armstreamanalytics.AzureSQLDatabaseOutputDataSourceProperties{
								Database: to.Ptr("databaseName"),
								Password: to.Ptr("userPassword"),
								Server:   to.Ptr("serverName"),
								Table:    to.Ptr("tableName"),
								User:     to.Ptr("<user>"),
							},
						},
					},
				}},
			SKU: &armstreamanalytics.SKU{
				Name: to.Ptr(armstreamanalytics.SKUNameStandard),
			},
			Transformation: &armstreamanalytics.Transformation{
				Name: to.Ptr("transformationtest"),
				Properties: &armstreamanalytics.TransformationProperties{
					Query:          to.Ptr("Select Id, Name from inputtest"),
					StreamingUnits: to.Ptr[int32](1),
				},
			},
		},
	}, &armstreamanalytics.StreamingJobsClientBeginCreateOrReplaceOptions{IfMatch: nil,
		IfNoneMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StreamingJob = armstreamanalytics.StreamingJob{
	// 	Name: to.Ptr("sj7804"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs"),
	// 	ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key3": to.Ptr("value3"),
	// 		"randomKey": to.Ptr("randomValue"),
	// 	},
	// 	Properties: &armstreamanalytics.StreamingJobProperties{
	// 		CompatibilityLevel: to.Ptr(armstreamanalytics.CompatibilityLevelOne0),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-11T04:37:11.540Z"); return t}()),
	// 		DataLocale: to.Ptr("en-US"),
	// 		EventsLateArrivalMaxDelayInSeconds: to.Ptr[int32](5),
	// 		EventsOutOfOrderMaxDelayInSeconds: to.Ptr[int32](0),
	// 		EventsOutOfOrderPolicy: to.Ptr(armstreamanalytics.EventsOutOfOrderPolicyDrop),
	// 		Functions: []*armstreamanalytics.Function{
	// 		},
	// 		Inputs: []*armstreamanalytics.Input{
	// 			{
	// 				Name: to.Ptr("inputtest"),
	// 				Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/inputs"),
	// 				ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest"),
	// 				Properties: &armstreamanalytics.StreamInputProperties{
	// 					Type: to.Ptr("Stream"),
	// 					Etag: to.Ptr("ca88f8fa-605b-4c7f-8695-46f5faa60cd0"),
	// 					Serialization: &armstreamanalytics.JSONSerialization{
	// 						Type: to.Ptr(armstreamanalytics.EventSerializationTypeJSON),
	// 						Properties: &armstreamanalytics.JSONSerializationProperties{
	// 							Encoding: to.Ptr(armstreamanalytics.EncodingUTF8),
	// 						},
	// 					},
	// 					Datasource: &armstreamanalytics.BlobStreamInputDataSource{
	// 						Type: to.Ptr("Microsoft.Storage/Blob"),
	// 						Properties: &armstreamanalytics.BlobStreamInputDataSourceProperties{
	// 							Container: to.Ptr("containerName"),
	// 							PathPattern: to.Ptr(""),
	// 							StorageAccounts: []*armstreamanalytics.StorageAccount{
	// 								{
	// 									AccountName: to.Ptr("accountName"),
	// 							}},
	// 						},
	// 					},
	// 				},
	// 		}},
	// 		JobID: to.Ptr("732e4b1d-94a7-43ae-8297-3ad04f1540b9"),
	// 		JobState: to.Ptr("Created"),
	// 		OutputErrorPolicy: to.Ptr(armstreamanalytics.OutputErrorPolicyDrop),
	// 		Outputs: []*armstreamanalytics.Output{
	// 			{
	// 				Name: to.Ptr("outputtest"),
	// 				Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/outputs"),
	// 				ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest"),
	// 				Properties: &armstreamanalytics.OutputProperties{
	// 					Datasource: &armstreamanalytics.AzureSQLDatabaseOutputDataSource{
	// 						Type: to.Ptr("Microsoft.Sql/Server/Database"),
	// 						Properties: &armstreamanalytics.AzureSQLDatabaseOutputDataSourceProperties{
	// 							Database: to.Ptr("databaseName"),
	// 							Server: to.Ptr("serverName"),
	// 							Table: to.Ptr("tableName"),
	// 							User: to.Ptr("userName"),
	// 						},
	// 					},
	// 					Etag: to.Ptr("62097c3c-b503-41ff-a56f-196a9598ab90"),
	// 				},
	// 		}},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SKU: &armstreamanalytics.SKU{
	// 			Name: to.Ptr(armstreamanalytics.SKUNameStandard),
	// 		},
	// 		Transformation: &armstreamanalytics.Transformation{
	// 			Name: to.Ptr("transformationtest"),
	// 			Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs/transformations"),
	// 			ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest"),
	// 			Properties: &armstreamanalytics.TransformationProperties{
	// 				Etag: to.Ptr("91d8fcbe-60b3-49c3-9f21-9942b95602b8"),
	// 				Query: to.Ptr("Select Id, Name from inputtest"),
	// 				StreamingUnits: to.Ptr[int32](1),
	// 			},
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a streaming job or replaces an already existing streaming job.
 *
 * @summary Creates a streaming job or replaces an already existing streaming job.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_CompleteJob.json
 */
async function createACompleteStreamingJobAStreamingJobWithATransformationAtLeast1InputAndAtLeast1Output() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg3276";
  const jobName = "sj7804";
  const streamingJob = {
    compatibilityLevel: "1.0",
    dataLocale: "en-US",
    eventsLateArrivalMaxDelayInSeconds: 5,
    eventsOutOfOrderMaxDelayInSeconds: 0,
    eventsOutOfOrderPolicy: "Drop",
    functions: [],
    inputs: [
      {
        name: "inputtest",
        properties: {
          type: "Stream",
          datasource: {
            type: "Microsoft.Storage/Blob",
            container: "containerName",
            pathPattern: "",
            storageAccounts: [{ accountKey: "yourAccountKey==", accountName: "yourAccountName" }],
          },
          serialization: { type: "Json", encoding: "UTF8" },
        },
      },
    ],
    location: "West US",
    outputErrorPolicy: "Drop",
    outputs: [
      {
        name: "outputtest",
        datasource: {
          type: "Microsoft.Sql/Server/Database",
          database: "databaseName",
          password: "userPassword",
          server: "serverName",
          table: "tableName",
          user: "<user>",
        },
      },
    ],
    sku: { name: "Standard" },
    tags: { key1: "value1", key3: "value3", randomKey: "randomValue" },
    transformation: {
      name: "transformationtest",
      query: "Select Id, Name from inputtest",
      streamingUnits: 1,
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.streamingJobs.beginCreateOrReplaceAndWait(
    resourceGroupName,
    jobName,
    streamingJob
  );
  console.log(result);
}

createACompleteStreamingJobAStreamingJobWithATransformationAtLeast1InputAndAtLeast1Output().catch(
  console.error
);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 201

ETag: 87551cc5-1290-4d08-afcd-cdaa92e5ade0

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804",
  "name": "sj7804",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:11.54Z",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
        "name": "inputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "accountName"
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          },
          "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
        }
      }
    ],
    "transformation": {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest",
      "name": "transformationtest",
      "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest",
        "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8"
      }
    },
    "functions": [],
    "outputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest",
        "name": "outputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "table": "tableName",
              "user": "userName"
            }
          },
          "etag": "62097c3c-b503-41ff-a56f-196a9598ab90"
        }
      }
    ]
  }
}

状态代码:: 200

ETag: 87551cc5-1290-4d08-afcd-cdaa92e5ade0

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804",
  "name": "sj7804",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "732e4b1d-94a7-43ae-8297-3ad04f1540b9",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 0,
    "eventsLateArrivalMaxDelayInSeconds": 5,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:11.54Z",
    "compatibilityLevel": "1.0",
    "inputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/inputs/inputtest",
        "name": "inputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/inputs",
        "properties": {
          "type": "Stream",
          "datasource": {
            "type": "Microsoft.Storage/Blob",
            "properties": {
              "storageAccounts": [
                {
                  "accountName": "accountName"
                }
              ],
              "container": "containerName",
              "pathPattern": ""
            }
          },
          "serialization": {
            "type": "Json",
            "properties": {
              "encoding": "UTF8"
            }
          },
          "etag": "ca88f8fa-605b-4c7f-8695-46f5faa60cd0"
        }
      }
    ],
    "transformation": {
      "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/transformations/transformationtest",
      "name": "transformationtest",
      "type": "Microsoft.StreamAnalytics/streamingjobs/transformations",
      "properties": {
        "streamingUnits": 1,
        "query": "Select Id, Name from inputtest",
        "etag": "91d8fcbe-60b3-49c3-9f21-9942b95602b8"
      }
    },
    "functions": [],
    "outputs": [
      {
        "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3276/providers/Microsoft.StreamAnalytics/streamingjobs/sj7804/outputs/outputtest",
        "name": "outputtest",
        "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
        "properties": {
          "datasource": {
            "type": "Microsoft.Sql/Server/Database",
            "properties": {
              "server": "serverName",
              "database": "databaseName",
              "table": "tableName",
              "user": "userName"
            }
          },
          "etag": "62097c3c-b503-41ff-a56f-196a9598ab90"
        }
      }
    ]
  }
}

Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or functions)

示例请求

PUT https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59?api-version=2020-03-01

{
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "compatibilityLevel": "1.0",
    "inputs": [],
    "outputs": [],
    "functions": []
  },
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  }
}


import com.azure.resourcemanager.streamanalytics.models.CompatibilityLevel;
import com.azure.resourcemanager.streamanalytics.models.EventsOutOfOrderPolicy;
import com.azure.resourcemanager.streamanalytics.models.OutputErrorPolicy;
import com.azure.resourcemanager.streamanalytics.models.Sku;
import com.azure.resourcemanager.streamanalytics.models.SkuName;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for StreamingJobs CreateOrReplace.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/
     * StreamingJob_Create_JobShell.json
     */
    /**
     * Sample code: Create a streaming job shell (a streaming job with no inputs, outputs, transformation, or
     * functions).
     * 
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void createAStreamingJobShellAStreamingJobWithNoInputsOutputsTransformationOrFunctions(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.streamingJobs().define("sj59").withRegion("West US").withExistingResourceGroup("sjrg6936")
            .withTags(mapOf("key1", "fakeTokenPlaceholder", "key3", "fakeTokenPlaceholder", "randomKey",
                "fakeTokenPlaceholder"))
            .withSku(new Sku().withName(SkuName.STANDARD)).withEventsOutOfOrderPolicy(EventsOutOfOrderPolicy.DROP)
            .withOutputErrorPolicy(OutputErrorPolicy.DROP).withEventsOutOfOrderMaxDelayInSeconds(5)
            .withEventsLateArrivalMaxDelayInSeconds(16).withDataLocale("en-US")
            .withCompatibilityLevel(CompatibilityLevel.ONE_ZERO).withInputs(Arrays.asList())
            .withOutputs(Arrays.asList()).withFunctions(Arrays.asList()).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_JobShell.json
func ExampleStreamingJobsClient_BeginCreateOrReplace_createAStreamingJobShellAStreamingJobWithNoInputsOutputsTransformationOrFunctions() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewStreamingJobsClient().BeginCreateOrReplace(ctx, "sjrg6936", "sj59", armstreamanalytics.StreamingJob{
		Location: to.Ptr("West US"),
		Tags: map[string]*string{
			"key1":      to.Ptr("value1"),
			"key3":      to.Ptr("value3"),
			"randomKey": to.Ptr("randomValue"),
		},
		Properties: &armstreamanalytics.StreamingJobProperties{
			CompatibilityLevel:                 to.Ptr(armstreamanalytics.CompatibilityLevelOne0),
			DataLocale:                         to.Ptr("en-US"),
			EventsLateArrivalMaxDelayInSeconds: to.Ptr[int32](16),
			EventsOutOfOrderMaxDelayInSeconds:  to.Ptr[int32](5),
			EventsOutOfOrderPolicy:             to.Ptr(armstreamanalytics.EventsOutOfOrderPolicyDrop),
			Functions:                          []*armstreamanalytics.Function{},
			Inputs:                             []*armstreamanalytics.Input{},
			OutputErrorPolicy:                  to.Ptr(armstreamanalytics.OutputErrorPolicyDrop),
			Outputs:                            []*armstreamanalytics.Output{},
			SKU: &armstreamanalytics.SKU{
				Name: to.Ptr(armstreamanalytics.SKUNameStandard),
			},
		},
	}, &armstreamanalytics.StreamingJobsClientBeginCreateOrReplaceOptions{IfMatch: nil,
		IfNoneMatch: nil,
	})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.StreamingJob = armstreamanalytics.StreamingJob{
	// 	Name: to.Ptr("sj59"),
	// 	Type: to.Ptr("Microsoft.StreamAnalytics/streamingjobs"),
	// 	ID: to.Ptr("/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59"),
	// 	Location: to.Ptr("West US"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("value1"),
	// 		"key3": to.Ptr("value3"),
	// 		"randomKey": to.Ptr("randomValue"),
	// 	},
	// 	Properties: &armstreamanalytics.StreamingJobProperties{
	// 		CompatibilityLevel: to.Ptr(armstreamanalytics.CompatibilityLevelOne0),
	// 		CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-11T04:37:04.697Z"); return t}()),
	// 		DataLocale: to.Ptr("en-US"),
	// 		EventsLateArrivalMaxDelayInSeconds: to.Ptr[int32](16),
	// 		EventsOutOfOrderMaxDelayInSeconds: to.Ptr[int32](5),
	// 		EventsOutOfOrderPolicy: to.Ptr(armstreamanalytics.EventsOutOfOrderPolicyDrop),
	// 		Functions: []*armstreamanalytics.Function{
	// 		},
	// 		Inputs: []*armstreamanalytics.Input{
	// 		},
	// 		JobID: to.Ptr("d53ecc3c-fcb0-485d-9caf-25e20fcb2061"),
	// 		JobState: to.Ptr("Created"),
	// 		OutputErrorPolicy: to.Ptr(armstreamanalytics.OutputErrorPolicyDrop),
	// 		Outputs: []*armstreamanalytics.Output{
	// 		},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SKU: &armstreamanalytics.SKU{
	// 			Name: to.Ptr(armstreamanalytics.SKUNameStandard),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StreamAnalyticsManagementClient } = require("@azure/arm-streamanalytics");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates a streaming job or replaces an already existing streaming job.
 *
 * @summary Creates a streaming job or replaces an already existing streaming job.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/StreamingJob_Create_JobShell.json
 */
async function createAStreamingJobShellAStreamingJobWithNoInputsOutputsTransformationOrFunctions() {
  const subscriptionId = "56b5e0a9-b645-407d-99b0-c64f86013e3d";
  const resourceGroupName = "sjrg6936";
  const jobName = "sj59";
  const streamingJob = {
    compatibilityLevel: "1.0",
    dataLocale: "en-US",
    eventsLateArrivalMaxDelayInSeconds: 16,
    eventsOutOfOrderMaxDelayInSeconds: 5,
    eventsOutOfOrderPolicy: "Drop",
    functions: [],
    inputs: [],
    location: "West US",
    outputErrorPolicy: "Drop",
    outputs: [],
    sku: { name: "Standard" },
    tags: { key1: "value1", key3: "value3", randomKey: "randomValue" },
  };
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const result = await client.streamingJobs.beginCreateOrReplaceAndWait(
    resourceGroupName,
    jobName,
    streamingJob
  );
  console.log(result);
}

createAStreamingJobShellAStreamingJobWithNoInputsOutputsTransformationOrFunctions().catch(
  console.error
);

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 201

ETag: 3e6872bc-c9d0-45b6-91b6-da66f1773056

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59",
  "name": "sj59",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:04.697Z",
    "compatibilityLevel": "1.0",
    "inputs": [],
    "functions": [],
    "outputs": []
  }
}

状态代码:: 200

ETag: 3e6872bc-c9d0-45b6-91b6-da66f1773056

{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6936/providers/Microsoft.StreamAnalytics/streamingjobs/sj59",
  "name": "sj59",
  "type": "Microsoft.StreamAnalytics/streamingjobs",
  "location": "West US",
  "tags": {
    "key1": "value1",
    "randomKey": "randomValue",
    "key3": "value3"
  },
  "properties": {
    "sku": {
      "name": "Standard"
    },
    "jobId": "d53ecc3c-fcb0-485d-9caf-25e20fcb2061",
    "provisioningState": "Succeeded",
    "jobState": "Created",
    "eventsOutOfOrderPolicy": "Drop",
    "outputErrorPolicy": "Drop",
    "eventsOutOfOrderMaxDelayInSeconds": 5,
    "eventsLateArrivalMaxDelayInSeconds": 16,
    "dataLocale": "en-US",
    "createdDate": "2017-05-11T04:37:04.697Z",
    "compatibilityLevel": "1.0",
    "inputs": [],
    "functions": [],
    "outputs": []
  }
}

定义

名称	说明
AggregateFunctionProperties	与聚合函数关联的属性。
AuthenticationMode	身份验证模式。有效模式 `ConnectionString`、`Msi` 和“UserToken”。
AvroSerialization	描述如何序列化来自输入的数据，或者当以 Avro 格式写入输出时如何序列化数据。
AzureDataLakeStoreOutputDataSource	介绍 Azure Data Lake Store 输出数据源。
AzureFunctionOutputDataSource	定义 AzureFunctionOutputDataSource 的元数据
AzureMachineLearningWebServiceFunctionBinding	绑定到 Azure 机器学习 Web 服务。
AzureMachineLearningWebServiceInputColumn	描述 Azure 机器学习 Web 服务终结点的输入列。
AzureMachineLearningWebServiceInputs	Azure 机器学习 Web 服务终结点的输入。
AzureMachineLearningWebServiceOutputColumn	描述 Azure 机器学习 Web 服务终结点的输出列。
AzureSqlDatabaseOutputDataSource	介绍 Azure SQL 数据库输出数据源。
AzureSqlReferenceInputDataSource	介绍 Azure SQL 数据库引用输入数据源。
AzureSynapseOutputDataSource	介绍 Azure Synapse 输出数据源。
AzureTableOutputDataSource	描述 Azure 表输出数据源。
BlobOutputDataSource	描述 Blob 输出数据源。
BlobReferenceInputDataSource	描述包含引用数据的 Blob 输入数据源。
BlobStreamInputDataSource	描述包含流数据的 Blob 输入数据源。
ClusterInfo	与流分析群集关联的属性。
CompatibilityLevel	控制流式处理作业的某些运行时行为。
Compression	描述如何压缩输入数据
CompressionType	指示输入使用的压缩类型。 PUT （CreateOrReplace）请求时是必需的。
ContentStoragePolicy	有效值为 JobStorageAccount 和 SystemAccount。如果设置为 JobStorageAccount，则这要求用户也指定 jobStorageAccount 属性。 .
CsvSerialization	描述如何序列化输入中的数据，或者将数据写入 CSV 格式时如何序列化数据。
DiagnosticCondition	适用于资源或整体作业的条件，值得客户注意。
Diagnostics	描述适用于整体输入、输出或作业的条件，这些条件值得客户注意。
DocumentDbOutputDataSource	描述 DocumentDB 输出数据源。
Encoding	指定传入数据的编码（在输入的情况下）和输出时传出数据的编码。
Error	常见的错误表示形式。
EventHubOutputDataSource	描述事件中心输出数据源。
EventHubStreamInputDataSource	描述包含流数据的事件中心输入数据源。
EventHubV2OutputDataSource	描述事件中心输出数据源。
EventHubV2StreamInputDataSource	描述包含流数据的事件中心输入数据源。
EventSerializationType	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。
EventsOutOfOrderPolicy	指示要应用于输入事件流中无序到达的事件的策略。
FileReferenceInputDataSource	描述包含引用数据的文件输入数据源。
Function	一个函数对象，包含与命名函数关联的所有信息。所有函数都包含在流式处理作业下。
FunctionInput	描述函数的一个输入参数。
FunctionOutput	描述函数的输出。
GatewayMessageBusOutputDataSource	描述网关消息总线输出数据源。
GatewayMessageBusStreamInputDataSource	描述包含流数据的 Blob 输入数据源。
Identity	描述如何验证标识
Input	一个输入对象，包含与命名输入关联的所有信息。所有输入都包含在流式处理作业下。
IoTHubStreamInputDataSource	描述包含流数据的 IoT 中心输入数据源。
JavaScriptFunctionBinding	绑定到 JavaScript 函数。
JobStorageAccount	与 MSI 的 Azure 存储帐户关联的属性
JobType	描述作业的类型。有效模式 `Cloud` 和“Edge”。
JsonOutputSerializationFormat	指定输出将写入的 JSON 的格式。当前支持的值是“lineSeparated”，指示输出将设置格式，方法是让每个 JSON 对象用新行分隔，“array”指示输出将格式化为 JSON 对象的数组。
JsonSerialization	描述如何序列化输入中的数据，或者以 JSON 格式写入输出时如何序列化数据。
Output	一个输出对象，包含与命名输出关联的所有信息。所有输出都包含在流式处理作业下。
OutputErrorPolicy	指示要应用于到达输出的事件的策略，并且由于格式不正确（缺少列值、类型错误或大小的列值缺失）而无法写入外部存储。
OutputStartMode	值可以是 JobStartTime、CustomTime 或 LastOutputEventTime，以指示在启动作业时，输出事件流的起始点是否应启动，从通过 outputStartTime 属性指定的自定义用户时间戳开始，还是从上一个事件输出时间开始。
ParquetSerialization	描述如何序列化输入中的数据，或者当以 Parquet 格式写入输出时如何序列化数据。
PowerBIOutputDataSource	介绍 Power BI 输出数据源。
ReferenceInputProperties	与包含引用数据的输入关联的属性。
RefreshType	指示数据刷新选项的类型。
ScalarFunctionProperties	与标量函数关联的属性。
ServiceBusQueueOutputDataSource	描述服务总线队列输出数据源。
ServiceBusTopicOutputDataSource	描述服务总线主题输出数据源。
Sku	与 SKU 关联的属性。
SkuName	SKU 的名称。 PUT （CreateOrReplace）请求时是必需的。
StorageAccount	与 Azure 存储帐户关联的属性
StreamingJob	流式处理作业对象，包含与命名流式处理作业关联的所有信息。
StreamInputProperties	与包含流数据的输入关联的属性。
Transformation	转换对象，包含与命名转换关联的所有信息。所有转换都包含在流式处理作业下。

AggregateFunctionProperties

Object

与聚合函数关联的属性。

名称	类型	说明
etag	string	函数的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
properties.binding	FunctionBinding: AzureMachineLearningWebServiceFunctionBinding JavaScriptFunctionBinding	函数的物理绑定。例如，在 Azure 机器学习 Web 服务的情况下，这描述了终结点。
properties.inputs	FunctionInput[]	描述函数的一个输入参数。
properties.output	FunctionOutput	描述函数的输出。
type	string: Aggregate	指示函数的类型。

AuthenticationMode

枚举

身份验证模式。有效模式 ConnectionString、Msi 和“UserToken”。

值	说明
Msi
UserToken
ConnectionString

AvroSerialization

Object

描述如何序列化来自输入的数据，或者当以 Avro 格式写入输出时如何序列化数据。

名称	类型	说明
type	string: Avro	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

AzureDataLakeStoreOutputDataSource

Object

介绍 Azure Data Lake Store 输出数据源。

名称	类型	默认值	说明
properties.accountName	string		Azure Data Lake Store 帐户的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.dateFormat	string		日期格式。无论 {date} 出现在 filePathPrefix 中，此属性的值将改为用作日期格式。
properties.filePathPrefix	string		输出应写入到的文件的位置。 PUT （CreateOrReplace）请求时是必需的。
properties.refreshToken	string		一个刷新令牌，可用于获取有效的访问令牌，然后可用于向数据源进行身份验证。当前只能通过 Azure 门户获取有效的刷新令牌。建议在创建数据源时在此处放置虚拟字符串值，然后转到 Azure 门户对数据源进行身份验证，该数据源将使用有效的刷新令牌更新此属性。 PUT （CreateOrReplace）请求时是必需的。
properties.tenantId	string		用于获取刷新令牌的用户的租户 ID。 PUT （CreateOrReplace）请求时是必需的。
properties.timeFormat	string		时间格式。无论 {time} 出现在 filePathPrefix 中，此属性的值将改为用作时间格式。
properties.tokenUserDisplayName	string		用于获取刷新令牌的用户的用户显示名称。使用此属性有助于记住哪些用户用于获取刷新令牌。
properties.tokenUserPrincipalName	string		用于获取刷新令牌的用户的用户主体名称（UPN）。使用此属性有助于记住哪些用户用于获取刷新令牌。
type	string: Microsoft.DataLake/Accounts		指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

AzureFunctionOutputDataSource

Object

定义 AzureFunctionOutputDataSource 的元数据

名称	类型	说明
properties.apiKey	string	如果想要从另一个订阅使用 Azure 函数，可以通过提供用于访问函数的密钥来执行此操作。
properties.functionAppName	string	Azure Functions 应用的名称。
properties.functionName	string	Azure Functions 应用中函数的名称。
properties.maxBatchCount	number	一个属性，可用于指定发送到 Azure Functions 的每个批处理中的最大事件数。默认值为 100。
properties.maxBatchSize	number	一个属性，可用于设置发送到 Azure 函数的每个输出批处理的最大大小。输入单位为字节。默认情况下，此值为 262,144 字节（256 KB）。
type	string: Microsoft.AzureFunction	指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

AzureMachineLearningWebServiceFunctionBinding

Object

绑定到 Azure 机器学习 Web 服务。

名称	类型	说明
properties.apiKey	string	用于对 Request-Response 终结点进行身份验证的 API 密钥。
properties.batchSize	integer (int32)	描述每个 Azure ML RRS 执行请求的最大行数的 1 到 10000 之间的数字。默认值为 1000。
properties.endpoint	string	Request-Response Azure 机器学习 Web 服务的执行终结点。在此处了解详细信息：https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs
properties.inputs	AzureMachineLearningWebServiceInputs	Azure 机器学习 Web 服务终结点的输入。
properties.outputs	AzureMachineLearningWebServiceOutputColumn[]	Azure 机器学习 Web 服务终结点执行的输出列表。
type	string: Microsoft.MachineLearning/WebService	指示函数绑定类型。

AzureMachineLearningWebServiceInputColumn

Object

描述 Azure 机器学习 Web 服务终结点的输入列。

名称	类型	说明
dataType	string	输入列的（Azure 机器学习支持）数据类型。 https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx 介绍了有效的 Azure 机器学习数据类型的列表。
mapTo	integer (int32)	此输入映射到的函数参数的从零开始的索引。
name	string	输入列的名称。

AzureMachineLearningWebServiceInputs

Object

Azure 机器学习 Web 服务终结点的输入。

名称	类型	说明
columnNames	AzureMachineLearningWebServiceInputColumn[]	Azure 机器学习 Web 服务终结点的输入列列表。
name	string	输入的名称。这是创作终结点时提供的名称。

AzureMachineLearningWebServiceOutputColumn

Object

描述 Azure 机器学习 Web 服务终结点的输出列。

名称	类型	说明
dataType	string	输出列的（Azure 机器学习支持的）数据类型。 https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx 介绍了有效的 Azure 机器学习数据类型的列表。
name	string	输出列的名称。

AzureSqlDatabaseOutputDataSource

Object

介绍 Azure SQL 数据库输出数据源。

名称	类型	默认值	说明
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.database	string		Azure SQL 数据库的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.maxBatchCount	number		写入 Sql 数据库的最大 Batch 计数，默认值为 10,000。 PUT 请求可选。
properties.maxWriterCount	number		最大编写器计数，目前仅提供 1（单个编写器）和 0（基于查询分区）。 PUT 请求可选。
properties.password	string		将用于连接到 Azure SQL 数据库的密码。 PUT （CreateOrReplace）请求时是必需的。
properties.server	string		包含 Azure SQL 数据库的 SQL Server 的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.table	string		Azure SQL 数据库中表的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.user	string		将用于连接到 Azure SQL 数据库的用户名。 PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.Sql/Server/Database		指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

AzureSqlReferenceInputDataSource

Object

介绍 Azure SQL 数据库引用输入数据源。

名称	类型	说明
properties.database	string	此元素与数据源元素相关联。这是输出将写入到的数据库的名称。
properties.deltaSnapshotQuery	string	此元素与数据源元素相关联。此查询用于从 SQL 数据库提取增量更改。若要使用此选项，建议在 Azure SQL 数据库中使用临时表。
properties.fullSnapshotQuery	string	此元素与数据源元素相关联。此查询用于从 sql 数据库提取数据。
properties.password	string	此元素与数据源元素相关联。这是用于连接到 SQL 数据库实例的密码。
properties.refreshRate	string	此元素与数据源元素相关联。这表示从数据库提取数据的频率。它采用 DateTime 格式。
properties.refreshType	RefreshType	指示数据刷新选项的类型。
properties.server	string	此元素与数据源元素相关联。这是包含要写入的数据库的服务器的名称。
properties.table	string	此元素与数据源元素相关联。 Azure SQL 数据库中表的名称。
properties.user	string	此元素与数据源元素相关联。这是用于连接到 SQL 数据库实例的用户名。
type	string: Microsoft.Sql/Server/Database	指示包含引用数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

AzureSynapseOutputDataSource

Object

介绍 Azure Synapse 输出数据源。

名称	类型	说明
properties.database	string	Azure SQL 数据库的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.password	string	将用于连接到 Azure SQL 数据库的密码。 PUT （CreateOrReplace）请求时是必需的。
properties.server	string	包含 Azure SQL 数据库的 SQL Server 的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.table	string	Azure SQL 数据库中表的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.user	string	将用于连接到 Azure SQL 数据库的用户名。 PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.Sql/Server/DataWarehouse	指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

AzureTableOutputDataSource

Object

描述 Azure 表输出数据源。

名称	类型	说明
properties.accountKey	string	Azure 存储帐户的帐户密钥。 PUT （CreateOrReplace）请求时是必需的。
properties.accountName	string	Azure 存储帐户的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.batchSize	integer (int32)	一次写入 Azure 表的行数。
properties.columnsToRemove	string[]	如果指定，则数组中的每个项都是要从输出事件实体中删除的列的名称（如果存在）。
properties.partitionKey	string	此元素指示查询中 SELECT 语句中列的名称，该列将用作 Azure 表的分区键。 PUT （CreateOrReplace）请求时是必需的。
properties.rowKey	string	此元素指示查询中 SELECT 语句中的列的名称，该列将用作 Azure 表的行键。 PUT （CreateOrReplace）请求时是必需的。
properties.table	string	Azure 表的名称。 PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.Storage/Table	指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

BlobOutputDataSource

Object

描述 Blob 输出数据源。

名称	类型	默认值	说明
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.blobPathPrefix	string		Blob 路径前缀。
properties.container	string		关联的存储帐户中的容器的名称。此容器包含要从中读取或写入到的 blob（s）。 PUT （CreateOrReplace）请求时是必需的。
properties.dateFormat	string		日期格式。无论 {date} 出现在 pathPattern 中，此属性的值将改为用作日期格式。
properties.pathPattern	string		Blob 路径模式。不是正则表达式。它表示将匹配 Blob 名称的模式，以确定它们是否应作为作业的输入或输出包含在内。有关更详细的说明和示例，请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output。
properties.storageAccounts	StorageAccount[]		一个或多个 Azure 存储帐户的列表。 PUT （CreateOrReplace）请求时是必需的。
properties.timeFormat	string		时间格式。无论 {time} 出现在 pathPattern 中，此属性的值将改为用作时间格式。
type	string: Microsoft.Storage/Blob		指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

BlobReferenceInputDataSource

Object

描述包含引用数据的 Blob 输入数据源。

名称	类型	默认值	说明
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.container	string		关联的存储帐户中的容器的名称。此容器包含要从中读取或写入到的 blob（s）。 PUT （CreateOrReplace）请求时是必需的。
properties.dateFormat	string		日期格式。无论 {date} 出现在 pathPattern 中，此属性的值将改为用作日期格式。
properties.pathPattern	string		Blob 路径模式。不是正则表达式。它表示将匹配 Blob 名称的模式，以确定它们是否应作为作业的输入或输出包含在内。有关更详细的说明和示例，请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output。
properties.storageAccounts	StorageAccount[]		一个或多个 Azure 存储帐户的列表。 PUT （CreateOrReplace）请求时是必需的。
properties.timeFormat	string		时间格式。无论 {time} 出现在 pathPattern 中，此属性的值将改为用作时间格式。
type	string: Microsoft.Storage/Blob		指示包含引用数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

BlobStreamInputDataSource

Object

描述包含流数据的 Blob 输入数据源。

名称	类型	默认值	说明
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.container	string		关联的存储帐户中的容器的名称。此容器包含要从中读取或写入到的 blob（s）。 PUT （CreateOrReplace）请求时是必需的。
properties.dateFormat	string		日期格式。无论 {date} 出现在 pathPattern 中，此属性的值将改为用作日期格式。
properties.pathPattern	string		Blob 路径模式。不是正则表达式。它表示将匹配 Blob 名称的模式，以确定它们是否应作为作业的输入或输出包含在内。有关更详细的说明和示例，请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output。
properties.sourcePartitionCount	integer (int32)		Blob 输入数据源的分区计数。范围 1 - 1024。
properties.storageAccounts	StorageAccount[]		一个或多个 Azure 存储帐户的列表。 PUT （CreateOrReplace）请求时是必需的。
properties.timeFormat	string		时间格式。无论 {time} 出现在 pathPattern 中，此属性的值将改为用作时间格式。
type	string: Microsoft.Storage/Blob		指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

ClusterInfo

Object

与流分析群集关联的属性。

名称	类型	说明
id	string	群集的资源 ID。

CompatibilityLevel

枚举

控制流式处理作业的某些运行时行为。

值	说明
1.0
1.2

Compression

Object

描述如何压缩输入数据

名称	类型	默认值	说明
type	CompressionType	None	指示输入使用的压缩类型。 PUT （CreateOrReplace）请求时是必需的。

CompressionType

枚举

指示输入使用的压缩类型。 PUT （CreateOrReplace）请求时是必需的。

值	说明
None
GZip
Deflate

ContentStoragePolicy

枚举

有效值为 JobStorageAccount 和 SystemAccount。如果设置为 JobStorageAccount，则这要求用户也指定 jobStorageAccount 属性。 .

值	说明
SystemAccount
JobStorageAccount

CsvSerialization

Object

描述如何序列化输入中的数据，或者将数据写入 CSV 格式时如何序列化数据。

名称	类型	说明
properties.encoding	Encoding	指定传入数据的编码（在输入的情况下）和输出时传出数据的编码。 PUT （CreateOrReplace）请求时是必需的。
properties.fieldDelimiter	string	指定将用于分隔逗号分隔值（CSV）记录的分隔符。有关受支持值列表，请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input 或 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output。 PUT （CreateOrReplace）请求时是必需的。
type	string: Csv	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

DiagnosticCondition

Object

适用于资源或整体作业的条件，值得客户注意。

名称	类型	说明
code	string	不透明的诊断代码。
message	string	详细描述条件的可读消息。在客户端请求的 Accept-Language 中本地化。
since	string	条件启动时的 UTC 时间戳。客户此时应该能够在作日志中找到相应的事件。

Diagnostics

Object

描述适用于整体输入、输出或作业的条件，这些条件值得客户注意。

名称	类型	说明
conditions	DiagnosticCondition[]	适用于资源或整体作业的零个或多个条件的集合，值得客户注意。

DocumentDbOutputDataSource

Object

描述 DocumentDB 输出数据源。

名称	类型	说明
properties.accountId	string	DocumentDB 帐户名称或 ID。 PUT （CreateOrReplace）请求时是必需的。
properties.accountKey	string	DocumentDB 帐户的帐户密钥。 PUT （CreateOrReplace）请求时是必需的。
properties.collectionNamePattern	string	要使用的集合的集合名称模式。可以使用可选的 {partition} 标记构造集合名称格式，其中分区从 0 开始。有关详细信息，请参阅 https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output 的 DocumentDB 部分。 PUT （CreateOrReplace）请求时是必需的。
properties.database	string	DocumentDB 数据库的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.documentId	string	输出事件中用于指定插入或更新操作所基于的主键的字段的名称。
properties.partitionKey	string	输出事件中用于指定键以跨集合对输出进行分区的字段的名称。如果“collectionNamePattern”包含 {partition} 标记，则需要指定此属性。
type	string: Microsoft.Storage/DocumentDB	指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

Encoding

枚举

指定传入数据的编码（在输入的情况下）和输出时传出数据的编码。

值	说明
UTF8

Error

Object

常见的错误表示形式。

名称	类型	说明
error	Error	错误定义属性。

EventHubOutputDataSource

Object

描述事件中心输出数据源。

名称	类型	默认值	说明
authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.eventHubName	string		事件中心的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.partitionKey	string		用于确定要发送事件数据的分区的键/列。
properties.propertyColumns	string[]		与此事件中心输出关联的属性。
serviceBusNamespace	string		与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyKey	string		指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyName	string		事件中心、服务总线队列、服务总线主题等的共享访问策略名称。PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.ServiceBus/EventHub		指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

EventHubStreamInputDataSource

Object

描述包含流数据的事件中心输入数据源。

名称	类型	默认值	说明
authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.consumerGroupName	string		事件中心使用者组的名称，该组应用于从事件中心读取事件。为多个输入指定不同的使用者组名称允许每个输入从事件中心接收相同的事件。如果未指定，则输入使用事件中心的默认使用者组。
properties.eventHubName	string		事件中心的名称。 PUT （CreateOrReplace）请求时是必需的。
serviceBusNamespace	string		与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyKey	string		指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyName	string		事件中心、服务总线队列、服务总线主题等的共享访问策略名称。PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.ServiceBus/EventHub		指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

EventHubV2OutputDataSource

Object

描述事件中心输出数据源。

名称	类型	默认值	说明
authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.eventHubName	string		事件中心的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.partitionKey	string		用于确定要发送事件数据的分区的键/列。
properties.propertyColumns	string[]		与此事件中心输出关联的属性。
serviceBusNamespace	string		与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyKey	string		指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyName	string		事件中心、服务总线队列、服务总线主题等的共享访问策略名称。PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.EventHub/EventHub		指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

EventHubV2StreamInputDataSource

Object

描述包含流数据的事件中心输入数据源。

名称	类型	默认值	说明
authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.consumerGroupName	string		事件中心使用者组的名称，该组应用于从事件中心读取事件。为多个输入指定不同的使用者组名称允许每个输入从事件中心接收相同的事件。如果未指定，则输入使用事件中心的默认使用者组。
properties.eventHubName	string		事件中心的名称。 PUT （CreateOrReplace）请求时是必需的。
serviceBusNamespace	string		与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyKey	string		指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
sharedAccessPolicyName	string		事件中心、服务总线队列、服务总线主题等的共享访问策略名称。PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.EventHub/EventHub		指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

EventSerializationType

枚举

指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

值	说明
Csv
Avro
Json
Parquet

EventsOutOfOrderPolicy

枚举

指示要应用于输入事件流中无序到达的事件的策略。

值	说明
Adjust
Drop

FileReferenceInputDataSource

Object

描述包含引用数据的文件输入数据源。

名称	类型	说明
properties.path	string	文件的路径。
type	string: File	指示包含引用数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

Function

Object

一个函数对象，包含与命名函数关联的所有信息。所有函数都包含在流式处理作业下。

名称	类型	说明
id	string	资源 ID
name	string	资源名称
properties	FunctionProperties: AggregateFunctionProperties ScalarFunctionProperties	与函数关联的属性。
type	string	资源类型

FunctionInput

Object

描述函数的一个输入参数。

名称	类型	说明
dataType	string	函数输入参数的（支持 Azure 流分析）数据类型。 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx 介绍了有效的 Azure 流分析数据类型列表
isConfigurationParameter	boolean	指示参数是否为配置参数的标志。如此如果此输入参数应为常量。默认值为 false。

FunctionOutput

Object

描述函数的输出。

名称	类型	说明
dataType	string	函数输出的（Azure 流分析支持）数据类型。 https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx 介绍了有效的 Azure 流分析数据类型列表

GatewayMessageBusOutputDataSource

Object

描述网关消息总线输出数据源。

名称	类型	说明
properties.topic	string	服务总线主题的名称。
type	string: GatewayMessageBus	指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

GatewayMessageBusStreamInputDataSource

Object

描述包含流数据的 Blob 输入数据源。

名称	类型	说明
properties.topic	string	服务总线主题的名称。
type	string: GatewayMessageBus	指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

Identity

Object

描述如何验证标识

名称	类型	说明
principalId	string	标识主体 ID
tenantId	string	identity tenantId
type	string	标识类型

Input

Object

一个输入对象，包含与命名输入关联的所有信息。所有输入都包含在流式处理作业下。

名称	类型	说明
id	string	资源 ID
name	string	资源名称
properties	InputProperties: ReferenceInputProperties StreamInputProperties	与输入关联的属性。 PUT （CreateOrReplace）请求时是必需的。
type	string	资源类型

IoTHubStreamInputDataSource

Object

描述包含流数据的 IoT 中心输入数据源。

名称	类型	说明
properties.consumerGroupName	string	应用于从 IoT 中心读取事件的 IoT 中心使用者组的名称。如果未指定，则输入使用 Iot 中心的默认使用者组。
properties.endpoint	string	要连接到的 IoT 中心终结点（例如消息/事件、消息/operationsMonitoringEvents 等）。
properties.iotHubNamespace	string	IoT 中心的名称或 URI。 PUT （CreateOrReplace）请求时是必需的。
properties.sharedAccessPolicyKey	string	指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
properties.sharedAccessPolicyName	string	IoT 中心的共享访问策略名称。此策略必须至少包含服务连接权限。 PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.Devices/IotHubs	指示包含流数据的输入数据源的类型。 PUT （CreateOrReplace）请求时是必需的。

JavaScriptFunctionBinding

Object

绑定到 JavaScript 函数。

名称	类型	说明
properties.script	string	包含单个函数定义的 JavaScript 代码。例如：“function （x， y） { return x + y; }'
type	string: Microsoft.StreamAnalytics/JavascriptUdf	指示函数绑定类型。

JobStorageAccount

Object

与 MSI 的 Azure 存储帐户关联的属性

名称	类型	默认值	说明
accountKey	string		Azure 存储帐户的帐户密钥。 PUT （CreateOrReplace）请求时是必需的。
accountName	string		Azure 存储帐户的名称。 PUT （CreateOrReplace）请求时是必需的。
authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。

JobType

枚举

描述作业的类型。有效模式 Cloud 和“Edge”。

值	说明
Cloud
Edge

JsonOutputSerializationFormat

枚举

指定输出将写入的 JSON 的格式。当前支持的值是“lineSeparated”，指示输出将设置格式，方法是让每个 JSON 对象用新行分隔，“array”指示输出将格式化为 JSON 对象的数组。

值	说明
LineSeparated
Array

JsonSerialization

Object

描述如何序列化输入中的数据，或者以 JSON 格式写入输出时如何序列化数据。

名称	类型	说明
properties.encoding	Encoding	指定传入数据的编码（在输入的情况下）和输出时传出数据的编码。 PUT （CreateOrReplace）请求时是必需的。
properties.format	JsonOutputSerializationFormat	此属性仅适用于输出的 JSON 序列化。它不适用于输入。此属性指定输出将写入的 JSON 的格式。当前支持的值是“lineSeparated”，指示输出将设置格式，方法是让每个 JSON 对象用新行分隔，“array”指示输出将格式化为 JSON 对象的数组。如果为 null，则默认值为“lineSeparated”。
type	string: Json	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

Output

Object

一个输出对象，包含与命名输出关联的所有信息。所有输出都包含在流式处理作业下。

名称	类型	说明
id	string	资源 ID
name	string	资源名称
properties.datasource	OutputDataSource: AzureDataLakeStoreOutputDataSource AzureFunctionOutputDataSource AzureSqlDatabaseOutputDataSource AzureSynapseOutputDataSource AzureTableOutputDataSource BlobOutputDataSource DocumentDbOutputDataSource EventHubOutputDataSource EventHubV2OutputDataSource GatewayMessageBusOutputDataSource PowerBIOutputDataSource ServiceBusQueueOutputDataSource ServiceBusTopicOutputDataSource	描述输出将写入到的数据源。 PUT （CreateOrReplace）请求时是必需的。
properties.diagnostics	Diagnostics	描述适用于整体输入、输出或作业的条件，这些条件值得客户注意。
properties.etag	string	输出的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
properties.serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	描述如何序列化输入中的数据，或将数据写入输出时如何序列化数据。 PUT （CreateOrReplace）请求时是必需的。
properties.sizeWindow	integer (int32)	要限制流分析输出的大小窗口。
properties.timeWindow	string	筛选流分析作业输出的时间范围。
type	string	资源类型

OutputErrorPolicy

枚举

指示要应用于到达输出的事件的策略，并且由于格式不正确（缺少列值、类型错误或大小的列值缺失）而无法写入外部存储。

值	说明
Stop
Drop

OutputStartMode

枚举

值可以是 JobStartTime、CustomTime 或 LastOutputEventTime，以指示在启动作业时，输出事件流的起始点是否应启动，从通过 outputStartTime 属性指定的自定义用户时间戳开始，还是从上一个事件输出时间开始。

值	说明
JobStartTime
CustomTime
LastOutputEventTime

ParquetSerialization

Object

描述如何序列化输入中的数据，或者当以 Parquet 格式写入输出时如何序列化数据。

名称	类型	说明
type	string: Parquet	指示输入或输出使用的序列化类型。 PUT （CreateOrReplace）请求时是必需的。

PowerBIOutputDataSource

Object

介绍 Power BI 输出数据源。

名称	类型	默认值	说明
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.dataset	string		Power BI 数据集的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.groupId	string		Power BI 组的 ID。
properties.groupName	string		Power BI 组的名称。使用此属性有助于记住使用了哪个特定的 Power BI 组 ID。
properties.refreshToken	string		一个刷新令牌，可用于获取有效的访问令牌，然后可用于向数据源进行身份验证。当前只能通过 Azure 门户获取有效的刷新令牌。建议在创建数据源时在此处放置虚拟字符串值，然后转到 Azure 门户对数据源进行身份验证，该数据源将使用有效的刷新令牌更新此属性。 PUT （CreateOrReplace）请求时是必需的。
properties.table	string		指定数据集下的 Power BI 表的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.tokenUserDisplayName	string		用于获取刷新令牌的用户的用户显示名称。使用此属性有助于记住哪些用户用于获取刷新令牌。
properties.tokenUserPrincipalName	string		用于获取刷新令牌的用户的用户主体名称（UPN）。使用此属性有助于记住哪些用户用于获取刷新令牌。
type	string: PowerBI		指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

ReferenceInputProperties

Object

与包含引用数据的输入关联的属性。

名称	类型	说明
compression	Compression	描述如何压缩输入数据
datasource	ReferenceInputDataSource: AzureSqlReferenceInputDataSource BlobReferenceInputDataSource FileReferenceInputDataSource	描述包含引用数据的输入数据源。 PUT （CreateOrReplace）请求时是必需的。
diagnostics	Diagnostics	描述适用于整体输入、输出或作业的条件，这些条件值得客户注意。
etag	string	输入的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
partitionKey	string	partitionKey 描述用于对输入数据进行分区的输入数据中的键
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	描述如何序列化输入中的数据，或将数据写入输出时如何序列化数据。 PUT （CreateOrReplace）请求时是必需的。
type	string: Reference	指示输入是引用数据源还是流数据源。 PUT （CreateOrReplace）请求时是必需的。

RefreshType

枚举

指示数据刷新选项的类型。

值	说明
Static
RefreshPeriodicallyWithFull
RefreshPeriodicallyWithDelta

ScalarFunctionProperties

Object

与标量函数关联的属性。

名称	类型	说明
etag	string	函数的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
properties.binding	FunctionBinding: AzureMachineLearningWebServiceFunctionBinding JavaScriptFunctionBinding	函数的物理绑定。例如，在 Azure 机器学习 Web 服务的情况下，这描述了终结点。
properties.inputs	FunctionInput[]	描述函数的一个输入参数。
properties.output	FunctionOutput	描述函数的输出。
type	string: Scalar	指示函数的类型。

ServiceBusQueueOutputDataSource

Object

描述服务总线队列输出数据源。

名称	类型	默认值	说明
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.propertyColumns	string[]		要作为自定义属性附加到服务总线消息的输出列名称的字符串数组。
properties.queueName	string		服务总线队列的名称。 PUT （CreateOrReplace）请求时是必需的。
properties.serviceBusNamespace	string		与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。PUT （CreateOrReplace）请求时是必需的。
properties.sharedAccessPolicyKey	string		指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
properties.sharedAccessPolicyName	string		事件中心、服务总线队列、服务总线主题等的共享访问策略名称。PUT （CreateOrReplace）请求时是必需的。
properties.systemPropertyColumns	object		与服务总线队列关联的系统属性。支持以下系统属性：ReplyToSessionId、ContentType、To、Subject、CorrelationId、TimeToLive、PartitionKey、SessionId、ScheduledEnqueueTime、MessageId、ReplyTo、Label、ScheduledEnqueueTimeUtc。
type	string: Microsoft.ServiceBus/Queue		指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

ServiceBusTopicOutputDataSource

Object

描述服务总线主题输出数据源。

名称	类型	默认值	说明
properties.authenticationMode	AuthenticationMode	ConnectionString	身份验证模式。
properties.propertyColumns	string[]		要作为自定义属性附加到服务总线消息的输出列名称的字符串数组。
properties.serviceBusNamespace	string		与所需事件中心、服务总线队列、服务总线主题等关联的命名空间。PUT （CreateOrReplace）请求时是必需的。
properties.sharedAccessPolicyKey	string		指定共享访问策略的共享访问策略密钥。 PUT （CreateOrReplace）请求时是必需的。
properties.sharedAccessPolicyName	string		事件中心、服务总线队列、服务总线主题等的共享访问策略名称。PUT （CreateOrReplace）请求时是必需的。
properties.systemPropertyColumns	object		与服务总线主题输出关联的系统属性。支持以下系统属性：ReplyToSessionId、ContentType、To、Subject、CorrelationId、TimeToLive、PartitionKey、SessionId、ScheduledEnqueueTime、MessageId、ReplyTo、Label、ScheduledEnqueueTimeUtc。
properties.topicName	string		服务总线主题的名称。 PUT （CreateOrReplace）请求时是必需的。
type	string: Microsoft.ServiceBus/Topic		指示将写入数据源输出的类型。 PUT （CreateOrReplace）请求时是必需的。

Sku

Object

与 SKU 关联的属性。

名称	类型	说明
name	SkuName	SKU 的名称。 PUT （CreateOrReplace）请求时是必需的。

SkuName

枚举

SKU 的名称。 PUT （CreateOrReplace）请求时是必需的。

值	说明
Standard

StorageAccount

Object

与 Azure 存储帐户关联的属性

名称	类型	说明
accountKey	string	Azure 存储帐户的帐户密钥。 PUT （CreateOrReplace）请求时是必需的。
accountName	string	Azure 存储帐户的名称。 PUT （CreateOrReplace）请求时是必需的。

StreamingJob

Object

流式处理作业对象，包含与命名流式处理作业关联的所有信息。

名称	类型	说明
id	string	资源的完全限定资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity	描述分配给此作业的系统分配的托管标识，该标识可用于通过输入和输出进行身份验证。
location	string	资源所在的地理位置
name	string	资源的名称
properties.cluster	ClusterInfo	将运行流式处理作业的群集。
properties.compatibilityLevel	CompatibilityLevel	控制流式处理作业的某些运行时行为。
properties.contentStoragePolicy	ContentStoragePolicy	有效值为 JobStorageAccount 和 SystemAccount。如果设置为 JobStorageAccount，则这要求用户也指定 jobStorageAccount 属性。 .
properties.createdDate	string (date-time)	值为 ISO-8601 格式的 UTC 时间戳，指示创建流式处理作业的时间。
properties.dataLocale	string	流分析作业的数据区域设置。值应是集 https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx中支持的 .NET 区域性的名称。如果未指定，则默认为“en-US”。
properties.etag	string	流式处理作业的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
properties.eventsLateArrivalMaxDelayInSeconds	integer (int32)	可以包含到达延迟的事件的最大可容忍延迟（以秒为单位）。支持的范围 -1 为1814399（20.23：59：59 天），-1 用于无限期指定等待。如果该属性不存在，则解释为值为 -1。
properties.eventsOutOfOrderMaxDelayInSeconds	integer (int32)	可以调整无序事件以按顺序返回的最大可容忍延迟（以秒为单位）。
properties.eventsOutOfOrderPolicy	EventsOutOfOrderPolicy	指示要应用于输入事件流中无序到达的事件的策略。
properties.functions	Function[]	流式处理作业的一个或多个函数的列表。在 PUT 请求中指定此属性时，需要每个函数的名称属性。此属性不能通过 PATCH 操作进行修改。必须使用可用于单个转换的 PATCH API。
properties.inputs	Input[]	流式处理作业的一个或多个输入的列表。在 PUT 请求中指定此属性时，需要每个输入的名称属性。此属性不能通过 PATCH 操作进行修改。必须使用可用于单个输入的 PATCH API。
properties.jobId	string	唯一标识流式处理作业的 GUID。此 GUID 是在创建流式处理作业时生成的。
properties.jobState	string	描述流式处理作业的状态。
properties.jobStorageAccount	JobStorageAccount	与 MSI 的 Azure 存储帐户关联的属性
properties.jobType	JobType	描述作业的类型。有效模式 `Cloud` 和“Edge”。
properties.lastOutputEventTime	string (date-time)	值为 ISO-8601 格式的时间戳，指示流式处理作业的最后一个输出事件时间，或指示尚未生成输出的 null。如果有多个输出或多个流，则显示该集中的最新值。
properties.outputErrorPolicy	OutputErrorPolicy	指示要应用于到达输出的事件的策略，并且由于格式不正确（缺少列值、类型错误或大小的列值缺失）而无法写入外部存储。
properties.outputStartMode	OutputStartMode	仅当需要创建作业时立即启动该作业时，才应使用此属性。值可以是 JobStartTime、CustomTime 或 LastOutputEventTime，以指示在启动作业时，输出事件流的起始点是否应启动，从通过 outputStartTime 属性指定的自定义用户时间戳开始，还是从上一个事件输出时间开始。
properties.outputStartTime	string (date-time)	值是一个 ISO-8601 格式的时间戳，指示输出事件流的起始点，或为 null，以指示每当启动流式处理作业时输出事件流将启动。如果 outputStartMode 设置为 CustomTime，此属性必须具有值。
properties.outputs	Output[]	流式处理作业的一个或多个输出的列表。在 PUT 请求中指定此属性时，需要每个输出的名称属性。此属性不能通过 PATCH 操作进行修改。必须使用可用于单个输出的 PATCH API。
properties.provisioningState	string	描述流式处理作业的预配状态。
properties.sku	Sku	描述流式处理作业的 SKU。 PUT （CreateOrReplace）请求时是必需的。
properties.transformation	Transformation	指示要用于流式处理作业的查询和流单元数。在 PUT 请求中指定此属性时，需要转换的名称属性。此属性不能通过 PATCH 操作进行修改。必须使用可用于单个转换的 PATCH API。
tags	object	资源标记。
type	string	资源的类型。 Ex- Microsoft.Compute/virtualMachines 或 Microsoft.Storage/storageAccounts。

StreamInputProperties

Object

与包含流数据的输入关联的属性。

名称	类型	说明
compression	Compression	描述如何压缩输入数据
datasource	StreamInputDataSource: BlobStreamInputDataSource EventHubStreamInputDataSource EventHubV2StreamInputDataSource GatewayMessageBusStreamInputDataSource IoTHubStreamInputDataSource	描述包含流数据的输入数据源。 PUT （CreateOrReplace）请求时是必需的。
diagnostics	Diagnostics	描述适用于整体输入、输出或作业的条件，这些条件值得客户注意。
etag	string	输入的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
partitionKey	string	partitionKey 描述用于对输入数据进行分区的输入数据中的键
serialization	Serialization: AvroSerialization CsvSerialization JsonSerialization ParquetSerialization	描述如何序列化输入中的数据，或将数据写入输出时如何序列化数据。 PUT （CreateOrReplace）请求时是必需的。
type	string: Stream	指示输入是引用数据源还是流数据源。 PUT （CreateOrReplace）请求时是必需的。

Transformation

Object

转换对象，包含与命名转换关联的所有信息。所有转换都包含在流式处理作业下。

名称	类型	默认值	说明
id	string		资源 ID
name	string		资源名称
properties.etag	string		转换的当前实体标记。这是一个不透明的字符串。可以使用它来检测资源是否在请求之间发生了更改。还可以在 If-Match 或 If-None-Match 标头中使用它，以便进行乐观并发的写入作。
properties.query	string		指定将在流式处理作业中运行的查询。可以在此处了解有关流分析查询语言（SAQL）的详细信息：https://msdn.microsoft.com/library/azure/dn834998。 PUT （CreateOrReplace）请求时是必需的。
properties.streamingUnits	integer (int32)	3	指定流式处理作业使用的流单元数。
properties.validStreamingUnits	integer[] (int32)		指定流式处理作业可缩放到的有效流单元。
type	string		资源类型