Streaming Jobs - Create Or Replace

Создает задание потоковой передачи или заменяет уже существующее задание потоковой передачи.

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

Имя группы ресурсов. Регистр букв в имени не учитывается.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Идентификатор целевой подписки.

api-version
query True

string

Версия API, используемая для данной операции.

Заголовок запроса

Имя Обязательно Тип Описание
If-Match

string

ETag задания потоковой передачи. Пропустите это значение, чтобы всегда перезаписывать текущий набор записей. Укажите последнее значение ETag, чтобы предотвратить случайную перезапись параллельных изменений.

If-None-Match

string

Задайте значение "*", чтобы разрешить создание задания потоковой передачи, но предотвратить обновление существующего набора записей. Другие значения приводят к ответу 412 Pre-Condition Failed.

Текст запроса

Имя Тип Описание
identity

Identity

Описывает управляемое удостоверение, назначаемое системой, назначенное этому заданию, которое можно использовать для проверки подлинности с помощью входных и выходных данных.

location

string

Географическое расположение, в котором находится ресурс

properties.cluster

ClusterInfo

Кластер, в котором будут выполняться задания потоковой передачи.

properties.compatibilityLevel

CompatibilityLevel

Управляет отдельными аспектами поведения задания потоковой передачи во время выполнения.

properties.contentStoragePolicy

ContentStoragePolicy

Допустимые значения: JobStorageAccount и SystemAccount. Если задано значение JobStorageAccount, пользователь также должен указать свойство jobStorageAccount. .

properties.dataLocale

string

Языковой стандарт данных задания Stream Analytics. Значение должно быть именем поддерживаемого языка и региональных параметров .NET из набора https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Если значение не указано, по умолчанию используется "en-US".

properties.eventsLateArrivalMaxDelayInSeconds

integer

Максимальная приемлемая задержка в секундах, в течение которой могут быть добавлены события, поступающие с запозданием. Поддерживаемый диапазон — от –1 до 1814399 (20,23:59:59 дней). Значение –1 используется для указания неограниченного времени ожидания. Если свойство не указано, по умолчанию используется значение –1.

properties.eventsOutOfOrderMaxDelayInSeconds

integer

Максимальная приемлемая задержка в секундах, в течение которой события, поступающие не по порядку, могут быть упорядочены.

properties.eventsOutOfOrderPolicy

EventsOutOfOrderPolicy

Указывает политику, применяемую к событиям, которые поступают в потоке входных событий не по порядку.

properties.functions

Function[]

Список одной или нескольких функций для задания потоковой передачи. Свойство name для каждой функции является обязательным при указании этого свойства в запросе PUT. Это свойство нельзя изменить с помощью операции PATCH. Необходимо использовать API PATCH, доступный для отдельного преобразования.

properties.inputs

Input[]

Список из одного или нескольких входных данных для задания потоковой передачи. Свойство name для каждого входного значения является обязательным при указании этого свойства в запросе PUT. Это свойство нельзя изменить с помощью операции PATCH. Необходимо использовать API PATCH, доступный для отдельных входных данных.

properties.jobStorageAccount

JobStorageAccount

Свойства, связанные с учетной записью хранения Azure с MSI

properties.jobType

JobType

Описывает тип задания. Допустимые режимы: Cloud и "Edge".

properties.outputErrorPolicy

OutputErrorPolicy

Указывает политику, применяемую к событиям, которые поступают в выходные данные и не могут быть записаны во внешнее хранилище из-за неправильного формата (значения столбцов отсутствуют, имеют неправильный тип или размер).

properties.outputStartMode

OutputStartMode

Это свойство следует использовать только в том случае, если требуется, чтобы задание запускалось сразу после создания. Значение может иметь значение JobStartTime, CustomTime или LastOutputEventTime, чтобы указать, должна ли начальная точка потока выходных событий начинаться при запуске задания, начинаться с пользовательской метки времени, указанной в свойстве outputStartTime, или с момента последнего времени вывода события.

properties.outputStartTime

string

Значением является либо метка времени в формате ISO-8601, указывающая начальную точку выходного потока событий, или значение NULL, указывающее, что выходной поток событий запускает при каждом запуске задания потоковой передачи. Это свойство должно иметь значение , если параметр outputStartMode имеет значение CustomTime.

properties.outputs

Output[]

Список из одного или нескольких выходных данных для задания потоковой передачи. Свойство name для каждого выходных данных является обязательным при указании этого свойства в запросе PUT. Это свойство нельзя изменить с помощью операции PATCH. Необходимо использовать API PATCH, доступный для отдельных выходных данных.

properties.sku

Sku

Описывает номер SKU задания потоковой передачи. Требуется для запросов PUT (CreateOrReplace).

properties.transformation

Transformation

Указывает запрос и количество единиц потоковой передачи, используемых для задания потоковой передачи. Свойство name преобразования является обязательным при указании этого свойства в запросе PUT. Это свойство нельзя изменить с помощью операции PATCH. Необходимо использовать API PATCH, доступный для отдельного преобразования.

