В этой статье приводится разбивка структуры определения для элементов конвейера данных.
Части определения
| Путь к части определения |
type |
Обязательно |
Description |
pipeline-content.json |
ContentDetails (JSON) |
true |
Описание содержимого конвейера данных полезных данных |
.platform |
PlatformDetails (JSON) |
false |
Описание общих сведений об элементе |
ContentDetails
Описание содержимого полезных данных
Описание содержимого DataPipelineProperties
Описание полей, используемых для создания DataPipelineProperties
| Имя |
Тип |
Обязательно |
Description |
| activities |
DataPipelineActivity[] |
false |
Список действий. |
| описание |
String |
false |
Описание конвейера данных |
Описание содержимого DataPipelineActivity
Значения ActivityState
| Имя |
Тип |
Description |
| Active |
String |
Состояние действия по умолчанию. |
| Неактивный |
String |
Помечает действие как неактивное и пропускает выполнение. |
Значения OnInactiveMarkAs
| Имя |
Тип |
Description |
| Succeeded |
String |
Значение по умолчанию. |
| Неудача |
String |
Всегда помечайте неактивное действие как неудачное. |
| Пропущено |
String |
Неактивное действие пропускается. |
Описание содержимого DependencyActivity
| Имя |
Тип |
Обязательно |
Description |
| активность |
String |
true |
Имя действия |
| dependencyConditions |
Условия |
true |
Список условий зависимостей. |
Описание содержимого условий
| Имя |
Тип |
| Succeeded |
String |
| Неудача |
String |
| Пропущено |
String |
| Завершено |
String |
Политика действий
Политика выполнения для действия.
| Имя |
Тип |
Обязательно |
Description |
| timeout |
Строка (или выражение с строкой resultType) |
false |
Указывает тайм-аут выполнения действия. Время ожидания по умолчанию — 7 дней. |
| retry |
целое число (или выражение с целым числом resultType) |
false |
Максимальное число обычных попыток повторных попыток. Значение по умолчанию — 0. Минимум: 0. |
| retryIntervalInSeconds |
Целое число |
false |
Интервал между каждой попыткой повтора (в секундах). Значение по умолчанию — 30 с. Минимум: 30, максимум: 86400. |
| secureInput |
Boolean |
false |
Если задано значение true, входные данные из действия считаются безопасными и не будут регистрироваться для мониторинга. |
| secureOutput |
Boolean |
false |
Если задано значение true, выходные данные из действия считаются безопасными и не будут регистрироваться для мониторинга. |
Внешние ссылки
Внешние ссылки на подключение.
| Имя |
Тип |
Обязательно |
Description |
| connection |
String (GUID) |
true |
Идентификатор соединения, на который ссылается соединение. |
DataPipelineActivityTypes
| Имя |
Description |
|
Copy |
Действие копирования, копирующий данные из источника в место назначения |
|
AzureHDInsight |
Выполняет различные программы (Hive, Pig, MapReduce, Streaming, Spark) в кластере Azure HDInsight |
|
SparkJobDefinition |
Выполняет определение задания Spark |
|
InvokeCopyJob |
Вызывает действие задания копирования |
|
ExecuteSSISPackage |
Выполняет пакет служб SQL Server Integration Services (SSIS) |
|
SqlServerStoredProcedure |
Выполняет хранимую процедуру в SQL Server |
|
InvokePipeline |
Вызывает другой конвейер (не рекомендуется, используйте ExecutePipeline) |
|
ExecutePipeline |
Выполняет другой конвейер как вложенное действие |
|
Удалить |
Удаляет данные из источника данных |
|
KustoQueryLanguage |
Выполняет запрос KQL в Azure Data Explorer |
|
Подстановка |
Извлекает данные из источника данных для использования в последующих действиях |
|
WebActivity |
Делает HTTP-запросы внешним веб-службам |
|
GetMetadata |
Извлекает сведения о метаданных из источника данных |
|
IfCondition |
Выполняет действия на основе условного выражения |
|
Switch |
Выполняет различные действия на основе выражения коммутатора |
|
ForEach |
Выполняет итерацию по коллекции и выполняет действия для каждого элемента. |
|
AzureMLExecutePipeline |
Выполняет операции машинного обучения Azure (пакетное выполнение, обновление ресурса, выполнение конвейера) |
|
DataLakeAnalyticsScope |
Запуск скрипта области в Azure Data Lake Analytics |
|
Ожидание |
Приостановка выполнения конвейера в течение указанной длительности |
|
Fail |
Явно завершается сбоем конвейера с указанным сообщением об ошибке |
|
До |
Повторяет действия до тех пор, пока не будет выполнено условие |
|
Фильтр |
Фильтрует массив на основе предоставленного условия |
|
TridentNotebook |
Выполняет записную книжку Trident |
|
DatabricksNotebook |
Выполняет операции Databricks (записная книжка, Spark JAR, Spark Python) |
|
SetVariable |
Задает значение существующей переменной |
|
ДобавлениеVariable |
Добавляет значение в существующую переменную массива |
|
AzureFunction |
Выполняет функцию Azure |
|
Настройка |
Пакетная служба Azure— выполняет настраиваемое действие с помощью определяемой пользователем команды |
|
Веб-перехватчик |
Вызывает веб-перехватчик и ожидает обратного вызова |
|
RefreshDataFlow |
Обновление потока данных |
|
Скрипт |
Выполняет пользовательские скрипты (PowerShell, Python и т. д.) |
|
Office365Email |
Отправляет сообщение электронной почты с помощью Office 365 |
|
Эл. почта |
Отправляет уведомление по электронной почте |
|
MicrosoftTeams |
Отправляет сообщение в Microsoft Teams |
|
Рабочие группы |
Отправляет сообщение в Teams |
|
PBISemanticModelRefresh |
Обновление семантической модели Power BI |
Свойства действия
Поле typeProperties в каждом действии содержит конфигурацию, зависящую от типа действия. В этом разделе описываются свойства, необходимые для каждого типа действий.
Свойства действия ожидания
Свойства для действий с type: "Wait".
Свойства типа действия ожидания
| Имя |
Тип |
Обязательно |
Description |
| waitTimeInSeconds |
Целое число |
true |
Количество секунд, ожидаемых перед переходом к следующему действию |
Свойства действия копирования
Свойства для действий с type: "Copy".
Свойства типа действия копирования
| Имя |
Тип |
Обязательно |
Description |
| source |
CopySource |
true |
Параметры источника для операции копирования |
| тонуть |
CopySink |
false |
Параметры приемника для операции копирования |
| destination |
CopySink |
false |
Назначение действия копирования |
| translator |
Object |
false |
Переводчик действий копирования. Если не указано, используется табличный переводчик |
| enableStaging |
Boolean |
false |
Указывает, следует ли копировать данные с помощью промежуточной промежуточной настройки. Значение по умолчанию равно false |
| stagingSettings |
StagingSettings |
false |
Указывает промежуточные промежуточные параметры, если enableStaging имеет значение true |
| scriptLines |
String[] |
false |
Строки скриптов потока данных, используемые при копировании в качестве потока данных |
| посетитель |
String |
false |
Имя вызывающего объекта, используемого в телеметрии ADMS |
| linkedIntegrationRuntime |
Object |
false |
Ссылка на связанную среду выполнения интеграции в подключенной фабрике данных |
| parallelCopies |
Целое число |
false |
Максимальное количество одновременных сеансов, открытых в источнике или приемнике, чтобы избежать перегрузки хранилища данных. Минимум: 0 |
| dataIntegrationUnits |
Целое число |
false |
Максимальное количество единиц интеграции данных, которые можно использовать для выполнения этого перемещения данных. Минимум: 0 |
| пропускная способностьOptimizationUnits |
Целое число |
false |
Максимальное количество единиц оптимизации пропускной способности, которые можно использовать для выполнения этого перемещения данных. Минимум: 0 |
| enableSkipIncompatibleRow |
Boolean |
false |
Следует ли пропускать несовместимую строку. Значение по умолчанию равно false |
| redirectIncompatibleRowSettings |
Object |
false |
Перенаправление несовместимых параметров строк, если EnableSkipIncompatibleRow имеет значение true |
| logStorageSettings |
Object |
false |
Параметры хранилища журналов, необходимые клиенту при включении журнала сеансов |
| logSettings |
Object |
false |
Параметры журнала, необходимые клиенту при включении журнала |
| preserveRules |
String[] |
false |
Сохранение правил. |
| preserve |
String[] |
false |
Сохранение правил. |
| resumeId |
String |
false |
Значение resumeId для включения возобновления копирования |
| validateDataConsistency |
Boolean |
false |
Включение проверки согласованности данных |
| skipErrorFile |
Object |
false |
Указание отказоустойчивости для согласованности данных |
CopySource
| Имя |
Тип |
Обязательно |
Description |
| type |
String |
true |
Тип источника копирования |
| sourceRetryCount |
Целое число |
false |
Число повторных попыток источника. |
| sourceRetryWait |
String |
false |
Ожидание повторных попыток источника. |
| maxConcurrentConnections |
Целое число |
false |
Максимальное число одновременных подключений для исходного хранилища данных. |
| disableMetricsCollection |
Boolean |
false |
Если значение true, отключите коллекцию метрик хранилища данных. По умолчанию — false. |
| datasetSettings |
Наборы данных |
false |
Удаление параметров набора данных действий |
| контрольная точкаProperties |
Object |
false |
Свойства контрольной точки |
| genericChangeDataProperties |
Object |
false |
Свойства универсального отслеживания измененных данных |
CopySink
| Имя |
Тип |
Обязательно |
Description |
| type |
String |
true |
Тип приемника копирования. |
| writeBatchSize (размер батча записи) |
Целое число |
false |
Размер пакета записи, минимальный: 0. |
| writeBatchTimeout |
String |
false |
Запись времени ожидания пакетной службы. |
| sinkRetryCount |
Целое число |
false |
Число повторных попыток приемника. |
| sinkRetryWait |
String |
false |
Ожидание повтора приемника. |
| maxConcurrentConnections |
Целое число |
false |
Максимальное число одновременных подключений для хранилища данных приемника. |
| disableMetricsCollection |
Boolean |
false |
Если значение true, отключите коллекцию метрик хранилища данных. По умолчанию — false. |
| datasetSettings |
Наборы данных |
false |
Параметры набора данных |
CopyTranslator
| Имя |
Тип |
Обязательно |
Description |
| type |
String |
true |
Тип переводчика (например, TabularTranslator) |
| typeConversion |
Boolean |
false |
Следует ли включить свойство преобразования расширенных типов для действия копирования. |
| typeConversionSettings |
TypeConversionSettings |
false |
Параметры преобразования типов. |
| columnMappings |
String |
false |
Сопоставления столбцов. |
| schemaMapping |
String |
false |
Сопоставление схемы для сопоставления между табличными данными и иерархическими данными. |
| mappings |
String |
false |
Сопоставления столбцов с логическими типами. |
| columnFlatteningSettings |
Object |
false |
Параметры неструктурированного столбца. |
TypeConversionSettings
| Имя |
Тип |
Обязательно |
Description |
| allowDataTruncation |
Boolean |
false |
Следует ли разрешать усечение данных при преобразовании данных. |
| treatBooleanAsNumber |
Boolean |
false |
Следует ли рассматривать логические значения как числа. |
| dateTimeFormat |
String |
false |
Формат значений DateTime. |
| dateTimeOffsetFormat |
String |
false |
Формат значений DateTimeOffset. |
| timeSpanFormat |
String |
false |
Формат значений TimeSpan. |
| Культура |
String |
false |
Язык и региональные параметры, используемые для преобразования данных из строки или в строку. |
StagingSettings
| Имя |
Тип |
Обязательно |
Description |
| enableCompression |
Boolean |
false |
Указывает, следует ли использовать сжатие при копировании данных с помощью промежуточной промежуточной настройки. |
| путь |
String |
false |
Путь к промежуточным данным |
| внешниеСсылки |
ExternalReferences |
true |
Внешние ссылки на подключение. |
Наборы данных
| Имя |
Тип |
Обязательно |
Description |
| type |
String |
true |
Тип набора данных |
| описание |
String |
false |
Описание набора данных |
| structure |
Object |
false |
Столбцы, определяющие структуру набора данных. Тип: массив (или выражение с массивом resultType), itemType: DatasetDataElement |
| schema |
Object |
false |
Столбцы, определяющие схему физического типа набора данных. Тип: массив (или выражение с массивом resultType), itemType: DatasetSchemaDataElement |
| copyJobProperties |
Object |
false |
Дополнительные свойства в наборе данных для конвейеров системы CopyJob |
| connectionProperties |
Object |
false |
Параметры параметра connectionProperties. Тип: пары ключевых значений (значение должно быть строковым типом) (или Expression с объектом resultType) |
| внешниеСсылки |
ExternalReferences |
false |
Внешние ссылки на подключение |
| linkedServiceName |
Object |
false |
Справочник по связанной службе |
| linkedService |
Object |
false |
Связанная служба |
| connectionSettings |
Object |
false |
Параметры подключения |
| parameters |
Object |
false |
Параметры для набора данных |
| аннотации |
Массив |
false |
Список тегов, которые можно использовать для описания набора данных |
| folder |
Object |
false |
Папка, в которую находится этот набор данных. Если он не указан, набор данных будет отображаться на корневом уровне |
Свойства действия подстановки
Свойства для действий с type: "Lookup".
Свойства типа действия подстановки
| Имя |
Тип |
Обязательно |
Description |
| source |
CopySource |
true |
Параметры источника для операции подстановки |
| datasetSettings |
Наборы данных |
true |
Справочник по набору данных для подстановки |
| firstRowOnly |
Boolean |
false |
Возвращается ли только первая строка (по умолчанию: true) |
Свойства веб-действий
Свойства для действий с type: "WebActivity".
Свойства типа веб-действия
| Имя |
Тип |
Обязательно |
Description |
| relativeUrl |
String |
true |
URL-адрес для вызова |
| method |
String |
true |
Метод HTTP (GET, POST, PUT, DELETE) |
| headers |
String |
false |
Заголовки HTTP |
| body |
String |
false |
Текст запроса (для запросов POST/PUT) |
| disableCertValidation |
Boolean |
false |
Если задано значение true, проверка сертификата будет отключена. |
| httpRequestTimeout |
String |
false |
Время ожидания запроса. Формат находится в интервале времени (чч:мм:сс) |
| turnOffAsync |
Boolean |
false |
Если задано значение true, останавливает вызов HTTP GET в http-расположении, заданном в заголовке ответа. |
Если свойства действия условия
Свойства для действий с type: "IfCondition".
Если свойства типа действия условия
| Имя |
Тип |
Обязательно |
Description |
| expression |
Выражение |
true |
Логическое выражение для вычисления |
| ifTrueActivities |
DataPipelineActivity[] |
false |
Действия для выполнения, если условие имеет значение true |
| ifFalseActivities |
DataPipelineActivity[] |
false |
Действия для выполнения, если условие равно false |
Expression
| Имя |
Тип |
Обязательно |
Description |
| type |
String |
true |
Тип выражения (например, "Выражение") |
| value |
String |
true |
Значение выражения |
Свойства действия ForEach
Свойства для действий с type: "ForEach".
Свойства типа действия ForEach
| Имя |
Тип |
Обязательно |
Description |
| items |
Выражение |
true |
Выражение, возвращающее массив для итерации |
| activities |
DataPipelineActivity[] |
true |
Действия, выполняемые для каждого элемента |
| isSequential |
Boolean |
false |
Следует ли выполнять итерации последовательно (по умолчанию: false) |
| batchCount |
Целое число |
false |
Число одновременных итераций (если isSequential имеет значение false) |
Выполнение свойств действия конвейера
Свойства для действий с type: "ExecutePipeline".
Свойства типа действия "Выполнение конвейера"
| Имя |
Тип |
Обязательно |
Description |
| pipeline |
PipelineReference |
true |
Ссылка на конвейер для выполнения |
| parameters |
объект |
false |
Параметры для передачи дочернему конвейеру |
| waitOnCompletion |
Boolean |
false |
Ожидается ли завершение дочернего конвейера (по умолчанию: true) |
PipelineReference
| Имя |
Тип |
Обязательно |
Description |
| referenceName |
String |
true |
Имя указанного конвейера |
| type |
String |
true |
Ссылочный тип (обычно "PipelineReference") |
Свойства действия fail
Свойства для действий с type: "Fail".
Свойства типа действия fail
| Имя |
Тип |
Обязательно |
Description |
| сообщение |
String |
true |
Сообщение об ошибке, которое появилось в действии fail. Это может быть динамическое содержимое, которое оценивается как непустая или пустая строка во время выполнения. |
| Код ошибки |
String |
true |
Код ошибки, который классифицирует тип ошибки действия Fail. Это может быть динамическое содержимое, которое оценивается как непустая или пустая строка во время выполнения. |
Свойства действия фильтра
Свойства для действий с type: "Filter".
Свойства типа действия фильтра
| Имя |
Тип |
Обязательно |
Description |
| items |
Выражение |
true |
Входной массив, к которому должен применяться фильтр. |
| condition |
Выражение |
true |
Условие, которое можно использовать для фильтрации входных данных. |
Пока свойства действия не будут
Свойства для действий с type: "Until".
Пока свойства типа действия
| Имя |
Тип |
Обязательно |
Description |
| expression |
Выражение |
true |
Выражение, которое будет оцениваться логическим. Цикл будет продолжаться до тех пор, пока это выражение не будет равно true. |
| activities |
DataPipelineActivity[] |
true |
Список действий для выполнения. |
| timeout |
Строка (или выражение с строкой resultType) |
false |
Указывает тайм-аут выполнения действия. Если не указано значение, оно принимает значение TimeSpan.FromDays(7), которое составляет 1 неделю по умолчанию. |
Переключение свойств действия
Свойства для действий с type: "Switch".
Свойства типа действия switch
| Имя |
Тип |
Обязательно |
Description |
| on |
Выражение |
true |
Выражение, которое будет оцениваться строкой или целым числом. Это используется для определения блока действий в случаях, которые будут выполняться. |
| cases |
SwitchCase[] |
false |
Список вариантов, соответствующих ожидаемым значениям свойства on. Это необязательное свойство, если оно не указано, действие будет выполнять действия, предоставляемые в defaultActivities. |
| defaultActivities |
DataPipelineActivity[] |
false |
Список действий для выполнения, если условие дела не удовлетворяется. Это необязательное свойство, и если оно не указано, действие завершится без каких-либо действий. |
SwitchCase
| Имя |
Тип |
Обязательно |
Description |
| value |
String |
true |
Ожидаемое значение результата выражения, используемого для выбора регистра. |
| activities |
DataPipelineActivity[] |
true |
Список действий, выполняемых для соответствующего случая. |
Свойства для действий с type: "GetMetadata".
| Имя |
Тип |
Обязательно |
Description |
| datasetSettings |
Object |
true |
Параметры набора данных действия GetMetadata. |
| fieldList |
String[] |
false |
Поля метаданных для получения из набора данных. Тип: строка (или выражение с строкой resultType). |
| storeSettings |
Object |
false |
Параметры хранилища действий GetMetadata. |
| formatSettings |
Object |
false |
Параметры формата действия GetMetadata. |
Свойства действия SetVariable
Свойства для действий с type: "SetVariable".
Свойства типа действия SetVariable
| Имя |
Тип |
Обязательно |
Description |
| variableName |
String |
true |
Имя переменной, значение которой необходимо задать. |
| value |
Object |
true |
Значение, которое нужно задать. Может быть статическим значением или выражением. |
| setSystemVariable |
Boolean |
false |
Если задано значение true, он задает возвращаемое значение выполнения конвейера. |
| Имя |
Тип |
Обязательно |
Description |
| secureInput |
Boolean |
false |
Если задано значение true, входные данные из действия считаются безопасными и не будут регистрироваться для мониторинга. |
| secureOutput |
Object |
false |
Если задано значение true, выходные данные из действия считаются безопасными и не будут регистрироваться для мониторинга. |
Свойства действия AppendVariable
Свойства для действий с type: "AppendVariable".
Свойства типа действия AppendVariable
| Имя |
Тип |
Обязательно |
Description |
| variableName |
String |
true |
Имя переменной, к которой необходимо добавить значение. |
| value |
Object |
true |
Добавляемое значение. Может быть статическим значением или выражением. |
Удаление свойств действия
Свойства для действий с type: "Delete".
Удаление свойств типа действия
| Имя |
Тип |
Обязательно |
Description |
| datasetSettings |
Object |
true |
Удаление параметров набора данных действий. |
| recursive |
Boolean |
false |
Если значение true, файлы или вложенные папки в текущем пути к папке будут удалены рекурсивно. По умолчанию — false. |
| maxConcurrentConnections |
Целое число |
false |
Максимальное число одновременных подключений для подключения источника данных одновременно. Минимум: 1. |
| enableLogging |
Boolean |
false |
Следует ли записывать подробные журналы выполнения действия удаления. По умолчанию используется значение false. |
| logStorageSettings |
Object |
false |
Параметры хранилища журналов, необходимые клиенту, если включитьLogging имеет значение true. |
| storeSettings |
Object |
false |
Удаление параметров хранилища действий. |
Свойства действия AzureHDInsight
Свойства для действий с type: "AzureHDInsight".
Свойства типа действия AzureHDInsight
| Имя |
Тип |
Обязательно |
Description |
| hdiActivityType |
String |
true |
Подтип, указывающий один из пяти типов действий HDInsight (Hive, Pig, MapReduce, Streaming, Spark). |
| arguments |
String[] |
false |
Указанные пользователем аргументы для действия HDInsight. |
| getDebugInfo |
String |
false |
Параметр "Отладка сведений". Допустимые значения: "None", "Always", "Failure" |
| scriptSettings |
HDInsightScriptSettings |
false |
Параметры скрипта HDInsight |
| defines |
Object |
false |
Позволяет пользователю указывать определения для запроса задания. Тип: пары "ключевое значение" (или "Выражение" с объектом resultType) |
| variables |
Object[] |
false |
Указанные пользователем аргументы в пространстве имен переменной. Тип: массив строк (или выражение с массивом resultType) |
| время ожидания запроса |
Целое число |
false |
Значение времени ожидания запроса (в минутах). Действует, если кластер HDInsight работает с ESP (корпоративный пакет безопасности) |
HDInsightScriptSettings
| Имя |
Тип |
Обязательно |
Description |
| scriptPath |
Object |
false |
Путь к скрипту. Тип: строка (или выражение с строкой resultType) |
| внешниеСсылки |
Object |
true |
Внешние ссылки на подключение |
Свойства действия SparkJobDefinition
Свойства для действий с type: "SparkJobDefinition".
Свойства типа действия SparkJobDefinition
| Имя |
Тип |
Обязательно |
Description |
| sparkJobDefinitionId |
String |
true |
Идентификатор определения задания Spark. |
| workspaceId |
String |
true |
Идентификатор рабочей области. |
| исполняемый файл |
String |
false |
Файл определения основного объекта. |
| mainClass |
String |
false |
Имя основного класса, если jar-файл задан для исполняемого файла. |
| additionalLibraryUris |
String |
false |
Пути ADLS 2-го поколения для ссылочных файлов. |
| commandLineАргументы |
String |
false |
Аргументы командной строки. |
| defaultLakehouse |
FabricArtifact |
false |
Ссылка на Lakehouse, которая должна быть контекстом Lakehouse по умолчанию |
| additionalLakehouses |
String |
false |
Список дополнительных ссылок на Lakehouse. |
| environmentId |
String |
false |
Артефакт среды, который следует использовать для настройки выполнения, среда должна поступать из той же рабочей области, что и артефакт SJD. |
FabricArtifact
| Имя |
Тип |
Обязательно |
Description |
| workspaceId |
Object |
true |
Идентификатор рабочей области. Тип: строка (или выражение с строкой resultType) |
| artifactId |
Object |
true |
Идентификатор артефакта. Тип: строка (или выражение с строкой resultType) |
Свойства действия скрипта
Свойства для действий с type: "Script".
Свойства типа действия скрипта
| Имя |
Тип |
Обязательно |
Description |
| база данных |
Object |
true |
База данных, в которой будет выполняться скрипт |
| Сценарии |
Object |
true |
Массив блоков скриптов |
| logSettings |
Object |
false |
Параметры журнала действия скрипта |
| scriptBlockExecutionTimeout |
String |
false |
Время ожидания выполнения ScriptBlock |
| connectionVersion |
String |
false |
Версия подключения |
Свойства действия WebHook
Свойства для действий с type: "WebHook".
Свойства типа действия WebHook
| Имя |
Тип |
Обязательно |
Description |
| method |
String |
true |
Метод REST API для конечной точки |
| relativeUrl |
String |
true |
Относительный URL-адрес конечной точки |
| timeout |
String |
false |
Время ожидания, в течение которого должен вызываться веб-перехватчик. Если не указано значение, значение по умолчанию составляет 10 минут. |
| headers |
String |
false |
Указанные пользователем заголовки, которые будут отправлены в запрос |
| body |
String |
false |
Текст запроса для конечной точки |
| reportStatusOnCallBack |
Boolean |
false |
Состояние отчета о обратном вызове |
| disableCertValidation |
Boolean |
false |
Если задано значение true, он игнорирует ошибки TLS/SSL на стороне сервера. Значение по умолчанию: false |
Свойства действия AzureFunction
Свойства для действий с type: "AzureFunction".
Свойства типа действия AzureFunction
| Имя |
Тип |
Обязательно |
Description |
| method |
Object |
true |
Метод REST API для конечной точки |
| functionName |
String |
true |
Имя функции, вызываемой действием функции Azure |
| headers |
String |
false |
Указанные пользователем заголовки, которые будут отправлены в запрос |
| body |
String |
false |
Текст запроса для конечной точки |
| functionSetId |
String (GUID) |
false |
Идентификатор набора функций |
| workspaceId |
String (GUID) |
false |
Идентификатор рабочей области |
| тип операции |
String |
false |
Тип операции действия |
| parameters |
String |
false |
Параметры для действия функции Azure |
Настраиваемые свойства действия
Свойства для действий с type: "Custom".
Свойства типа пользовательского действия
| Имя |
Тип |
Обязательно |
Description |
| command |
String |
true |
Команда для пользовательского действия |
| внешниеСсылки |
ExternalReferences |
true |
Внешние ссылки на подключение |
| folderPath |
String |
false |
Путь к папке для файлов ресурсов |
| extendedProperties |
Object |
false |
Пользовательский контейнер свойств. Нет ограничений на ключи или значения, которые можно использовать. Пользователь, указанный настраиваемым действием, несет полную ответственность за использование и интерпретацию определенного содержимого. |
| retentionTimeInDays |
Double |
false |
Время хранения файлов, отправленных для пользовательского действия |
| autoUserSpecification |
String |
false |
Уровень повышения прав и область для пользователя по умолчанию — это неадминная задача |
Свойства промежуточного выполнения пользовательских действий
| Имя |
Тип |
Обязательно |
Description |
| внешниеСсылки |
ExternalReferences |
true |
Внешние ссылки на подключение |
Свойства действия InvokeCopyJob
Свойства для действий с type: "InvokeCopyJob".
Свойства типа действия InvokeCopyJob
| Имя |
Тип |
Обязательно |
Description |
| copyJobId |
String (GUID) |
true |
Копирование идентификатора задания |
| workspaceId |
String (GUID) |
true |
Идентификатор рабочей области |
Свойства действия ExecuteSSISPackage
Свойства для действий с type: "ExecuteSSISPackage".
Свойства типа действия ExecuteSSISPackage
| Имя |
Тип |
Обязательно |
Description |
| packageLocation |
SSISPackageLocation |
true |
Расположение пакета служб SSIS для выполнения |
| packageName |
String |
true |
Имя пакета служб SSIS |
| runtime |
IntegrationRuntimeReference |
false |
Среда выполнения интеграции, используемая для выполнения пакета |
| parameters |
ParameterSpecification |
false |
Параметры для передачи в пакет служб SSIS |
| projectParameters |
ParameterSpecification |
false |
Параметры уровня проекта для пакета служб SSIS |
| packageParameters |
ParameterSpecification |
false |
Параметры уровня пакета для пакета служб SSIS |
| projectConnectionManagers |
ConnectionManagerSpecification |
false |
Диспетчеры подключений проекта для пакета служб SSIS |
| packageConnectionManagers |
ConnectionManagerSpecification |
false |
Диспетчеры подключений пакетов для пакета служб SSIS |
| propertyOverrides |
PropertyOverrideSpecification |
false |
Переопределения свойств для пакета служб SSIS |
| logLocation |
SSISLogLocation |
false |
Расположение для хранения журналов выполнения |
Свойства действия SqlServerStoredProcedure
Свойства для действий с type: "SqlServerStoredProcedure".
Свойства типа действия SqlServerStoredProcedure
| Имя |
Тип |
Обязательно |
Description |
| база данных |
String |
false |
Имя базы данных SQL Server |
| storedProcedureName |
String |
true |
Имя хранимой процедуры |
| storedProcedureParameters |
Object |
false |
Параметр значения и типа для параметров хранимой процедуры |
Свойства действия InvokePipeline
Свойства для действий с type: "InvokePipeline".
Свойства типа действия InvokePipeline
| Имя |
Тип |
Обязательно |
Description |
| parameters |
Object |
false |
Параметры конвейеров |
| waitOnCompletion |
Boolean |
false |
Определяет, будет ли выполнение действия ожидать завершения выполнения зависимого конвейера. Значение по умолчанию — false. |
| workspaceId |
String |
false |
Идентификатор рабочей области |
| pipelineId |
String |
false |
Идентификатор конвейера |
| тип операции |
String |
false |
Тип операции |
Свойства действия KustoQueryLanguage
Свойства для действий с type: "KustoQueryLanguage".
| Имя |
Тип |
Обязательно |
Description |
| typeProperties |
KustoQueryLanguageActivityTypeProperties |
true |
Свойства для действия языка запросов Kusto |
| внешниеСсылки |
ExternalReferences |
false |
Ссылка на подключение. |
| linkedService |
Object |
false |
Связанная служба |
| connectionSettings |
Object |
false |
Параметры подключения |
Свойства типа действия KustoQueryLanguage
| Имя |
Тип |
Обязательно |
Description |
| command |
String |
true |
Команда управления в соответствии с синтаксисом команды действия скрипта KQL |
| commandTimeout |
String |
false |
Время ожидания команды управления |
| база данных |
String |
false |
Имя базы данных для запроса |
Свойства действия AzureML
Свойства для действий с type: "AzureMLExecutePipeline".
Свойства типа действия AzureML
| Имя |
Тип |
Обязательно |
Description |
| mlExecutionType |
String |
false |
Конвейер или пакетные конечные точки. |
| mlPipelineId |
String |
false |
Идентификатор опубликованного конвейера Машинного обучения Azure. |
| mlPipelineEndpointId |
String |
false |
Идентификатор опубликованной конечной точки конвейера Машинного обучения Azure. |
| version |
String |
false |
Версия опубликованной конечной точки конвейера Машинного обучения Azure. |
| experimentName |
String |
false |
Имя эксперимента Машинного обучения Azure |
| mlPipelineParameters |
ParameterSpecification |
false |
Параметры для передачи в конвейер Машинного обучения Azure |
| dataPathAssignments |
DataPathAssignment |
false |
Назначения путей данных для конвейера Машинного обучения Azure |
| mlBatchEndpointName |
String |
false |
Имя опубликованной конечной точки пакетной службы машинного обучения Azure. |
| mlBatchDeploymentName |
String |
false |
Имя опубликованного пакетного развертывания машинного обучения Azure для выбранной конечной точки. |
| jobSettings |
Object |
false |
Пары "Ключ", "Значение", передаваемые в опубликованную конечную точку пакетной службы машинного обучения Azure. |
| jobInputs |
Object |
false |
Словарь, используемый для входных параметров задания. |
| jobOutputs |
Object |
false |
Словарь, используемый для параметров выходных данных задания. |
| mlParentRunId |
String |
false |
Родительский идентификатор запуска конвейера службы машинного обучения Azure. |
| continueOnStepFailure |
Boolean |
false |
Следует ли продолжать выполнение других шагов в PipelineRun, если шаг завершается ошибкой. |
Свойства действия DataLakeAnalyticsScope
Свойства для действий с type: "DataLakeAnalyticsScope".
Свойства типа действия DataLakeAnalyticsScope
| Имя |
Тип |
Обязательно |
Description |
| scriptFileName |
String |
false |
Имя файла с учетом регистра с скриптом Области |
| scriptFolderPath |
String |
false |
Путь к папке с учетом регистра, содержащей скрипт области |
| внешниеСсылки |
ExternalReferences |
false |
Ссылка на подключение |
| linkedService |
Object |
false |
Связанная служба сценариев |
| connectionSettings |
Object |
false |
Параметры подключения |
| degreeOfParallelism |
Целое число |
false |
Максимальное количество узлов, одновременно используемых для запуска задания. Значение по умолчанию: 1. Минимум: 1 |
| priority |
Целое число |
false |
Определяет, какие задания из всех очередей должны быть выбраны для первого запуска. Чем ниже число, тем выше приоритет. Значение по умолчанию — 1000. Минимум: 1 |
| parameters |
Object |
false |
Параметры запроса задания области |
| runtimeVersion |
String |
false |
Версия среды выполнения обработчика области для использования |
| имя задачи |
String |
false |
Имя задания области Azure Data Lake Analytics |
| jobOwner |
String |
false |
Настраиваемый тег для добавления в задание области для указания псевдонима владельца задания |
| degreeOfParallelismPercent |
Целое число |
false |
Максимальный процент узлов, одновременно используемых для выполнения задания. Обратите внимание, что это и свойство degreeofParallelism являются взаимоисключающими |
| nebulaArguments |
String |
false |
Дополнительные параметры области для передачи во время отправки задания |
| Уведомитель |
Object |
false |
Список адресов электронной почты, которые будут получать уведомления, когда задание достигает состояния терминала |
| scopeScriptInclusionSet |
String |
false |
Список расширений файлов ресурсов скрипта, разделенных точкой с запятой. Только эти файлы будут отправлены в ADLA в качестве ресурсов задания области |
| tags |
Object |
false |
Настраиваемые теги для задания Области |
Свойства действия TridentNotebook
Свойства для действий с type: "TridentNotebook".
Свойства типа действия TridentNotebook
| Имя |
Тип |
Обязательно |
Description |
| notebookId |
String |
true |
Идентификатор записной книжки |
| workspaceId |
String |
true |
Идентификатор рабочей области |
| parameters |
Object |
false |
Параметры, используемые для каждого запуска этого задания. Если записная книжка принимает параметр, который не указан, будет использоваться значение по умолчанию из записной книжки. |
| sessionTag |
String |
false |
Тег сеанса Spark |
Свойства действия DatabricksNotebook
Свойства для действий с type: "DatabricksNotebook".
Свойства типа действия DatabricksNotebook
| Имя |
Тип |
Обязательно |
Description |
| notebookPath |
String |
true |
Путь к записной книжке Databricks для выполнения |
| baseParameters |
ParameterSpecification |
false |
Базовые параметры для передачи в записную книжку Databricks |
| libraries |
DatabricksLibrarySpecification[] |
false |
Библиотеки для установки для выполнения записной книжки |
| existingClusterId |
String |
false |
Идентификатор существующего кластера Databricks для использования |
| newClusterSettings |
DatabricksNewClusterSettings |
false |
Параметры для создания нового кластера Databricks |
| pythonWheelTask |
DatabricksPythonWheelTask |
false |
Конфигурация задачи колеса Python для Databricks |
| sparkJarTask |
DatabricksSparkJarTask |
false |
Конфигурация задачи Spark JAR для Databricks |
| sparkPythonTask |
DatabricksSparkPythonTask |
false |
Настройка задачи Spark Python для Databricks |
Свойства действия RefreshDataFlow
Свойства для действий с type: "RefreshDataFlow".
Свойства типа действия RefreshDataFlow
| Имя |
Тип |
Обязательно |
Description |
| dataflowId |
String |
true |
Идентификатор потока данных |
| workspaceId |
String |
true |
Идентификатор рабочей области |
| notifyOption |
String |
false |
Уведомление о параметрах почты |
| dataflowType |
String |
false |
Тип потока данных (системное свойство) |
| parameters |
Object |
false |
Параметры, используемые для каждого запуска этого задания. Если поток данных принимает параметр, который не указан, будет использоваться значение по умолчанию из потока данных. |
Свойства действия Office365Email
Свойства для действий с type: "Office365Email".
Свойства типа действия Office365Email
| Имя |
Тип |
Обязательно |
Description |
| body |
String |
false |
Содержимое почты |
| Кому |
String |
false |
Список получателей, разделенных ; |
| субъект |
String |
false |
Тема почты |
| от / из / с (context-dependent) |
String |
false |
Идентификатор электронной почты отправителя |
| копия |
String |
false |
Список получателей в CC, разделенных ; |
| Скрытая копия |
String |
false |
Список получателей в BCC, разделенных ; |
| чувствительность |
String |
false |
Конфиденциальность почты |
| важность |
String |
false |
Важность почты |
| replyTo |
String |
false |
Идентификатор электронной почты, в котором вы хотите получить ответ сообщения |
| тип операции |
String |
false |
Тип операции |
Свойства действия электронной почты
Свойства для действий с type: "Email".
Свойства типа действия электронной почты
| Имя |
Тип |
Обязательно |
Description |
| входные данные |
LogicAppsActivityInput |
false |
Входные данные действий Logic Apps |
| body |
String |
false |
Содержимое почты |
| Кому |
String |
false |
Список получателей, разделенных ; |
| субъект |
String |
false |
Тема почты |
| от / из / с (context-dependent) |
String |
false |
Идентификатор электронной почты отправителя |
| копия |
String |
false |
Список получателей в CC, разделенных ; |
| Скрытая копия |
String |
false |
Список получателей в BCC, разделенных ; |
| чувствительность |
String |
false |
Конфиденциальность почты |
| важность |
String |
false |
Важность почты |
| replyTo |
String |
false |
Идентификатор электронной почты, в котором вы хотите получить ответ сообщения |
| тип операции |
String |
false |
Тип операции |
Свойства действия MicrosoftTeams
Свойства для действий с type: "MicrosoftTeams".
Свойства типа действия MicrosoftTeams
| Имя |
Тип |
Обязательно |
Description |
| содержимое |
String |
false |
Содержимое сообщения |
| teamId |
String |
false |
Идентификатор группы или идентификатор рабочей области |
| channelId |
String |
false |
Идентификатор набора данных модели |
| chatId |
String |
false |
Тип обновления |
| тип операции |
String |
false |
Тип операции |
| субъект |
String |
false |
Тема для записей канала |
Свойства действий Teams
Свойства для действий с type: "Teams".
Свойства типа действия Teams
| Имя |
Тип |
Обязательно |
Description |
| входные данные |
LogicAppsActivityInput |
false |
Входные данные действий Logic Apps |
| содержимое |
String |
false |
Содержимое сообщения |
| teamId |
String |
false |
Идентификатор группы или идентификатор рабочей области |
| channelId |
String |
false |
Идентификатор набора данных модели |
| chatId |
String |
false |
Тип обновления |
| тип операции |
String |
false |
Тип операции |
Свойства действия PBISemanticModelRefresh
Свойства для действий с type: "PBISemanticModelRefresh".
Свойства типа действия PBISemanticModelRefresh
| Имя |
Тип |
Обязательно |
Description |
| method |
String |
false |
Метод HTTP |
| groupId |
String |
false |
Идентификатор группы или идентификатор рабочей области |
| workspaceId |
String |
false |
Идентификатор рабочей области |
| ИДНабораДанных |
String |
false |
Идентификатор набора данных модели |
| type |
String |
false |
Тип обновления |
| commitMode |
String |
false |
Режим фиксации обновления |
| maxParallelism |
Целое число |
false |
Максимальное число параллелизмов |
| retryCount |
Целое число |
false |
Число повторных попыток для обновления |
| Объектов |
Массив |
false |
Список объектов секционирования таблиц |
| waitOnCompletion |
Boolean |
false |
Определяет, будет ли выполнение действия ожидать завершения выполнения зависимого конвейера. Значение по умолчанию — false. |
| входные данные |
LogicAppsActivityInput |
false |
Входные данные действий Logic Apps |
| тип операции |
String |
false |
Тип операции |
| Имя |
Тип |
Обязательно |
Description |
| body |
String |
true |
Текст содержит все предоставленные пользователем параметры |
| method |
String |
true |
Метод операции действия Logic Apps |
| путь |
String |
true |
Путь swagger, определяющий операцию действия Logic Apps |
| headers |
String |
false |
Заголовки для операции действия Logic Apps |
| queries |
String |
false |
Запросы для операции действия Logic Apps |
Пример ContentDetails
{
"properties": {
"description": "Data pipeline with multiple activity types demonstrating different typeProperties",
"activities": [
{
"name": "Notebook1",
"type": "TridentNotebook",
"dependsOn": [],
"policy": {
"timeout": "0.12:00:00",
"retry": 0,
"retryIntervalInSeconds": 30,
"secureOutput": false,
"secureInput": false
},
"typeProperties": {
"notebookId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"workspaceId": "b81f1d9f-33c7-462d-b818-2e4906a123f3"
}
},
{
"name": "Get Metadata1",
"type": "GetMetadata",
"dependsOn": [],
"policy": {
"timeout": "0.12:00:00",
"retry": 0,
"retryIntervalInSeconds": 30,
"secureOutput": false,
"secureInput": false
},
"typeProperties": {
"fieldList": [
"columnCount"
],
"datasetSettings": {
"annotations": [],
"linkedService": {
"name": "LakehouseGitArtifactW1",
"properties": {
"annotations": [],
"type": "Lakehouse",
"typeProperties": {
"workspaceId": "b81f1d9f-33c7-462d-b818-2e4906a123f3",
"artifactId": "c69ca3a7-fc70-4b4f-aad7-ce711b7a57d0",
"rootFolder": "Tables"
}
}
},
"type": "LakehouseTable",
"schema": [],
"typeProperties": {
"table": "Lh1"
}
}
}
},
{
"name": "Lookup1",
"type": "Lookup",
"dependsOn": [],
"policy": {
"timeout": "0.12:00:00",
"retry": 0,
"retryIntervalInSeconds": 30,
"secureOutput": false,
"secureInput": false
},
"typeProperties": {
"source": {
"type": "LakehouseTableSource"
},
"datasetSettings": {
"annotations": [],
"linkedService": {
"name": "LakehouseGitArtifactW1",
"properties": {
"annotations": [],
"type": "Lakehouse",
"typeProperties": {
"workspaceId": "b81f1d9f-33c7-462d-b818-2e4906a123f3",
"artifactId": "c69ca3a7-fc70-4b4f-aad7-ce711b7a57d0",
"rootFolder": "Tables"
}
}
},
"type": "LakehouseTable",
"schema": [],
"typeProperties": {
"table": "lh2"
}
}
}
},
{
"name": "PBISemanticModelRefresh1",
"type": "PBISemanticModelRefresh",
"dependsOn": [],
"userProperties": [],
"typeProperties": {
"method": "POST",
"groupId": "b81f1d9f-33c7-462d-b818-2e4906a123f3",
"datasetId": "67cd5565-49a2-401d-907f-744cc68b16c8",
"type": "Full",
"commitMode": "transactional",
"maxParallelism": 2,
"retryCount": 1,
"waitOnCompletion": true,
"operationType": "RefreshDataset"
},
"externalReferences": {
"connection": "276c4d2d-855a-4c20-adbe-23622ad82704"
},
"policy": {
"timeout": "7.00:00:00",
"retry": 0,
"retryIntervalInSeconds": 30,
"secureInput": false,
"secureOutput": false
}
}
]
}
}