Outputs - Update

  • Ссылка
Service:
Stream Analytics
API Version:
2020-03-01

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

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

Параметры URI

Имя В Обязательно Тип Описание
jobName
 path True

string

Имя задания потоковой передачи.
outputName
 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, чтобы предотвратить случайную перезапись параллельных изменений.

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

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

string

Имя ресурса
properties.datasource OutputDataSource:

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

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

integer

Окно размера, ограничивающее выходные данные Stream Analytics.
properties.timeWindow

string

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

Ответы

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

Output

Выходные данные успешно обновлены.

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 олицетворения учетной записи пользователя

Примеры

Update a blob output with CSV serialization
Update a DocumentDB output
Update a Power BI output
Update a Service Bus Queue output with Avro serialization
Update a Service Bus Topic output with CSV serialization
Update an Azure Data Lake Store output with JSON serialization
Update an Azure Data Warehouse output
Update an Azure Function output
Update an Azure SQL database output
Update an Azure Table output
Update an Event Hub output with JSON serialization

Update a blob output with CSV serialization

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg5023/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Blob",
      "properties": {
        "container": "differentContainer"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": "|",
        "encoding": "UTF8"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: 3a1b2023-79a9-4b33-93e8-f49fc3e573fe
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5023/providers/Microsoft.StreamAnalytics/streamingjobs/sj900/outputs/output1623",
  "name": "output1623",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Blob",
      "properties": {
        "storageAccounts": [
          {
            "accountName": "someAccountName"
          }
        ],
        "container": "differentContainer",
        "pathPattern": "{date}/{time}",
        "dateFormat": "yyyy/MM/dd",
        "timeFormat": "HH"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": "|",
        "encoding": "UTF8"
      }
    }
  }
}

Update a DocumentDB output

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/DocumentDB",
      "properties": {
        "partitionKey": "differentPartitionKey"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: 7849c132-e995-4631-91c3-931606eec432
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022",
  "name": "output3022",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/DocumentDB",
      "properties": {
        "accountId": "someAccountId",
        "database": "db01",
        "collectionNamePattern": "collection",
        "partitionKey": "differentPartitionKey",
        "documentId": "documentId"
      }
    }
  }
}

Update a Power BI output

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "PowerBI",
      "properties": {
        "dataset": "differentDataset"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: 7849c132-e995-4631-91c3-931606eec432
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg7983/providers/Microsoft.StreamAnalytics/streamingjobs/sj2331/outputs/output3022",
  "name": "output3022",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "PowerBI",
      "properties": {
        "dataset": "differentDataset",
        "table": "someTable",
        "tokenUserPrincipalName": "bobsmith@contoso.com",
        "tokenUserDisplayName": "Bob Smith",
        "groupId": "ac40305e-3e8d-43ac-8161-c33799f43e95",
        "groupName": "MyPowerBIGroup"
      }
    }
  }
}

Update a Service Bus Queue output with Avro serialization

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg3410/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Queue",
      "properties": {
        "queueName": "differentQueueName"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "LineSeparated"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: 429adaec-a777-4750-8a39-8d0c931d801c
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg3410/providers/Microsoft.StreamAnalytics/streamingjobs/sj5095/outputs/output3456",
  "name": "output3456",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Queue",
      "properties": {
        "queueName": "differentQueueName",
        "propertyColumns": [
          "column1",
          "column2"
        ],
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "LineSeparated"
      }
    }
  }
}

Update a Service Bus Topic output with CSV serialization

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6450/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Topic",
      "properties": {
        "topicName": "differentTopicName"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": "|",
        "encoding": "UTF8"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: c1c2007f-45b2-419a-ae7d-4d2148998460
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6450/providers/Microsoft.StreamAnalytics/streamingjobs/sj7094/outputs/output7886",
  "name": "output7886",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/Topic",
      "properties": {
        "topicName": "differentTopicName",
        "propertyColumns": [
          "column1",
          "column2"
        ],
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Csv",
      "properties": {
        "fieldDelimiter": "|",
        "encoding": "UTF8"
      }
    }
  }
}

Update an Azure Data Lake Store output with JSON serialization

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.DataLake/Accounts",
      "properties": {
        "accountName": "differentaccount"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "LineSeparated"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: 5020de6b-5bb3-4b88-8606-f11fb3c46185
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195",
  "name": "output5195",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.DataLake/Accounts",
      "properties": {
        "accountName": "differentaccount",
        "tenantId": "cea4e98b-c798-49e7-8c40-4a2b3beb47dd",
        "tokenUserPrincipalName": "bobsmith@contoso.com",
        "tokenUserDisplayName": "Bob Smith",
        "filePathPrefix": "{date}/{time}",
        "dateFormat": "yyyy/MM/dd",
        "timeFormat": "HH"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "LineSeparated"
      }
    }
  }
}