tags

object

Теги ресурсов.

Ответы

Имя Тип Описание
200 OK

StreamingJob

Задание потоковой передачи успешно создано или заменено.

Headers

ETag: string

201 Created

StreamingJob

Задание потоковой передачи успешно создано или заменено.

Headers

ETag: string

Other Status Codes

Error

Ошибка.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя Описание
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)

Sample Request

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"
  }
}

Sample Response

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"
        }
      }
    ]
  }
}
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)

Sample Request

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"
  }
}

Sample Response

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": []
  }
}
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.

AzureMachineLearningWebServiceInputColumn

Описывает входной столбец для конечной точки веб-службы Машинного обучения Azure.

AzureMachineLearningWebServiceInputs

Входные данные для конечной точки веб-службы Машинного обучения Azure.

AzureMachineLearningWebServiceOutputColumn

Описывает выходной столбец для конечной точки веб-службы Машинного обучения Azure.

AzureSqlDatabaseOutputDataSource

Описывает источник выходных данных Azure SQL базы данных.

AzureSqlReferenceInputDataSource

Описывает источник входных данных Azure SQL базы данных.

AzureSynapseOutputDataSource

Описывает источник выходных данных Azure Synapse.

AzureTableOutputDataSource

Описывает источник выходных данных таблицы Azure.

BlobOutputDataSource

Описывает источник выходных данных BLOB-объекта.

BlobReferenceInputDataSource

Описывает источник входных данных BLOB-объекта, содержащий эталонные данные.

BlobStreamInputDataSource

Описывает источник входных данных BLOB-объекта, содержащий потоковые данные.

ClusterInfo

Свойства, связанные с кластером Stream Analytics.

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

Описывает источник входных данных Центр Интернета вещей, содержащий потоковые данные.

JavaScriptFunctionBinding

Привязка к функции JavaScript.

JobStorageAccount

Свойства, связанные с учетной записью хранения Azure с MSI

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

Свойства, связанные с агрегатной функцией.

Имя Тип Описание
etag

string

Текущий тег сущности для функции. Это непрозрачная строка. С его помощью можно определить, изменился ли ресурс между запросами. Его также можно использовать в заголовках If-Match или If-None-Match для операций записи для оптимистического параллелизма.

properties.binding FunctionBinding:

Физическая привязка функции. Например, в случае веб-службы Машинного обучения Azure это описывает конечную точку.

properties.inputs

FunctionInput[]

Описывает один входной параметр функции.

properties.output

FunctionOutput

Описывает выходные данные функции.

type string:

Aggregate

Указывает тип функции.

AuthenticationMode

Режим проверки подлинности. Допустимые режимы: ConnectionString, Msi и UserToken.

Имя Тип Описание
ConnectionString

string

Msi

string

UserToken

string

AvroSerialization

Описывается сериализация данных из входных данных или сериализация данных при записи в выходные данные в формате Avro.

Имя Тип Описание
type string:

Avro

Указывает тип сериализации, используемой входными или выходными данными. Требуется для запросов PUT (CreateOrReplace).

AzureDataLakeStoreOutputDataSource

Описывает источник выходных данных 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

Идентификатор клиента пользователя, используемого для получения маркера обновления. Требуется для запросов PUT (CreateOrReplace).

properties.timeFormat

string

Формат времени. Везде, где {time} отображается в filePathPrefix, значение этого свойства используется в качестве формата времени.

properties.tokenUserDisplayName

string

Отображаемое имя пользователя, которое использовалось для получения маркера обновления. Используйте это свойство, чтобы запомнить, какой пользователь использовался для получения маркера обновления.

properties.tokenUserPrincipalName

string

Имя участника-пользователя (UPN) пользователя, который использовался для получения маркера обновления. Используйте это свойство, чтобы запомнить, какой пользователь использовался для получения маркера обновления.

type string:

Microsoft.DataLake/Accounts

Указывает тип выходных данных источника данных, в который будет записана запись. Требуется для запросов PUT (CreateOrReplace).

AzureFunctionOutputDataSource

Определяет метаданные AzureFunctionOutputDataSource.

Имя Тип Описание
properties.apiKey

string

Если нужно использовать службу "Функции Azure" из другой подписки это можно сделать, предоставив ключ для доступа к функции.

properties.functionAppName

string

Имя приложения-функции Azure.

properties.functionName

string

Имя функции в приложении-функции Azure.

properties.maxBatchCount

number

Свойство, которое позволяет указать максимальное число событий в каждом пакете, отправляемых в функции Azure. По умолчанию используется значение 100.

properties.maxBatchSize

number

Свойство, которое позволяет задать максимальный размер для каждого выходного пакета, отправляемого в функцию Azure. Объем входных данных задается в байтах. По умолчанию это значение равно 262 144 байт (256 КБ).

type string:

Microsoft.AzureFunction

Указывает тип выходных данных источника данных, в который будет записана запись. Требуется для запросов PUT (CreateOrReplace).

AzureMachineLearningWebServiceFunctionBinding

Привязка к веб-службе Машинного обучения Azure.

Имя Тип Описание
properties.apiKey

string

Ключ API, используемый для проверки подлинности в конечной точке Request-Response.

properties.batchSize

integer

Число от 1 до 10 000, описывающее максимальное число строк для каждого запроса выполнения Azure ML RRS. Значение по умолчанию — 1000.

properties.endpoint

string

Request-Response выполнять конечную точку веб-службы Машинного обучения Azure. Дополнительные сведения см. здесь: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs

properties.inputs

AzureMachineLearningWebServiceInputs

Входные данные для конечной точки веб-службы Машинного обучения Azure.

properties.outputs

AzureMachineLearningWebServiceOutputColumn[]

Список выходных данных выполнения конечной точки веб-службы Машинного обучения Azure.

type string:

Microsoft.MachineLearning/WebService

Указывает тип привязки функции.

AzureMachineLearningWebServiceInputColumn

Описывает входной столбец для конечной точки веб-службы Машинного обучения Azure.

Имя Тип Описание
dataType

string

Тип данных (поддерживаемый Машинным обучением Azure) входного столбца. Список допустимых типов данных Машинного обучения Azure описан в разделе https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .

mapTo

integer

Отсчитываемый от нуля индекс параметра функции, с который сопоставляется входные данные.

name

string

Имя входного столбца.

AzureMachineLearningWebServiceInputs

Входные данные для конечной точки веб-службы Машинного обучения Azure.

Имя Тип Описание
columnNames

AzureMachineLearningWebServiceInputColumn[]

Список входных столбцов для конечной точки веб-службы Машинного обучения Azure.

name

string

Имя входа. Это имя, указанное при создании конечной точки.

AzureMachineLearningWebServiceOutputColumn

Описывает выходной столбец для конечной точки веб-службы Машинного обучения Azure.

Имя Тип Описание
dataType

string

Тип данных (поддерживаемый Машинным обучением Azure) выходного столбца. Список допустимых типов данных Машинного обучения Azure описан в разделе https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx .

name

string

Имя выходного столбца.

AzureSqlDatabaseOutputDataSource

Описывает источник выходных данных Azure SQL базы данных.

Имя Тип Значение по умолчанию Описание
properties.authenticationMode

AuthenticationMode

ConnectionString

Режим проверки подлинности.

properties.database

string

Имя базы данных Azure SQL. Требуется для запросов PUT (CreateOrReplace).

properties.maxBatchCount

number

Максимальное число пакетных пакетов для записи в базу данных SQL, значение по умолчанию — 10 000. Необязательно для запросов PUT.

properties.maxWriterCount

number

Максимальное число элементов записи, в настоящее время доступно только 1 (один модуль записи) и 0 (на основе секции запроса). Необязательно для запросов PUT.

properties.password

string

Пароль, который будет использоваться для подключения к базе данных Azure SQL. Требуется для запросов PUT (CreateOrReplace).

properties.server

string

Имя сервера SQL Server, содержащего базу данных Azure SQL. Требуется для запросов 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

Описывает источник входных данных Azure SQL базы данных.

Имя Тип Описание
properties.database

string

Этот элемент связан с элементом datasource. Это имя базы данных, в которую буду записаны выходные данные.

properties.deltaSnapshotQuery

string

Этот элемент связан с элементом datasource. Этот запрос используется для получения добавочных изменений из базы данных SQL. Чтобы использовать этот параметр, рекомендуется использовать темпоральные таблицы в базе данных Azure SQL.

properties.fullSnapshotQuery

string

Этот элемент связан с элементом datasource. Этот запрос используется для получения данных из базы данных SQL.

properties.password

string

Этот элемент связан с элементом datasource. Это пароль, который будет использоваться для подключения к экземпляру базы данных SQL.

properties.refreshRate

string

Этот элемент связан с элементом datasource. Это указывает, как часто данные будут извлекаться из базы данных. Имеет формат DateTime.

properties.refreshType

RefreshType

Указывает тип параметра обновления данных.

properties.server

string

Этот элемент связан с элементом datasource. Это имя сервера, содержащего базу данных,в которую будет выполняться запись.

properties.table

string

Этот элемент связан с элементом datasource. Имя таблицы в базе данных Azure SQL.

properties.user

string

Этот элемент связан с элементом datasource. Это имя пользователя, которое будет использоваться для подключения к экземпляру базы данных SQL.

type string:

Microsoft.Sql/Server/Database

Указывает тип источника входных данных, содержащего эталонные данные. Требуется для запросов PUT (CreateOrReplace).

AzureSynapseOutputDataSource

Описывает источник выходных данных Azure Synapse.

Имя Тип Описание
properties.database

string

Имя базы данных Azure SQL. Требуется для запросов PUT (CreateOrReplace).

properties.password

string

Пароль, который будет использоваться для подключения к базе данных Azure SQL. Требуется для запросов PUT (CreateOrReplace).

properties.server

string

Имя сервера SQL Server, содержащего базу данных Azure SQL. Требуется для запросов 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

Описывает источник выходных данных таблицы Azure.

Имя Тип Описание
properties.accountKey

string

Ключ учетной записи для учетной записи хранения Azure. Требуется для запросов PUT (CreateOrReplace).

properties.accountName

string

имя учетной записи хранения Azure. Требуется для запросов PUT (CreateOrReplace).

properties.batchSize

integer

Количество строк, записываемых в таблицу 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

Описывает источник выходных данных BLOB-объекта.

Имя Тип Значение по умолчанию Описание
properties.authenticationMode

AuthenticationMode

ConnectionString

Режим проверки подлинности.

properties.blobPathPrefix

string

Префикс пути к BLOB-объекту.

properties.container

string

Имя контейнера в связанной учетной записи хранения. Этот контейнер содержит blob-объекты для чтения или записи. Требуется для запросов PUT (CreateOrReplace).

properties.dateFormat

string

Формат даты. Везде, где {date} отображается в pathPattern, значение этого свойства используется в качестве формата даты.

properties.pathPattern

string

Шаблон пути к большому двоичному объекту. Не является регулярным выражением. Он представляет шаблон, с которым будут сопоставляться имена 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

Описывает источник входных данных BLOB-объекта, содержащий эталонные данные.

Имя Тип Значение по умолчанию Описание
properties.authenticationMode

AuthenticationMode

ConnectionString

Режим проверки подлинности.

properties.container

string

Имя контейнера в связанной учетной записи хранения. Этот контейнер содержит blob-объекты для чтения или записи. Требуется для запросов PUT (CreateOrReplace).

properties.dateFormat

string

Формат даты. Везде, где {date} отображается в pathPattern, значение этого свойства используется в качестве формата даты.

properties.pathPattern

string

Шаблон пути к большому двоичному объекту. Не является регулярным выражением. Он представляет шаблон, с которым будут сопоставляться имена 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

Описывает источник входных данных BLOB-объекта, содержащий потоковые данные.

Имя Тип Значение по умолчанию Описание
properties.authenticationMode

AuthenticationMode

ConnectionString

Режим проверки подлинности.

properties.container

string

Имя контейнера в связанной учетной записи хранения. Этот контейнер содержит blob-объекты для чтения или записи. Требуется для запросов PUT (CreateOrReplace).

properties.dateFormat

string

Формат даты. Везде, где {date} отображается в pathPattern, значение этого свойства используется в качестве формата даты.

properties.pathPattern

string

Шаблон пути к большому двоичному объекту. Не является регулярным выражением. Он представляет шаблон, с которым будут сопоставляться имена 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

Число секций источника входных данных BLOB-объекта. Диапазон от 1 до 1024.

properties.storageAccounts

StorageAccount[]

Список из одной или нескольких учетных записей хранения Azure. Требуется для запросов PUT (CreateOrReplace).

properties.timeFormat

string

Формат времени. Везде, где {time} отображается в pathPattern, значение этого свойства используется в качестве формата времени.

type string:

Microsoft.Storage/Blob

Указывает тип источника входных данных, содержащего потоковые данные. Требуется для запросов PUT (CreateOrReplace).

ClusterInfo

Свойства, связанные с кластером Stream Analytics.

Имя Тип Описание
id

string

Идентификатор ресурса кластера.

CompatibilityLevel

Управляет отдельными аспектами поведения задания потоковой передачи во время выполнения.

Имя Тип Описание
1.0

string

1.2

string

Compression

Описывает, как сжимаются входные данные

Имя Тип Значение по умолчанию Описание
type

CompressionType

None

Указывает тип сжатия, используемого входными данными. Требуется для запросов PUT (CreateOrReplace).

CompressionType

Указывает тип сжатия, используемого входными данными. Требуется для запросов PUT (CreateOrReplace).

Имя Тип Описание
Deflate

string

GZip

string

None

string

ContentStoragePolicy

Допустимые значения: JobStorageAccount и SystemAccount. Если задано значение JobStorageAccount, пользователь также должен указать свойство jobStorageAccount. .

Имя Тип Описание
JobStorageAccount

string

SystemAccount

string

CsvSerialization

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные в формате 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

Условие, применимое к ресурсу или заданию в целом, которое требует внимания клиента.

Имя Тип Описание
code

string

Непрозрачный диагностический код.

message

string

Понятное сообщение с подробным описанием условия. Локализовано в Accept-Language клиентского запроса.

since

string

Метка времени начала условия в формате UTC. Клиенты должны найти соответствующее событие в журнале операций примерно в это время.

Diagnostics