Update an Azure Data Warehouse output

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/dwOutput?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/Database",
      "properties": {
        "table": "differentTable"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: f489d6f3-fcd5-4bcb-b642-81e987ee16d6
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/dwOutput",
  "name": "dwOutput",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/DataWarehouse",
      "properties": {
        "table": "differentTable",
        "server": "asatestserver",
        "database": "zhayaSQLpool",
        "user": "tolladmin"
      }
    }
  }
}

Update an Azure Function output

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/azureFunction1?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.AzureFunction",
      "properties": {
        "functionName": "differentFunctionName"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: f489d6f3-fcd5-4bcb-b642-81e987ee16d6
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/streamingjobs/sjName/outputs/azureFunction1",
  "name": "azureFunction1",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.AzureFunction",
      "properties": {
        "functionAppName": "functionappforasaautomation",
        "functionName": "differentFunctionName",
        "apiKey": null,
        "maxBatchSize": 256,
        "maxBatchCount": 100
      }
    }
  }
}

Update an Azure SQL database output

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/Database",
      "properties": {
        "table": "differentTable"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: f489d6f3-fcd5-4bcb-b642-81e987ee16d6
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg2157/providers/Microsoft.StreamAnalytics/streamingjobs/sj6458/outputs/output1755",
  "name": "output1755",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Sql/Server/Database",
      "properties": {
        "server": "someServer",
        "database": "someDatabase",
        "table": "differentTable",
        "user": "someUser"
      }
    }
  }
}

Update an Azure Table output

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg5176/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Table",
      "properties": {
        "partitionKey": "differentPartitionKey"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: ea1d20bf-6cb3-40bc-bc7b-ec3a7fd5977e
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg5176/providers/Microsoft.StreamAnalytics/streamingjobs/sj2790/outputs/output958",
  "name": "output958",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.Storage/Table",
      "properties": {
        "accountName": "someAccountName",
        "table": "samples",
        "partitionKey": "differentPartitionKey",
        "rowKey": "rowKey",
        "columnsToRemove": [
          "column1",
          "column2"
        ],
        "batchSize": 25
      }
    }
  }
}

Update an Event Hub output with JSON serialization

Sample Request

PATCH https://management.azure.com/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourcegroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195?api-version=2020-03-01

{
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/EventHub",
      "properties": {
        "partitionKey": "differentPartitionKey"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "LineSeparated"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: 5020de6b-5bb3-4b88-8606-f11fb3c46185
Response Body
{
  "id": "/subscriptions/56b5e0a9-b645-407d-99b0-c64f86013e3d/resourceGroups/sjrg6912/providers/Microsoft.StreamAnalytics/streamingjobs/sj3310/outputs/output5195",
  "name": "output5195",
  "type": "Microsoft.StreamAnalytics/streamingjobs/outputs",
  "properties": {
    "datasource": {
      "type": "Microsoft.ServiceBus/EventHub",
      "properties": {
        "eventHubName": "sdkeventhub",
        "partitionKey": "differentPartitionKey",
        "serviceBusNamespace": "sdktest",
        "sharedAccessPolicyName": "RootManageSharedAccessKey"
      }
    },
    "serialization": {
      "type": "Json",
      "properties": {
        "encoding": "UTF8",
        "format": "LineSeparated"
      }
    }
  }
}

Определения

Имя Описание
AuthenticationMode

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

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

Описывает выходной источник данных Azure Data Lake Store.
AzureFunctionOutputDataSource

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

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

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

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

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

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

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

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

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

Задает кодировку входящих данных в случае входных данных и кодировку исходящих данных в случае выходных данных.
Error

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

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

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

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

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

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

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

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

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

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

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

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

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

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).

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, содержащего базу данных 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).

AzureSynapseOutputDataSource

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

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

string

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

string

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

string

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

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).

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).

EventSerializationType

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

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

string

Csv

string

Json

string

Parquet

string

GatewayMessageBusOutputDataSource

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

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

string

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

GatewayMessageBus

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

JsonOutputSerializationFormat

Указывает формат JSON, в котором будут записаны выходные данные. В настоящее время поддерживаются значения lineSeparated, указывающие, что выходные данные будут отформатированы путем разделения каждого объекта JSON новой строкой и массива, указывающего, что выходные данные будут отформатированы в виде массива объектов 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

Тип ресурса

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).

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).

StorageAccount

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

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

string

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

string

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