Описывает условия, применимые к входным, выходным данным или к заданию в целом, которые требуют внимания клиента.

Имя Тип Описание
conditions

DiagnosticCondition[]

Коллекция из нуля или более условий, применимых к ресурсу или к заданию в целом, которые требуют внимания клиента.

DocumentDbOutputDataSource

Описывает источник выходных данных DocumentDB.

Имя Тип Описание
properties.accountId

string

Имя или идентификатор учетной записи DocumentDB. Требуется для запросов 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

string

Error

Представление общей ошибки.

Имя Тип Описание
error

Error

Свойства определения ошибки.

EventHubOutputDataSource

Описывает источник выходных данных концентратора событий.

Имя Тип Значение по умолчанию Описание
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

Описывает источник входных данных концентратора событий, содержащий потоковые данные.

Имя Тип Значение по умолчанию Описание
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

Описывает источник выходных данных концентратора событий.

Имя Тип Значение по умолчанию Описание
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

Описывает источник входных данных концентратора событий, содержащий потоковые данные.

Имя Тип Значение по умолчанию Описание
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).

Имя Тип Описание
Avro

string

Csv

string

Json

string

Parquet

string

EventsOutOfOrderPolicy

Указывает политику, применяемую к событиям, которые поступают в потоке входных событий не по порядку.

Имя Тип Описание
Adjust

string

Drop

string

FileReferenceInputDataSource

Описывает источник входных данных файла, содержащий эталонные данные.

Имя Тип Описание
properties.path

string

Путь к файлу.

type string:

File

Указывает тип источника входных данных, содержащего ссылочные данные. Требуется для запросов PUT (CreateOrReplace).

Function

Объект функции, содержащий все сведения, связанные с именованной функцией. Все функции содержатся в задании потоковой передачи.

Имя Тип Описание
id

string

Идентификатор ресурса

name

string

Имя ресурса

properties FunctionProperties:

Свойства, связанные с функцией.

type

string

Тип ресурса

FunctionInput

Описывает один входной параметр функции.

Имя Тип Описание
dataType

string

Тип данных (поддерживается Azure Stream Analytics) входного параметра функции. Список допустимых типов данных Azure Stream Analytics описан в статье https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

isConfigurationParameter

boolean

Флаг, указывающий, является ли параметр параметром конфигурации. Значение true, если ожидается, что этот входной параметр является константой. Значение по умолчанию — false.

FunctionOutput

Описывает выходные данные функции.

Имя Тип Описание
dataType

string

Тип данных (поддерживается Azure Stream Analytics) выходных данных функции. Список допустимых типов данных Azure Stream Analytics описан в статье https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx

GatewayMessageBusOutputDataSource

Описывает источник выходных данных шины сообщений шлюза.

Имя Тип Описание
properties.topic

string

Имя раздела служебной шины.

type string:

GatewayMessageBus

Указывает тип выходных данных источника данных, в который будет записана запись. Требуется для запросов PUT (CreateOrReplace).

GatewayMessageBusStreamInputDataSource

Описывает источник входных данных BLOB-объекта, содержащий потоковые данные.

Имя Тип Описание
properties.topic

string

Имя раздела служебной шины.

type string:

GatewayMessageBus

Указывает тип источника входных данных, содержащего потоковые данные. Требуется для запросов PUT (CreateOrReplace).

Identity

Описывает, как проверяется удостоверение

Имя Тип Описание
principalId

string

Идентификатор субъекта удостоверений

tenantId

string

Идентификатор клиента удостоверения

type

string

Тип удостоверения

Input

Входной объект, содержащий все сведения, связанные с именованным входным объектом. Все входные данные содержатся в задании потоковой передачи.

Имя Тип Описание
id

string

Идентификатор ресурса

name

string

Имя ресурса

properties InputProperties:

Свойства, связанные с входными данными. Требуется для запросов PUT (CreateOrReplace).

type

string

Тип ресурса

IoTHubStreamInputDataSource

Описывает источник входных данных Центр Интернета вещей, содержащий потоковые данные.

Имя Тип Описание
properties.consumerGroupName

string

Имя Центр Интернета вещей группы потребителей, которая должна использоваться для чтения событий из Центр Интернета вещей. Если значение не указано, входные данные используют группу потребителей Центра Интернета вещей по умолчанию.

properties.endpoint

string

Конечная точка Центр Интернета вещей для подключения (например, messages/events, messages/operationsMonitoringEvents и т. д.).

properties.iotHubNamespace

string

Имя или URI Центр Интернета вещей. Требуется для запросов PUT (CreateOrReplace).

properties.sharedAccessPolicyKey

string

Ключ политики общего доступа для указанной политики общего доступа. Требуется для запросов PUT (CreateOrReplace).

properties.sharedAccessPolicyName

string

Имя политики общего доступа для Центр Интернета вещей. Эта политика должна содержать по крайней мере разрешение Service Connect. Требуется для запросов PUT (CreateOrReplace).

type string:

Microsoft.Devices/IotHubs

Указывает тип источника входных данных, содержащего потоковые данные. Требуется для запросов PUT (CreateOrReplace).

JavaScriptFunctionBinding

Привязка к функции JavaScript.

Имя Тип Описание
properties.script

string

Код JavaScript, содержащий одно определение функции. Например: 'function (x, y) { return x + y; }'

type string:

Microsoft.StreamAnalytics/JavascriptUdf

Указывает тип привязки функции.

JobStorageAccount

Свойства, связанные с учетной записью хранения Azure с MSI

Имя Тип Значение по умолчанию Описание
accountKey

string

Ключ учетной записи для учетной записи хранения Azure. Требуется для запросов PUT (CreateOrReplace).

accountName

string

имя учетной записи хранения Azure. Требуется для запросов PUT (CreateOrReplace).

authenticationMode

AuthenticationMode

ConnectionString

Режим проверки подлинности.

JobType

Описывает тип задания. Допустимые режимы: Cloud и "Edge".

Имя Тип Описание
Cloud

string

Edge

string

JsonOutputSerializationFormat

Указывает формат JSON, в который будут записаны выходные данные. Поддерживаемые в настоящее время значения lineSeparated указывают, что выходные данные будут отформатированы путем разделения каждого объекта JSON новой строкой, а значение array означает, что выходные данные будут отформатированы в виде массива объектов JSON.

Имя Тип Описание
Array

string

LineSeparated

string

JsonSerialization

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные в формате JSON.

Имя Тип Описание
properties.encoding

Encoding

Задает кодировку входящих данных в случае входных данных и кодировку исходящих данных в случае выходных данных. Требуется для запросов PUT (CreateOrReplace).

properties.format

JsonOutputSerializationFormat

Это свойство применяется только к сериализации выходных данных JSON. Она неприменима к входным данным. Это свойство задает формат JSON, в который будут записаны выходные данные. В настоящее время поддерживаются значения lineSeparated, указывающие, что выходные данные будут отформатированы путем разделения каждого объекта JSON новой строкой и массива, указывающего, что выходные данные будут отформатированы в виде массива объектов JSON. Значение по умолчанию — lineSeparated, если оставить значение NULL.

type string:

Json

Указывает тип сериализации, используемой входными или выходными данными. Требуется для запросов PUT (CreateOrReplace).

Output

Выходной объект, содержащий все сведения, связанные с именованным выходным данным. Все выходные данные содержатся в задании потоковой передачи.

Имя Тип Описание
id

string

Идентификатор ресурса

name

string

Имя ресурса

properties.datasource OutputDataSource:

Описывает источник данных, в который будут записываться выходные данные. Требуется для запросов PUT (CreateOrReplace).

properties.diagnostics

Diagnostics

Описывает условия, применимые к входным, выходным данным или к заданию в целом, которые требуют внимания клиента.

properties.etag

string

Текущий тег сущности для выходных данных. Это непрозрачная строка. С его помощью можно определить, изменялся ли ресурс между запросами. Его также можно использовать в заголовках If-Match или If-None-Match для операций записи для оптимистического параллелизма.

properties.serialization Serialization:

Описывает, как сериализуются данные из входных данных или как они сериализуются при записи в выходные данные. Требуется для запросов PUT (CreateOrReplace).

properties.sizeWindow

integer

Окно размера для ограничения выходных данных Stream Analytics.

properties.timeWindow

string

Временной интервал для фильтрации выходных данных заданий Stream Analytics.

type

string

Тип ресурса

OutputErrorPolicy

Указывает политику, применяемую к событиям, которые поступают в выходные данные и не могут быть записаны во внешнее хранилище из-за неправильного формата (значения столбцов отсутствуют, имеют неправильный тип или размер).

Имя Тип Описание
Drop

string

Stop

string

OutputStartMode

Значение может иметь значение JobStartTime, CustomTime или LastOutputEventTime, чтобы указать, должна ли начальная точка потока выходных событий запускаться при каждом запуске задания, начинаться с пользовательской метки времени, указанной с помощью свойства outputStartTime, или с момента последнего времени вывода события.

Имя Тип Описание
CustomTime

string

JobStartTime

string

LastOutputEventTime

string

ParquetSerialization

Описывает, как сериализуются данные из входных данных или как данные сериализуются при записи в выходные данные в формате Parquet.

Имя Тип Описание
type string:

Parquet

Указывает тип сериализации, используемой входными или выходными данными. Требуется для запросов PUT (CreateOrReplace).

PowerBIOutputDataSource

Описывает источник выходных данных Power BI.

Имя Тип Значение по умолчанию Описание
properties.authenticationMode

AuthenticationMode

ConnectionString

Режим проверки подлинности.

properties.dataset

string

Имя набора данных Power BI. Требуется для запросов PUT (CreateOrReplace).

properties.groupId

string

Идентификатор группы Power BI.

properties.groupName

string

Имя группы Power BI. Используйте это свойство, чтобы запомнить, какой идентификатор группы Power BI использовался.

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

Свойства, связанные с входными данными, содержащими ссылочные данные.

Имя Тип Описание
compression

Compression

Описывает, как сжимаются входные данные

datasource ReferenceInputDataSource:

Описывает источник входных данных, содержащий эталонные данные. Требуется для запросов PUT (CreateOrReplace).

diagnostics

Diagnostics

Описывает условия, применимые к входным, выходным данным или к заданию в целом, которые требуют внимания клиента.

etag

string

Текущий тег сущности для входных данных. Это непрозрачная строка. С его помощью можно определить, изменялся ли ресурс между запросами. Его также можно использовать в заголовках If-Match или If-None-Match для операций записи для оптимистического параллелизма.

partitionKey

string

partitionKey Описывает ключ во входных данных, который используется для секционирования входных данных

serialization Serialization:

Описывает, как сериализуются данные из входных данных или как они сериализуются при записи в выходные данные. Требуется для запросов PUT (CreateOrReplace).

type string:

Reference

Указывает, являются ли входные данные источником ссылочных данных или потоковых данных. Требуется для запросов PUT (CreateOrReplace).

RefreshType

Указывает тип параметра обновления данных.

Имя Тип Описание
RefreshPeriodicallyWithDelta

string

RefreshPeriodicallyWithFull

string

Static

string

ScalarFunctionProperties

Свойства, связанные со скалярной функцией.

Имя Тип Описание
etag

string

Текущий тег сущности для функции. Это непрозрачная строка. С его помощью можно определить, изменился ли ресурс между запросами. Его также можно использовать в заголовках If-Match или If-None-Match для операций записи для оптимистического параллелизма.

properties.binding FunctionBinding:

Физическая привязка функции. Например, в случае веб-службы Машинного обучения Azure это описывает конечную точку.

properties.inputs

FunctionInput[]

Описывает один входной параметр функции.

properties.output

FunctionOutput

Описывает выходные данные функции.

type string:

Scalar

Указывает тип функции.

ServiceBusQueueOutputDataSource

Описывает источник выходных данных очереди служебной шины.

Имя Тип Значение по умолчанию Описание
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

Описывает источник выходных данных раздела служебной шины.

Имя Тип Значение по умолчанию Описание
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

Свойства, связанные с номером SKU.

Имя Тип Описание
name

SkuName

Имя номера SKU. Требуется для запросов PUT (CreateOrReplace).

SkuName

Имя номера SKU. Требуется для запросов PUT (CreateOrReplace).

Имя Тип Описание
Standard

string

StorageAccount

Свойства, связанные с учетной записью хранения Azure

Имя Тип Описание
accountKey

string

Ключ учетной записи для учетной записи хранения Azure. Требуется для запросов PUT (CreateOrReplace).

accountName

string

имя учетной записи хранения Azure. Требуется для запросов PUT (CreateOrReplace).

StreamingJob

Объект задания потоковой передачи, содержащий все сведения, связанные с именованным заданием потоковой передачи.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Например: /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

Значение — это метка времени UTC в формате ISO-8601, указывающая, когда было создано задание потоковой передачи.

properties.dataLocale

string

Языковой стандарт данных задания Stream Analytics. Значение должно быть именем поддерживаемого языка и региональных параметров .NET из набора https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Если значение не указано, по умолчанию используется "en-US".

properties.etag

string

Текущий тег сущности для задания потоковой передачи. Это непрозрачная строка. С его помощью можно определить, изменялся ли ресурс между запросами. Его также можно использовать в заголовках If-Match или If-None-Match для операций записи для оптимистического параллелизма.

properties.eventsLateArrivalMaxDelayInSeconds

integer

Максимальная приемлемая задержка в секундах, в течение которой могут быть добавлены события, поступающие с запозданием. Поддерживаемый диапазон — от –1 до 1814399 (20,23:59:59 дней). Значение –1 используется для указания неограниченного времени ожидания. Если свойство не указано, по умолчанию используется значение –1.

properties.eventsOutOfOrderMaxDelayInSeconds

integer

Максимальная приемлемая задержка в секундах, в течение которой события, поступающие не по порядку, могут быть упорядочены.

properties.eventsOutOfOrderPolicy

EventsOutOfOrderPolicy

Указывает политику, применяемую к событиям, которые поступают в потоке входных событий не по порядку.

properties.functions

Function[]

Список одной или нескольких функций для задания потоковой передачи. Свойство name для каждой функции является обязательным при указании этого свойства в запросе PUT. Это свойство нельзя изменить с помощью операции PATCH. Необходимо использовать API PATCH, доступный для отдельного преобразования.

properties.inputs

Input[]

Список из одного или нескольких входных данных для задания потоковой передачи. Свойство name для каждого входного параметра является обязательным при указании этого свойства в запросе PUT. Это свойство нельзя изменить с помощью операции PATCH. Необходимо использовать API PATCH, доступный для отдельных входных данных.

properties.jobId

string

Идентификатор GUID, однозначно определяющий задание потоковой передачи. Этот GUID создается при создании задания потоковой передачи.

properties.jobState

string

Описывает состояние задания потоковой передачи.

properties.jobStorageAccount

JobStorageAccount

Свойства, связанные с учетной записью хранения Azure с MSI

properties.jobType

JobType

Описывает тип задания. Допустимые режимы: Cloud и "Edge".

properties.lastOutputEventTime

string

Значение — это метка времени в формате ISO-8601, указывающая время последнего выходного события задания потоковой передачи, или значение NULL, указывающее, что выходные данные еще не созданы. В случае нескольких выходных данных или нескольких потоков отображается последнее значение в этом наборе.

properties.outputErrorPolicy

OutputErrorPolicy

Указывает политику, применяемую к событиям, которые поступают в выходные данные и не могут быть записаны во внешнее хранилище из-за неправильного формата (значения столбцов отсутствуют, имеют неправильный тип или размер).

properties.outputStartMode

OutputStartMode

Это свойство следует использовать только в том случае, если требуется, чтобы задание было запущено сразу после создания. Значение может иметь значение JobStartTime, CustomTime или LastOutputEventTime, чтобы указать, должна ли начальная точка потока выходных событий запускаться при каждом запуске задания, начинаться с пользовательской метки времени, указанной с помощью свойства outputStartTime, или с момента последнего времени вывода события.

properties.outputStartTime

string

Значением является либо метка времени в формате ISO-8601, указывающая начальную точку выходного потока событий, или значение NULL, указывающее, что выходной поток событий запускает при каждом запуске задания потоковой передачи. Это свойство должно иметь значение , если для параметра outputStartMode задано значение CustomTime.

properties.outputs

Output[]

Список из одного или нескольких выходных данных для задания потоковой передачи. Свойство name для каждого выходных данных является обязательным при указании этого свойства в запросе PUT. Это свойство нельзя изменить с помощью операции PATCH. Необходимо использовать API PATCH, доступный для отдельных выходных данных.

properties.provisioningState

string

Описывает состояние подготовки задания потоковой передачи.

properties.sku

Sku

Описывает номер SKU задания потоковой передачи. Требуется для запросов PUT (CreateOrReplace).

properties.transformation

Transformation

Указывает запрос и количество единиц потоковой передачи, используемых для задания потоковой передачи. Свойство name преобразования является обязательным при указании этого свойства в запросе PUT. Это свойство нельзя изменить с помощью операции PATCH. Необходимо использовать API PATCH, доступный для отдельного преобразования.

tags

object

Теги ресурсов.

type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

StreamInputProperties

Свойства, связанные с входными данными, содержащими потоковые данные.

Имя Тип Описание
compression

Compression

Описывает, как сжимаются входные данные

datasource StreamInputDataSource:

Описывает источник входных данных, содержащий потоковые данные. Требуется для запросов PUT (CreateOrReplace).

diagnostics

Diagnostics

Описывает условия, применимые к входным, выходным данным или к заданию в целом, которые требуют внимания клиента.

etag

string

Текущий тег сущности для входных данных. Это непрозрачная строка. С его помощью можно определить, изменялся ли ресурс между запросами. Его также можно использовать в заголовках If-Match или If-None-Match для операций записи для оптимистического параллелизма.

partitionKey

string

partitionKey Описывает ключ во входных данных, который используется для секционирования входных данных

serialization Serialization:

Описывает, как сериализуются данные из входных данных или как они сериализуются при записи в выходные данные. Требуется для запросов PUT (CreateOrReplace).

type string:

Stream

Указывает, являются ли входные данные источником ссылочных данных или потоковых данных. Требуется для запросов PUT (CreateOrReplace).

Transformation

Объект преобразования, содержащий все сведения, связанные с именованным преобразованием. Все преобразования содержатся в задании потоковой передачи.

Имя Тип Значение по умолчанию Описание
id

string

Идентификатор ресурса

name

string

Имя ресурса

properties.etag

string

Текущий тег сущности для преобразования. Это непрозрачная строка. С его помощью можно определить, изменялся ли ресурс между запросами. Его также можно использовать в заголовках If-Match или If-None-Match для операций записи для оптимистического параллелизма.

properties.query

string

Указывает запрос, который будет выполняться в задании потоковой передачи. Дополнительные сведения о языке запросов Stream Analytics (SAQL) см. здесь: https://msdn.microsoft.com/library/azure/dn834998 . Требуется для запросов PUT (CreateOrReplace).

properties.streamingUnits

integer

3

Число единиц потоковой передачи, используемых заданием потоковой передачи.

properties.validStreamingUnits

integer[]

Указывает допустимые единицы потоковой передачи, до которые может масштабироваться задание потоковой передачи.

type

string

Тип ресурса