Bicep リソース定義
factories/pipelines リソースの種類は、次を対象とする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.DataFactory/factories/pipelines リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DataFactory/factories/pipelines@2017-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
annotations: [
any(...)
]
concurrency: int
description: 'string'
parameters: {
{customized property}: {
defaultValue: any(...)
type: 'string'
}
}
}
}
CopySource オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
アクティビティ オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
AzureMLBatchExecution の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'AzureMLBatchExecution'
typeProperties: {
globalParameters: {
{customized property}: any(...)
}
webServiceInputs: {
{customized property}: {
filePath: any(...)
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
}
}
webServiceOutputs: {
{customized property}: {
filePath: any(...)
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
}
}
}
}
AzureMLUpdateResource の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'AzureMLUpdateResource'
typeProperties: {
trainedModelFilePath: any(...)
trainedModelLinkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
trainedModelName: any(...)
}
}
ExecutePipeline の場合は、次のコマンドを使用します。
{
type: 'ExecutePipeline'
typeProperties: {
parameters: {
{customized property}: any(...)
}
pipeline: {
name: 'string'
referenceName: 'string'
type: 'string'
}
waitOnCompletion: bool
}
}
フィルターの場合は、次を使用します。
{
type: 'Filter'
typeProperties: {
condition: {
type: 'string'
value: 'string'
}
items: {
type: 'string'
value: 'string'
}
}
}
ForEach の場合は、次を使用します。
{
type: 'ForEach'
typeProperties: {
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
batchCount: int
isSequential: bool
items: {
type: 'string'
value: 'string'
}
}
}
IfCondition の場合は、次を使用します。
{
type: 'IfCondition'
typeProperties: {
expression: {
type: 'string'
value: 'string'
}
ifFalseActivities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
ifTrueActivities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
}
}
Until の場合は、次を使用します。
{
type: 'Until'
typeProperties: {
activities: [
{
dependsOn: [
{
activity: 'string'
dependencyConditions: [
'string'
]
}
]
description: 'string'
name: 'string'
type: 'string'
// For remaining properties, see Activity objects
}
]
expression: {
type: 'string'
value: 'string'
}
timeout: any(...)
}
}
Wait の場合は、次の値を使用します。
{
type: 'Wait'
typeProperties: {
waitTimeInSeconds: int
}
}
コピーの場合は、次の値を使用します。
{
inputs: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
outputs: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'Copy'
typeProperties: {
cloudDataMovementUnits: any(...)
enableSkipIncompatibleRow: any(...)
enableStaging: any(...)
parallelCopies: any(...)
redirectIncompatibleRowSettings: {
linkedServiceName: any(...)
path: any(...)
}
sink: {
sinkRetryCount: any(...)
sinkRetryWait: any(...)
writeBatchSize: any(...)
writeBatchTimeout: any(...)
type: 'string'
// For remaining properties, see CopySink objects
}
source: {
sourceRetryCount: any(...)
sourceRetryWait: any(...)
type: 'string'
// For remaining properties, see CopySource objects
}
stagingSettings: {
enableCompression: any(...)
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
path: any(...)
}
translator: any(...)
}
}
カスタムの場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'Custom'
typeProperties: {
command: any(...)
extendedProperties: {
{customized property}: any(...)
}
folderPath: any(...)
referenceObjects: {
datasets: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
linkedServices: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
}
resourceLinkedService: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
}
}
DataLakeAnalyticsU-SQL の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'DataLakeAnalyticsU-SQL'
typeProperties: {
compilationMode: any(...)
degreeOfParallelism: any(...)
parameters: {
{customized property}: any(...)
}
priority: any(...)
runtimeVersion: any(...)
scriptLinkedService: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
scriptPath: any(...)
}
}
DatabricksNotebook の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'DatabricksNotebook'
typeProperties: {
baseParameters: {
{customized property}: any(...)
}
notebookPath: any(...)
}
}
ExecuteSSISPackage の場合は、次のコマンドを使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'ExecuteSSISPackage'
typeProperties: {
connectVia: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
environmentPath: any(...)
executionCredential: {
domain: any(...)
password: {
type: 'string'
value: 'string'
}
userName: any(...)
}
loggingLevel: any(...)
logLocation: {
logPath: any(...)
type: 'string'
typeProperties: {
accessCredential: {
domain: any(...)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(...)
}
logRefreshInterval: any(...)
}
}
packageConnectionManagers: {
{customized property}: {
{customized property}: {
value: any(...)
}
}
}
packageLocation: {
packagePath: any(...)
type: 'string'
typeProperties: {
accessCredential: {
domain: any(...)
password: {
type: 'string'
// For remaining properties, see SecretBase objects
}
userName: any(...)
}
configurationPath: any(...)
packagePassword: {
type: 'string'
// For remaining properties, see SecretBase objects
}
}
}
packageParameters: {
{customized property}: {
value: any(...)
}
}
projectConnectionManagers: {
{customized property}: {
{customized property}: {
value: any(...)
}
}
}
projectParameters: {
{customized property}: {
value: any(...)
}
}
propertyOverrides: {
{customized property}: {
isSensitive: bool
value: any(...)
}
}
runtime: any(...)
}
}
GetMetadata の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'GetMetadata'
typeProperties: {
dataset: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
fieldList: [
any(...)
]
}
}
HDInsightHive の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'HDInsightHive'
typeProperties: {
arguments: [
any(...)
]
defines: {
{customized property}: any(...)
}
getDebugInfo: 'string'
scriptLinkedService: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
scriptPath: any(...)
storageLinkedServices: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
}
}
HDInsightMapReduce の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'HDInsightMapReduce'
typeProperties: {
arguments: [
any(...)
]
className: any(...)
defines: {
{customized property}: any(...)
}
getDebugInfo: 'string'
jarFilePath: any(...)
jarLibs: [
any(...)
]
jarLinkedService: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
storageLinkedServices: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
}
}
HDInsightPig の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'HDInsightPig'
typeProperties: {
arguments: [
any(...)
]
defines: {
{customized property}: any(...)
}
getDebugInfo: 'string'
scriptLinkedService: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
scriptPath: any(...)
storageLinkedServices: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
}
}
HDInsightSpark の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'HDInsightSpark'
typeProperties: {
arguments: [
any(...)
]
className: 'string'
entryFilePath: any(...)
getDebugInfo: 'string'
proxyUser: any(...)
rootPath: any(...)
sparkConfig: {
{customized property}: any(...)
}
sparkJobLinkedService: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
}
}
HDInsightStreaming の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'HDInsightStreaming'
typeProperties: {
arguments: [
any(...)
]
combiner: any(...)
commandEnvironment: [
any(...)
]
defines: {
{customized property}: any(...)
}
fileLinkedService: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
filePaths: [
any(...)
]
getDebugInfo: 'string'
input: any(...)
mapper: any(...)
output: any(...)
reducer: any(...)
storageLinkedServices: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
}
}
ルックアップの場合は、次の値を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'Lookup'
typeProperties: {
dataset: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
firstRowOnly: any(...)
source: {
sourceRetryCount: any(...)
sourceRetryWait: any(...)
type: 'string'
// For remaining properties, see CopySource objects
}
}
}
SqlServerStoredProcedure の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'SqlServerStoredProcedure'
typeProperties: {
storedProcedureName: any(...)
storedProcedureParameters: {
{customized property}: {
type: 'string'
value: any(...)
}
}
}
}
WebActivity の場合は、次を使用します。
{
linkedServiceName: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
policy: {
retry: any(...)
retryIntervalInSeconds: int
secureOutput: bool
timeout: any(...)
}
type: 'WebActivity'
typeProperties: {
authentication: {
password: {
type: 'string'
value: 'string'
}
pfx: {
type: 'string'
value: 'string'
}
resource: 'string'
type: 'string'
username: 'string'
}
body: any(...)
datasets: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
disableCertValidation: bool
headers: any(...)
linkedServices: [
{
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
]
method: 'string'
url: any(...)
}
}
CopySink オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
SecretBase オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
AzureKeyVaultSecret の場合は、次を使用します。
{
secretName: any(...)
secretVersion: any(...)
store: {
parameters: {
{customized property}: any(...)
}
referenceName: 'string'
type: 'string'
}
type: 'AzureKeyVaultSecret'
}
SecureString の場合は、次を使用します。
{
type: 'SecureString'
value: 'string'
}
プロパティ値
Microsoft.DataFactory/factories/pipelines
名前 |
説明 |
価値 |
名前 |
リソース名 |
糸
制約: 最小長 = 1 最大長 = 260 パターン = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必須) |
親 |
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。
詳細については、「親リソースの外部 子リソース」を参照してください。 |
種類のリソースのシンボリック名: ファクトリ |
プロパティ |
パイプラインのプロパティ。 |
パイプライン (必須) |
活動
アクティビティ依存関係
名前 |
説明 |
価値 |
アクティビティ |
アクティビティ名。 |
string (必須) |
dependency条件 |
依存関係の Match-Condition。 |
次のいずれかを含む文字列配列: 「完了しました」 「失敗しました」 「スキップ」 'Succeeded' (必須) |
アクティビティポリシー
名前 |
説明 |
価値 |
再試行 |
通常の再試行回数の最大値。 既定値は 0 です。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
retryIntervalInSeconds (秒単位) |
再試行の間隔 (秒単位)。 既定値は 30 秒です。 |
int
制約: 最小値 = 30 最大値 = 86400 |
セキュアアウトプット |
true に設定すると、アクティビティからの出力は安全と見なされ、監視には記録されません。 |
ブール (bool) |
タイムアウト |
アクティビティを実行するためのタイムアウトを指定します。 既定のタイムアウトは 7 日です。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
AzureKeyVaultSecretReference
名前 |
説明 |
価値 |
シークレット名 |
Azure Key Vault 内のシークレットの名前。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
秘密バージョン |
Azure Key Vault のシークレットのバージョン。 既定値は、シークレットの最新バージョンです。 型: string (または resultType 文字列を含む式)。 |
任意 |
保存する |
Azure Key Vault のリンクされたサービス リファレンス。 |
LinkedServiceReference (必須) |
型 |
シークレットの種類。 |
'AzureKeyVaultSecret' (必須) |
AzureMLBatchExecutionActivity
AzureMLBatchExecutionActivityTypeプロパティ
AzureMLBatchExecutionActivityTypePropertiesGlobalParameters
AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs
AzureMLUpdateResourceActivity
AzureMLUpdateResourceActivityTypeProperties のこと
名前 |
説明 |
価値 |
trainedModelFilePath (トレーニング済みモデルファイルパス) |
更新操作によってアップロードされる .ilearner ファイルを表す trainedModelLinkedService の相対ファイル パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
trainedModelLinkedServiceName さん |
更新操作によってアップロードされる .ilearner ファイルを保持する Azure Storage のリンクされたサービスの名前。 |
LinkedServiceReference (必須) |
trainedModelName (トレーニング済みモデル名) |
更新する Web サービス実験のトレーニング済みモデル モジュールの名前。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
AzureMLWebServiceFile の略
名前 |
説明 |
価値 |
ファイルパス |
LinkedService で指定された Azure Blob Storage 内のコンテナー名を含む相対ファイル パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
リンクされたサービス名 |
Azure ML WebService の入力/出力ファイルがある Azure Storage LinkedService への参照。 |
LinkedServiceReference (必須) |
コピーアクティビティ
CopyActivityTypeプロパティ
名前 |
説明 |
価値 |
cloudDataMovementUnits(クラウドデータ移動ユニット) |
このデータ移動を実行するために使用できるクラウド データ移動単位の最大数。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
enableSkipIncompatibleRow |
互換性のない行をスキップするかどうか。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
enableStagingの |
中間ステージングを使用してデータをコピーするかどうかを指定します。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
並列コピー |
データ ストアのオーバーロードを回避するために、ソースまたはシンクで開かれた同時セッションの最大数。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
redirectIncompatibleRowSettings (リダイレクト互換性のない行設定) |
EnableSkipIncompatibleRow が true の場合、互換性のない行設定をリダイレクトします。 |
RedirectIncompatibleRowSettings (リダイレクト互換性のない行設定) |
シンク |
コピー アクティビティ シンク。 |
CopySink (必須) |
ソース |
コピー アクティビティのソース。 |
CopySource (必須) |
ステージング設定 |
EnableStaging が true の場合の中間ステージング設定を指定します。 |
ステージング設定 |
Translator |
コピー アクティビティの翻訳ツール。 指定しない場合は、表形式変換プログラムが使用されます。 |
任意 |
コピーシンク
名前 |
説明 |
価値 |
シンクリトライカウント |
シンクの再試行回数。 型: 整数 (または resultType 整数を持つ式)。 |
任意 |
シンクリトライウェイト |
シンクの再試行の待機。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
型 |
|
(必須) |
writeBatchSize の |
書き込みバッチ サイズ。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
writeBatchTimeout の |
書き込みバッチ タイムアウト。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
コピーソース
名前 |
説明 |
価値 |
sourceRetryCount |
ソースの再試行回数。 型: 整数 (または resultType 整数を持つ式)。 |
任意 |
sourceRetryWait |
ソースの再試行待機。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
型 |
|
(必須) |
カスタムアクティビティ
CustomActivityReferenceオブジェクト
CustomActivityTypeプロパティ
名前 |
説明 |
価値 |
コマンド |
カスタム アクティビティの種類のコマンド: string (または resultType 文字列を含む式)。 |
any (必須) |
拡張プロパティ |
ユーザー定義プロパティ バッグ。 使用できるキーまたは値に制限はありません。 ユーザーが指定したカスタム アクティビティには、定義されたコンテンツを使用して解釈する責任があります。 |
CustomActivityTypeProperties拡張プロパティ |
フォルダパス |
リソース ファイルのフォルダー パス タイプ: string (または resultType 文字列を含む式)。 |
任意 |
referenceObjects(リファレンスオブジェクト) |
参照オブジェクト |
CustomActivityReferenceオブジェクト |
resourceLinkedService (英語) |
リソースのリンクされたサービス参照。 |
LinkedServiceReference の |
CustomActivityTypeProperties拡張プロパティ
Databricks ノートブック アクティビティ
Databricks ノートブック アクティビティ タイププロパティ
名前 |
説明 |
価値 |
ベースパラメータ |
このジョブの実行ごとに使用される基本パラメーター。ノートブックが指定されていないパラメーターを受け取る場合は、ノートブックの既定値が使用されます。 |
Databricks ノートブックアクティビティタイププロパティベースパラメーター |
ノートブックパス |
Databricks ワークスペースで実行するノートブックの絶対パス。 このパスはスラッシュで始まる必要があります。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
Databricks ノートブックアクティビティタイププロパティベースパラメーター
DataLakeAnalyticsUsqlActivity
DataLakeAnalyticsUsqlActivityTypeProperties (英語)
名前 |
説明 |
価値 |
compilationMode (コンパイルモード) |
U-SQL のコンパイル モード。 Semantic、Full、SingleBox のいずれかの値を指定する必要があります。 型: string (または resultType 文字列を含む式)。 |
任意 |
degreeOfParallelism (並列処理の度数) |
ジョブの実行に同時に使用されるノードの最大数。 既定値は 1 です。 型: 整数 (または resultType 整数を持つ式)、最小値: 1。 |
任意 |
パラメーター |
U-SQL ジョブ要求のパラメーター。 |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters |
優先権 |
キューに登録されているすべてのジョブのうち、最初に実行するように選択する必要があるジョブを決定します。 数値が小さい方が優先度が高くなります。 既定値は 1000 です。 型: 整数 (または resultType 整数を持つ式)、最小値: 1。 |
任意 |
ランタイムバージョン |
使用する U-SQL エンジンのランタイム バージョン。 型: string (または resultType 文字列を含む式)。 |
任意 |
scriptLinkedService |
スクリプトのリンクされたサービス参照。 |
LinkedServiceReference (必須) |
スクリプトパス |
U-SQL スクリプトを含むフォルダーへの大文字と小文字を区別するパス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters
データセット参照
名前 |
説明 |
価値 |
パラメーター |
データセットの引数。 |
ParameterValueSpecification の |
referenceName(リファレンスネーム) |
参照データセット名。 |
string (必須) |
型 |
データセット参照型。 |
'DatasetReference' (必須) |
パイプラインアクティビティの実行
ExecutePipelineActivityTypeProperties (英語)
名前 |
説明 |
価値 |
パラメーター |
パイプライン パラメーター。 |
ParameterValueSpecification の |
パイプライン |
パイプラインリファレンス。 |
PipelineReference (必須) |
waitOnCompletion(ウェイトン・コンプリート) |
アクティビティの実行が依存パイプラインの実行の完了を待機するかどうかを定義します。 既定値は false です。 |
ブール (bool) |
ExecuteSsisPackageActivity (英語)
ExecuteSsisPackageActivityTypeProperties (英語)
ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers
ExecuteSsisPackageActivityTypePropertiesPackageParameters
ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers (英語)
ExecuteSsisPackageActivityTypePropertiesプロジェクトパラメータ
ExecuteSsisPackageActivityTypePropertiesPropertyOverrides
表現
名前 |
説明 |
価値 |
型 |
式の型。 |
'Expression' (必須) |
価値 |
式の値。 |
string (必須) |
フィルターアクティビティ
FilterActivityTypeプロパティ
名前 |
説明 |
価値 |
条件 |
入力のフィルター処理に使用する条件。 |
式 (必須) |
アイテム |
フィルターを適用する必要がある入力配列。 |
式 (必須) |
ForEachActivity (英語)
ForEachActivityTypeProperties (各アクティビティ タイププロパティ)
名前 |
説明 |
価値 |
活動 |
実行するアクティビティの一覧。 |
Activity[] (必須) |
バッチカウント |
並列実行の数を制御するために使用されるバッチ数 (isSequential が false に設定されている場合)。 |
int
制約: 最大値 = 50 |
isSequential です。 |
ループを順番または並列で実行する必要がある場合 (最大 50) |
ブール (bool) |
アイテム |
反復処理するコレクション。 |
式 (必須) |
名前 |
説明 |
価値 |
データセット |
GetMetadata アクティビティ データセットリファレンス。 |
DatasetReference (必須) |
フィールドリスト |
データセットから取得するメタデータのフィールド。 |
どれでも[] |
HDInsightHiveアクティビティ
HDInsightHiveActivityTypeProperties (英語)
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
定義 |
ユーザーが Hive ジョブ要求の定義を指定できるようにします。 |
HDInsightHiveActivityTypePropertiesDefines |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
scriptLinkedService |
スクリプトのリンクされたサービス参照。 |
LinkedServiceReference の |
スクリプトパス |
スクリプト パス。 型: string (または resultType 文字列を含む式)。 |
任意 |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightHiveActivityTypePropertiesDefines
HDInsightMapReduceActivity
HDInsightMapReduceActivityTypeProperties
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
クラス名 |
クラス名。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
定義 |
ユーザーが MapReduce ジョブ要求の定義を指定できるようにします。 |
HDInsightMapReduceActivityTypePropertiesDefines |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
jarFilePath (日本語) |
Jar パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
jarLibsの |
Jar ライブラリ。 |
どれでも[] |
jarLinkedサービス |
Jar のリンクされたサービス 参照。 |
LinkedServiceReference の |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightMapReduceActivityTypePropertiesDefines
HDInsightPigActivity
HDInsightPigActivityTypeProperties (英語)
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
定義 |
ユーザーが Pig ジョブ要求の定義を指定できるようにします。 |
HDInsightPigActivityTypeProperties定義 |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
scriptLinkedService |
スクリプトのリンクされたサービス参照。 |
LinkedServiceReference の |
スクリプトパス |
スクリプト パス。 型: string (または resultType 文字列を含む式)。 |
任意 |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightPigActivityTypeProperties定義
HDInsightSparkアクティビティ
HDInsightSparkActivityTypeProperties
名前 |
説明 |
価値 |
引数 |
HDInsightSparkActivity に対するユーザー指定の引数。 |
どれでも[] |
クラス名 |
アプリケーションの Java/Spark メイン クラス。 |
文字列 |
entryFilePath (エントリ ファイルパス) |
実行するコード/パッケージのルート フォルダーへの相対パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
プロキシユーザー |
ジョブを実行する権限を借用するユーザー。 型: string (または resultType 文字列を含む式)。 |
任意 |
ルートパス |
ジョブのすべてのファイルの 'sparkJobLinkedService' のルート パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
sparkコンフィグ |
Spark 構成プロパティ。 |
HDInsightSparkActivityTypePropertiesSparkConfig |
sparkJobLinkedService |
エントリ ファイルと依存関係をアップロードし、ログを受信するためのストレージのリンクされたサービス。 |
LinkedServiceReference の |
HDInsightSparkActivityTypePropertiesSparkConfig
HDInsightストリーミングアクティビティ
HDInsightStreamingActivityTypeProperties (英語)
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
結合器 |
コンバイナー実行可能ファイル名。 型: string (または resultType 文字列を含む式)。 |
任意 |
コマンド環境 |
コマンド ライン環境の値。 |
どれでも[] |
定義 |
ユーザーがストリーミング ジョブ要求の定義を指定できるようにします。 |
HDInsightStreamingActivityTypeProperties定義 |
ファイルリンクサービス |
ファイルが配置されているリンクされたサービス参照。 |
LinkedServiceReference の |
ファイルパス |
ストリーミング ジョブ ファイルへのパス。 ディレクトリを指定できます。 |
any[] (必須) |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
入力 |
入力 BLOB パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
Mapper |
マッパー実行可能ファイル名。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
出力 |
出力 BLOB パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
Reducer |
Reducer 実行可能ファイル名。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightStreamingActivityTypeProperties定義
IfConditionActivity (英語)
IfConditionActivityTypeプロパティ
名前 |
説明 |
価値 |
式 |
ブール値に評価される式。 これは、実行されるアクティビティのブロック (ifTrueActivities または ifFalseActivities) を決定するために使用されます。 |
式 (必須) |
ifFalseアクティビティ |
式が false に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定しない場合、アクティビティはアクションなしで終了します。 |
アクティビティ[] |
ifTrueアクティビティ |
式が true に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定しない場合、アクティビティはアクションなしで終了します。 |
アクティビティ[] |
インテグレーションランタイムリファレンス
名前 |
説明 |
価値 |
パラメーター |
統合ランタイムの引数。 |
ParameterValueSpecification の |
referenceName(リファレンスネーム) |
統合ランタイム名を参照します。 |
string (必須) |
型 |
統合ランタイムの種類。 |
'IntegrationRuntimeReference' (必須) |
LinkedServiceReference (リンク サービス参照)
名前 |
説明 |
価値 |
パラメーター |
LinkedService の引数。 |
ParameterValueSpecification の |
referenceName(リファレンスネーム) |
LinkedService 名を参照します。 |
string (必須) |
型 |
リンクされたサービス参照の種類。 |
'LinkedServiceReference' (必須) |
ルックアップアクティビティ
LookupActivityTypeプロパティ
名前 |
説明 |
価値 |
データセット |
ルックアップ アクティビティ データセットの参照。 |
DatasetReference (必須) |
firstRowOnly (ファーストローのみ) |
最初の行またはすべての行を返すかどうか。 既定値は true です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
ソース |
コピー アクティビティ ソースと同じデータセット固有のソース プロパティ。 |
CopySource (必須) |
パラメータ定義仕様
パラメータ仕様
名前 |
説明 |
価値 |
デフォルト値 |
パラメーターの既定値。 |
任意 |
型 |
パラメーターの型。 |
'配列' 「ブール」 「フロート」 'int' 「オブジェクト」 'セキュアストリング' 'String' (必須) |
パラメータ値仕様
パラメータ値仕様
パラメータ値仕様
パラメータ値仕様
パイプライン
名前 |
説明 |
価値 |
活動 |
パイプライン内のアクティビティの一覧。 |
アクティビティ[] |
注釈 |
パイプラインの記述に使用できるタグの一覧。 |
どれでも[] |
コンカレンシー |
パイプラインの同時実行の最大数。 |
int
制約: 最小値 = 1 |
説明 |
パイプラインの説明。 |
文字列 |
パラメーター |
パイプラインのパラメーターの一覧。 |
ParameterDefinitionSpecification の |
パイプライン参照
名前 |
説明 |
価値 |
名前 |
参照名。 |
文字列 |
referenceName(リファレンスネーム) |
参照パイプライン名。 |
string (必須) |
型 |
パイプライン参照型。 |
'PipelineReference' (必須) |
RedirectIncompatibleRowSettings (リダイレクト互換性のない行設定)
名前 |
説明 |
価値 |
リンクされたサービス名 |
互換性のない行のリダイレクトに使用される Azure Storage、Storage SAS、または Azure Data Lake Store のリンクされたサービスの名前。 redirectIncompatibleRowSettings が指定されている場合は、指定する必要があります。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
パス |
リダイレクトの互換性のない行データを格納するためのパス。 型: string (または resultType 文字列を含む式)。 |
任意 |
シークレットベース
名前 |
説明 |
価値 |
型 |
AzureKeyVaultSecretReference 型の場合は 、' AzureKeyVaultSecret' に設定します。 SecureString 型の場合は 、' SecureString' に設定します。 |
'AzureKeyVaultSecret' 'SecureString' (必須) |
セキュアストリング
名前 |
説明 |
価値 |
型 |
シークレットの種類。 |
string (必須) |
価値 |
セキュリティで保護された文字列の値。 |
string (必須) |
セキュアストリング
名前 |
説明 |
価値 |
型 |
シークレットの種類。 |
'SecureString' (必須) |
価値 |
セキュリティで保護された文字列の値。 |
string (必須) |
SqlServerStoredProcedureActivity
SqlServerStoredProcedureActivityTypeProperties (英語)
SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters
SsisAccessCredential
名前 |
説明 |
価値 |
ドメイン |
Windows 認証のドメイン。 |
any (必須) |
パスワード |
Windows 認証のパスワード。 |
SecretBase (必須) |
ユーザー名 |
Windows 認証の UseName。 |
any (必須) |
SsisConnectionManager (英語)
SsisConnectionManager (英語)
SsisExecutionCredential (英語)
名前 |
説明 |
価値 |
ドメイン |
Windows 認証のドメイン。 |
any (必須) |
パスワード |
Windows 認証のパスワード。 |
SecureString (必須) |
ユーザー名 |
Windows 認証の UseName。 |
any (必須) |
SsisExecutionパラメータ
名前 |
説明 |
価値 |
価値 |
SSIS パッケージ実行パラメーター値。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
SsisLogLocation
名前 |
説明 |
価値 |
ログパス |
SSIS パッケージの実行ログ パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
型 |
SSIS ログの場所の種類。 |
'File' (必須) |
タイププロパティ |
SSIS パッケージ実行ログの場所のプロパティ。 |
SsisLogLocationTypeProperties (必須) |
SsisLogLocationTypeプロパティ
名前 |
説明 |
価値 |
accessCredential |
パッケージ実行ログ アクセス資格情報。 |
SsisAccessCredential |
logRefreshInterval (ログ更新間隔) |
ログを更新する間隔を指定します。 既定の間隔は 5 分です。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
SsisPackageロケーション
名前 |
説明 |
価値 |
パッケージパス |
SSIS パッケージ パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
型 |
SSIS パッケージの場所の種類。 |
「ファイル」 「SSISDB」 |
タイププロパティ |
SSIS パッケージの場所のプロパティ。 |
SsisPackageLocationTypeプロパティ |
SsisPackageLocationTypeプロパティ
名前 |
説明 |
価値 |
accessCredential |
パッケージ アクセス資格情報。 |
SsisAccessCredential |
configurationパス |
パッケージ実行の構成ファイル。 型: string (または resultType 文字列を含む式)。 |
任意 |
パッケージパスワード |
パッケージのパスワード。 |
シークレットベース |
SsisPropertyOverride
名前 |
説明 |
価値 |
isSensitive です |
SSIS パッケージ のプロパティオーバーライド値が機密データであるかどうかを示します。 値が true の場合、SSISDB で暗号化されます |
ブール (bool) |
価値 |
SSIS パッケージ プロパティのオーバーライド値。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
ステージング設定
名前 |
説明 |
価値 |
圧縮を有効にする |
中間ステージング経由でデータをコピーするときに圧縮を使用するかどうかを指定します。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
リンクされたサービス名 |
ステージングのリンクされたサービス参照。 |
LinkedServiceReference (必須) |
パス |
中間データを格納するためのストレージへのパス。 型: string (または resultType 文字列を含む式)。 |
任意 |
ストアドプロシージャパラメータ
名前 |
説明 |
価値 |
型 |
ストアド プロシージャのパラメーター型。 |
'ブール値' 「日付」 '10進数' 「グイド」 'int' 「Int64」 '文字列' |
価値 |
ストアド プロシージャのパラメーター値。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
UntilActivity (アンティルアクティビティ)
UntilActivityTypeProperties (アクティビティタイププロパティ)
名前 |
説明 |
価値 |
活動 |
実行するアクティビティの一覧。 |
Activity[] (必須) |
式 |
ブール値に評価される式。 ループは、この式が true に評価されるまで続行されます |
式 (必須) |
タイムアウト |
アクティビティを実行するためのタイムアウトを指定します。 値が指定されていない場合は、TimeSpan.FromDays(7) の値 (既定値として 1 週間) を受け取ります。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
ウェイトアクティビティ
WaitActivityTypeプロパティ
名前 |
説明 |
価値 |
waitTimeInSeconds (英語) |
秒単位の期間。 |
int (必須) |
ウェブアクティビティ
名前 |
説明 |
価値 |
リンクされたサービス名 |
リンクされたサービス参照。 |
LinkedServiceReference の |
ポリシー |
アクティビティ ポリシー。 |
アクティビティポリシー |
型 |
アクティビティの種類。 |
'WebActivity' (必須) |
タイププロパティ |
Web アクティビティのプロパティ。 |
WebActivityTypeProperties (必須) |
WebActivity認証
名前 |
説明 |
価値 |
パスワード |
PFX ファイルまたは基本認証のパスワード。 |
SecureString の |
PFXの |
PFX ファイルの Base64 でエンコードされた内容。 |
SecureString の |
リソース |
MSI 認証を使用するときに Azure 認証トークンが要求されるリソース。 |
文字列 |
型 |
Web アクティビティ認証 (Basic/ClientCertificate/MSI) |
string (必須) |
ユーザー名 |
基本認証の Web アクティビティ認証ユーザー名。 |
文字列 |
WebActivityTypeプロパティ
名前 |
説明 |
価値 |
認証 |
エンドポイントの呼び出しに使用される認証方法。 |
WebActivity認証 |
体 |
エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドでは必須。GET メソッドの型: string (または resultType 文字列を含む式) には使用できません。 |
任意 |
データセット |
Web エンドポイントに渡されるデータセットの一覧。 |
データセット参照[] |
disableCertValidation の無効化 |
true に設定すると、証明書の検証が無効になります。 |
ブール (bool) |
ヘッダー |
要求に送信されるヘッダーを表します。 たとえば、要求に言語と型を設定するには:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。 |
任意 |
linkedServices (リンクサービス) |
Web エンドポイントに渡されるリンクされたサービスの一覧。 |
LinkedService参照[] |
メソッド |
ターゲット エンドポイントの REST API メソッド。 |
「削除」 「ゲット」 「ポスト」 'PUT' (必須) |
URL |
Web アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
使用例
Azure クイック スタートのサンプル
次の Azure クイック スタート テンプレートには、 このリソースの種類をデプロイするための Bicep サンプルが含まれています。
ARM テンプレート リソース定義
factories/pipelines リソースの種類は、次を対象とする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.DataFactory/factories/pipelines リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.DataFactory/factories/pipelines",
"apiVersion": "2017-09-01-preview",
"name": "string",
"properties": {
"activities": [ {
"dependsOn": [
{
"activity": "string",
"dependencyConditions": [ "string" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ],
"annotations": [ {} ],
"concurrency": "int",
"description": "string",
"parameters": {
"{customized property}": {
"defaultValue": {},
"type": "string"
}
}
}
}
CopySource オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
アクティビティ オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
AzureMLBatchExecution の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "AzureMLBatchExecution",
"typeProperties": {
"globalParameters": {
"{customized property}": {}
},
"webServiceInputs": {
"{customized property}": {
"filePath": {},
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
}
},
"webServiceOutputs": {
"{customized property}": {
"filePath": {},
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
}
}
}
}
AzureMLUpdateResource の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "AzureMLUpdateResource",
"typeProperties": {
"trainedModelFilePath": {},
"trainedModelLinkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"trainedModelName": {}
}
}
ExecutePipeline の場合は、次のコマンドを使用します。
{
"type": "ExecutePipeline",
"typeProperties": {
"parameters": {
"{customized property}": {}
},
"pipeline": {
"name": "string",
"referenceName": "string",
"type": "string"
},
"waitOnCompletion": "bool"
}
}
フィルターの場合は、次を使用します。
{
"type": "Filter",
"typeProperties": {
"condition": {
"type": "string",
"value": "string"
},
"items": {
"type": "string",
"value": "string"
}
}
}
ForEach の場合は、次を使用します。
{
"type": "ForEach",
"typeProperties": {
"activities": [ {
"dependsOn": [
{
"activity": "string",
"dependencyConditions": [ "string" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ],
"batchCount": "int",
"isSequential": "bool",
"items": {
"type": "string",
"value": "string"
}
}
}
IfCondition の場合は、次を使用します。
{
"type": "IfCondition",
"typeProperties": {
"expression": {
"type": "string",
"value": "string"
},
"ifFalseActivities": [ {
"dependsOn": [
{
"activity": "string",
"dependencyConditions": [ "string" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ],
"ifTrueActivities": [ {
"dependsOn": [
{
"activity": "string",
"dependencyConditions": [ "string" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ]
}
}
Until の場合は、次を使用します。
{
"type": "Until",
"typeProperties": {
"activities": [ {
"dependsOn": [
{
"activity": "string",
"dependencyConditions": [ "string" ]
}
],
"description": "string",
"name": "string",
"type": "string"
// For remaining properties, see Activity objects
} ],
"expression": {
"type": "string",
"value": "string"
},
"timeout": {}
}
}
Wait の場合は、次の値を使用します。
{
"type": "Wait",
"typeProperties": {
"waitTimeInSeconds": "int"
}
}
コピーの場合は、次の値を使用します。
{
"inputs": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"outputs": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "Copy",
"typeProperties": {
"cloudDataMovementUnits": {},
"enableSkipIncompatibleRow": {},
"enableStaging": {},
"parallelCopies": {},
"redirectIncompatibleRowSettings": {
"linkedServiceName": {},
"path": {}
},
"sink": {
"sinkRetryCount": {},
"sinkRetryWait": {},
"writeBatchSize": {},
"writeBatchTimeout": {},
"type": "string"
// For remaining properties, see CopySink objects
},
"source": {
"sourceRetryCount": {},
"sourceRetryWait": {},
"type": "string"
// For remaining properties, see CopySource objects
},
"stagingSettings": {
"enableCompression": {},
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"path": {}
},
"translator": {}
}
}
カスタムの場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "Custom",
"typeProperties": {
"command": {},
"extendedProperties": {
"{customized property}": {}
},
"folderPath": {},
"referenceObjects": {
"datasets": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"linkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
},
"resourceLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
}
}
DataLakeAnalyticsU-SQL の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "DataLakeAnalyticsU-SQL",
"typeProperties": {
"compilationMode": {},
"degreeOfParallelism": {},
"parameters": {
"{customized property}": {}
},
"priority": {},
"runtimeVersion": {},
"scriptLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"scriptPath": {}
}
}
DatabricksNotebook の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "DatabricksNotebook",
"typeProperties": {
"baseParameters": {
"{customized property}": {}
},
"notebookPath": {}
}
}
ExecuteSSISPackage の場合は、次のコマンドを使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "ExecuteSSISPackage",
"typeProperties": {
"connectVia": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"environmentPath": {},
"executionCredential": {
"domain": {},
"password": {
"type": "string",
"value": "string"
},
"userName": {}
},
"loggingLevel": {},
"logLocation": {
"logPath": {},
"type": "string",
"typeProperties": {
"accessCredential": {
"domain": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"userName": {}
},
"logRefreshInterval": {}
}
},
"packageConnectionManagers": {
"{customized property}": {
"{customized property}": {
"value": {}
}
}
},
"packageLocation": {
"packagePath": {},
"type": "string",
"typeProperties": {
"accessCredential": {
"domain": {},
"password": {
"type": "string"
// For remaining properties, see SecretBase objects
},
"userName": {}
},
"configurationPath": {},
"packagePassword": {
"type": "string"
// For remaining properties, see SecretBase objects
}
}
},
"packageParameters": {
"{customized property}": {
"value": {}
}
},
"projectConnectionManagers": {
"{customized property}": {
"{customized property}": {
"value": {}
}
}
},
"projectParameters": {
"{customized property}": {
"value": {}
}
},
"propertyOverrides": {
"{customized property}": {
"isSensitive": "bool",
"value": {}
}
},
"runtime": {}
}
}
GetMetadata の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "GetMetadata",
"typeProperties": {
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"fieldList": [ {} ]
}
}
HDInsightHive の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightHive",
"typeProperties": {
"arguments": [ {} ],
"defines": {
"{customized property}": {}
},
"getDebugInfo": "string",
"scriptLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"scriptPath": {},
"storageLinkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
}
}
HDInsightMapReduce の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightMapReduce",
"typeProperties": {
"arguments": [ {} ],
"className": {},
"defines": {
"{customized property}": {}
},
"getDebugInfo": "string",
"jarFilePath": {},
"jarLibs": [ {} ],
"jarLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"storageLinkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
}
}
HDInsightPig の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightPig",
"typeProperties": {
"arguments": [ {} ],
"defines": {
"{customized property}": {}
},
"getDebugInfo": "string",
"scriptLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"scriptPath": {},
"storageLinkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
}
}
HDInsightSpark の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightSpark",
"typeProperties": {
"arguments": [ {} ],
"className": "string",
"entryFilePath": {},
"getDebugInfo": "string",
"proxyUser": {},
"rootPath": {},
"sparkConfig": {
"{customized property}": {}
},
"sparkJobLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
}
}
HDInsightStreaming の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "HDInsightStreaming",
"typeProperties": {
"arguments": [ {} ],
"combiner": {},
"commandEnvironment": [ {} ],
"defines": {
"{customized property}": {}
},
"fileLinkedService": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"filePaths": [ {} ],
"getDebugInfo": "string",
"input": {},
"mapper": {},
"output": {},
"reducer": {},
"storageLinkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
]
}
}
ルックアップの場合は、次の値を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "Lookup",
"typeProperties": {
"dataset": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"firstRowOnly": {},
"source": {
"sourceRetryCount": {},
"sourceRetryWait": {},
"type": "string"
// For remaining properties, see CopySource objects
}
}
}
SqlServerStoredProcedure の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "SqlServerStoredProcedure",
"typeProperties": {
"storedProcedureName": {},
"storedProcedureParameters": {
"{customized property}": {
"type": "string",
"value": {}
}
}
}
}
WebActivity の場合は、次を使用します。
{
"linkedServiceName": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"policy": {
"retry": {},
"retryIntervalInSeconds": "int",
"secureOutput": "bool",
"timeout": {}
},
"type": "WebActivity",
"typeProperties": {
"authentication": {
"password": {
"type": "string",
"value": "string"
},
"pfx": {
"type": "string",
"value": "string"
},
"resource": "string",
"type": "string",
"username": "string"
},
"body": {},
"datasets": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"disableCertValidation": "bool",
"headers": {},
"linkedServices": [
{
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
}
],
"method": "string",
"url": {}
}
}
CopySink オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
SecretBase オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
AzureKeyVaultSecret の場合は、次を使用します。
{
"secretName": {},
"secretVersion": {},
"store": {
"parameters": {
"{customized property}": {}
},
"referenceName": "string",
"type": "string"
},
"type": "AzureKeyVaultSecret"
}
SecureString の場合は、次を使用します。
{
"type": "SecureString",
"value": "string"
}
プロパティ値
Microsoft.DataFactory/factories/pipelines
名前 |
説明 |
価値 |
apiVersion (英語) |
API のバージョン |
'2017-09-01-プレビュー' |
名前 |
リソース名 |
糸
制約: 最小長 = 1 最大長 = 260 パターン = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必須) |
プロパティ |
パイプラインのプロパティ。 |
パイプライン (必須) |
型 |
リソースの種類 |
'Microsoft.DataFactory / factories / pipelines' |
活動
アクティビティ依存関係
名前 |
説明 |
価値 |
アクティビティ |
アクティビティ名。 |
string (必須) |
dependency条件 |
依存関係の Match-Condition。 |
次のいずれかを含む文字列配列: 「完了しました」 「失敗しました」 「スキップ」 'Succeeded' (必須) |
アクティビティポリシー
名前 |
説明 |
価値 |
再試行 |
通常の再試行回数の最大値。 既定値は 0 です。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
retryIntervalInSeconds (秒単位) |
再試行の間隔 (秒単位)。 既定値は 30 秒です。 |
int
制約: 最小値 = 30 最大値 = 86400 |
セキュアアウトプット |
true に設定すると、アクティビティからの出力は安全と見なされ、監視には記録されません。 |
ブール (bool) |
タイムアウト |
アクティビティを実行するためのタイムアウトを指定します。 既定のタイムアウトは 7 日です。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
AzureKeyVaultSecretReference
名前 |
説明 |
価値 |
シークレット名 |
Azure Key Vault 内のシークレットの名前。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
秘密バージョン |
Azure Key Vault のシークレットのバージョン。 既定値は、シークレットの最新バージョンです。 型: string (または resultType 文字列を含む式)。 |
任意 |
保存する |
Azure Key Vault のリンクされたサービス リファレンス。 |
LinkedServiceReference (必須) |
型 |
シークレットの種類。 |
'AzureKeyVaultSecret' (必須) |
AzureMLBatchExecutionActivity
AzureMLBatchExecutionActivityTypeプロパティ
AzureMLBatchExecutionActivityTypePropertiesGlobalParameters
AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs
AzureMLUpdateResourceActivity
AzureMLUpdateResourceActivityTypeProperties のこと
名前 |
説明 |
価値 |
trainedModelFilePath (トレーニング済みモデルファイルパス) |
更新操作によってアップロードされる .ilearner ファイルを表す trainedModelLinkedService の相対ファイル パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
trainedModelLinkedServiceName さん |
更新操作によってアップロードされる .ilearner ファイルを保持する Azure Storage のリンクされたサービスの名前。 |
LinkedServiceReference (必須) |
trainedModelName (トレーニング済みモデル名) |
更新する Web サービス実験のトレーニング済みモデル モジュールの名前。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
AzureMLWebServiceFile の略
名前 |
説明 |
価値 |
ファイルパス |
LinkedService で指定された Azure Blob Storage 内のコンテナー名を含む相対ファイル パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
リンクされたサービス名 |
Azure ML WebService の入力/出力ファイルがある Azure Storage LinkedService への参照。 |
LinkedServiceReference (必須) |
コピーアクティビティ
CopyActivityTypeプロパティ
名前 |
説明 |
価値 |
cloudDataMovementUnits(クラウドデータ移動ユニット) |
このデータ移動を実行するために使用できるクラウド データ移動単位の最大数。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
enableSkipIncompatibleRow |
互換性のない行をスキップするかどうか。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
enableStagingの |
中間ステージングを使用してデータをコピーするかどうかを指定します。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
並列コピー |
データ ストアのオーバーロードを回避するために、ソースまたはシンクで開かれた同時セッションの最大数。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
redirectIncompatibleRowSettings (リダイレクト互換性のない行設定) |
EnableSkipIncompatibleRow が true の場合、互換性のない行設定をリダイレクトします。 |
RedirectIncompatibleRowSettings (リダイレクト互換性のない行設定) |
シンク |
コピー アクティビティ シンク。 |
CopySink (必須) |
ソース |
コピー アクティビティのソース。 |
CopySource (必須) |
ステージング設定 |
EnableStaging が true の場合の中間ステージング設定を指定します。 |
ステージング設定 |
Translator |
コピー アクティビティの翻訳ツール。 指定しない場合は、表形式変換プログラムが使用されます。 |
任意 |
コピーシンク
名前 |
説明 |
価値 |
シンクリトライカウント |
シンクの再試行回数。 型: 整数 (または resultType 整数を持つ式)。 |
任意 |
シンクリトライウェイト |
シンクの再試行の待機。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
型 |
|
(必須) |
writeBatchSize の |
書き込みバッチ サイズ。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
writeBatchTimeout の |
書き込みバッチ タイムアウト。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
コピーソース
名前 |
説明 |
価値 |
sourceRetryCount |
ソースの再試行回数。 型: 整数 (または resultType 整数を持つ式)。 |
任意 |
sourceRetryWait |
ソースの再試行待機。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
型 |
|
(必須) |
カスタムアクティビティ
CustomActivityReferenceオブジェクト
CustomActivityTypeプロパティ
名前 |
説明 |
価値 |
コマンド |
カスタム アクティビティの種類のコマンド: string (または resultType 文字列を含む式)。 |
any (必須) |
拡張プロパティ |
ユーザー定義プロパティ バッグ。 使用できるキーまたは値に制限はありません。 ユーザーが指定したカスタム アクティビティには、定義されたコンテンツを使用して解釈する責任があります。 |
CustomActivityTypeProperties拡張プロパティ |
フォルダパス |
リソース ファイルのフォルダー パス タイプ: string (または resultType 文字列を含む式)。 |
任意 |
referenceObjects(リファレンスオブジェクト) |
参照オブジェクト |
CustomActivityReferenceオブジェクト |
resourceLinkedService (英語) |
リソースのリンクされたサービス参照。 |
LinkedServiceReference の |
CustomActivityTypeProperties拡張プロパティ
Databricks ノートブック アクティビティ
Databricks ノートブック アクティビティ タイププロパティ
名前 |
説明 |
価値 |
ベースパラメータ |
このジョブの実行ごとに使用される基本パラメーター。ノートブックが指定されていないパラメーターを受け取る場合は、ノートブックの既定値が使用されます。 |
Databricks ノートブックアクティビティタイププロパティベースパラメーター |
ノートブックパス |
Databricks ワークスペースで実行するノートブックの絶対パス。 このパスはスラッシュで始まる必要があります。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
Databricks ノートブックアクティビティタイププロパティベースパラメーター
DataLakeAnalyticsUsqlActivity
DataLakeAnalyticsUsqlActivityTypeProperties (英語)
名前 |
説明 |
価値 |
compilationMode (コンパイルモード) |
U-SQL のコンパイル モード。 Semantic、Full、SingleBox のいずれかの値を指定する必要があります。 型: string (または resultType 文字列を含む式)。 |
任意 |
degreeOfParallelism (並列処理の度数) |
ジョブの実行に同時に使用されるノードの最大数。 既定値は 1 です。 型: 整数 (または resultType 整数を持つ式)、最小値: 1。 |
任意 |
パラメーター |
U-SQL ジョブ要求のパラメーター。 |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters |
優先権 |
キューに登録されているすべてのジョブのうち、最初に実行するように選択する必要があるジョブを決定します。 数値が小さい方が優先度が高くなります。 既定値は 1000 です。 型: 整数 (または resultType 整数を持つ式)、最小値: 1。 |
任意 |
ランタイムバージョン |
使用する U-SQL エンジンのランタイム バージョン。 型: string (または resultType 文字列を含む式)。 |
任意 |
scriptLinkedService |
スクリプトのリンクされたサービス参照。 |
LinkedServiceReference (必須) |
スクリプトパス |
U-SQL スクリプトを含むフォルダーへの大文字と小文字を区別するパス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters
データセット参照
名前 |
説明 |
価値 |
パラメーター |
データセットの引数。 |
ParameterValueSpecification の |
referenceName(リファレンスネーム) |
参照データセット名。 |
string (必須) |
型 |
データセット参照型。 |
'DatasetReference' (必須) |
パイプラインアクティビティの実行
ExecutePipelineActivityTypeProperties (英語)
名前 |
説明 |
価値 |
パラメーター |
パイプライン パラメーター。 |
ParameterValueSpecification の |
パイプライン |
パイプラインリファレンス。 |
PipelineReference (必須) |
waitOnCompletion(ウェイトン・コンプリート) |
アクティビティの実行が依存パイプラインの実行の完了を待機するかどうかを定義します。 既定値は false です。 |
ブール (bool) |
ExecuteSsisPackageActivity (英語)
ExecuteSsisPackageActivityTypeProperties (英語)
ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers
ExecuteSsisPackageActivityTypePropertiesPackageParameters
ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers (英語)
ExecuteSsisPackageActivityTypePropertiesプロジェクトパラメータ
ExecuteSsisPackageActivityTypePropertiesPropertyOverrides
表現
名前 |
説明 |
価値 |
型 |
式の型。 |
'Expression' (必須) |
価値 |
式の値。 |
string (必須) |
フィルターアクティビティ
FilterActivityTypeプロパティ
名前 |
説明 |
価値 |
条件 |
入力のフィルター処理に使用する条件。 |
式 (必須) |
アイテム |
フィルターを適用する必要がある入力配列。 |
式 (必須) |
ForEachActivity (英語)
ForEachActivityTypeProperties (各アクティビティ タイププロパティ)
名前 |
説明 |
価値 |
活動 |
実行するアクティビティの一覧。 |
Activity[] (必須) |
バッチカウント |
並列実行の数を制御するために使用されるバッチ数 (isSequential が false に設定されている場合)。 |
int
制約: 最大値 = 50 |
isSequential です。 |
ループを順番または並列で実行する必要がある場合 (最大 50) |
ブール (bool) |
アイテム |
反復処理するコレクション。 |
式 (必須) |
名前 |
説明 |
価値 |
データセット |
GetMetadata アクティビティ データセットリファレンス。 |
DatasetReference (必須) |
フィールドリスト |
データセットから取得するメタデータのフィールド。 |
どれでも[] |
HDInsightHiveアクティビティ
HDInsightHiveActivityTypeProperties (英語)
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
定義 |
ユーザーが Hive ジョブ要求の定義を指定できるようにします。 |
HDInsightHiveActivityTypePropertiesDefines |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
scriptLinkedService |
スクリプトのリンクされたサービス参照。 |
LinkedServiceReference の |
スクリプトパス |
スクリプト パス。 型: string (または resultType 文字列を含む式)。 |
任意 |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightHiveActivityTypePropertiesDefines
HDInsightMapReduceActivity
HDInsightMapReduceActivityTypeProperties
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
クラス名 |
クラス名。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
定義 |
ユーザーが MapReduce ジョブ要求の定義を指定できるようにします。 |
HDInsightMapReduceActivityTypePropertiesDefines |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
jarFilePath (日本語) |
Jar パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
jarLibsの |
Jar ライブラリ。 |
どれでも[] |
jarLinkedサービス |
Jar のリンクされたサービス 参照。 |
LinkedServiceReference の |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightMapReduceActivityTypePropertiesDefines
HDInsightPigActivity
HDInsightPigActivityTypeProperties (英語)
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
定義 |
ユーザーが Pig ジョブ要求の定義を指定できるようにします。 |
HDInsightPigActivityTypeProperties定義 |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
scriptLinkedService |
スクリプトのリンクされたサービス参照。 |
LinkedServiceReference の |
スクリプトパス |
スクリプト パス。 型: string (または resultType 文字列を含む式)。 |
任意 |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightPigActivityTypeProperties定義
HDInsightSparkアクティビティ
HDInsightSparkActivityTypeProperties
名前 |
説明 |
価値 |
引数 |
HDInsightSparkActivity に対するユーザー指定の引数。 |
どれでも[] |
クラス名 |
アプリケーションの Java/Spark メイン クラス。 |
文字列 |
entryFilePath (エントリ ファイルパス) |
実行するコード/パッケージのルート フォルダーへの相対パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
プロキシユーザー |
ジョブを実行する権限を借用するユーザー。 型: string (または resultType 文字列を含む式)。 |
任意 |
ルートパス |
ジョブのすべてのファイルの 'sparkJobLinkedService' のルート パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
sparkコンフィグ |
Spark 構成プロパティ。 |
HDInsightSparkActivityTypePropertiesSparkConfig |
sparkJobLinkedService |
エントリ ファイルと依存関係をアップロードし、ログを受信するためのストレージのリンクされたサービス。 |
LinkedServiceReference の |
HDInsightSparkActivityTypePropertiesSparkConfig
HDInsightストリーミングアクティビティ
HDInsightStreamingActivityTypeProperties (英語)
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
結合器 |
コンバイナー実行可能ファイル名。 型: string (または resultType 文字列を含む式)。 |
任意 |
コマンド環境 |
コマンド ライン環境の値。 |
どれでも[] |
定義 |
ユーザーがストリーミング ジョブ要求の定義を指定できるようにします。 |
HDInsightStreamingActivityTypeProperties定義 |
ファイルリンクサービス |
ファイルが配置されているリンクされたサービス参照。 |
LinkedServiceReference の |
ファイルパス |
ストリーミング ジョブ ファイルへのパス。 ディレクトリを指定できます。 |
any[] (必須) |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
入力 |
入力 BLOB パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
Mapper |
マッパー実行可能ファイル名。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
出力 |
出力 BLOB パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
Reducer |
Reducer 実行可能ファイル名。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightStreamingActivityTypeProperties定義
IfConditionActivity (英語)
IfConditionActivityTypeプロパティ
名前 |
説明 |
価値 |
式 |
ブール値に評価される式。 これは、実行されるアクティビティのブロック (ifTrueActivities または ifFalseActivities) を決定するために使用されます。 |
式 (必須) |
ifFalseアクティビティ |
式が false に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定しない場合、アクティビティはアクションなしで終了します。 |
アクティビティ[] |
ifTrueアクティビティ |
式が true に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定しない場合、アクティビティはアクションなしで終了します。 |
アクティビティ[] |
インテグレーションランタイムリファレンス
名前 |
説明 |
価値 |
パラメーター |
統合ランタイムの引数。 |
ParameterValueSpecification の |
referenceName(リファレンスネーム) |
統合ランタイム名を参照します。 |
string (必須) |
型 |
統合ランタイムの種類。 |
'IntegrationRuntimeReference' (必須) |
LinkedServiceReference (リンク サービス参照)
名前 |
説明 |
価値 |
パラメーター |
LinkedService の引数。 |
ParameterValueSpecification の |
referenceName(リファレンスネーム) |
LinkedService 名を参照します。 |
string (必須) |
型 |
リンクされたサービス参照の種類。 |
'LinkedServiceReference' (必須) |
ルックアップアクティビティ
LookupActivityTypeプロパティ
名前 |
説明 |
価値 |
データセット |
ルックアップ アクティビティ データセットの参照。 |
DatasetReference (必須) |
firstRowOnly (ファーストローのみ) |
最初の行またはすべての行を返すかどうか。 既定値は true です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
ソース |
コピー アクティビティ ソースと同じデータセット固有のソース プロパティ。 |
CopySource (必須) |
パラメータ定義仕様
パラメータ仕様
名前 |
説明 |
価値 |
デフォルト値 |
パラメーターの既定値。 |
任意 |
型 |
パラメーターの型。 |
'配列' 「ブール」 「フロート」 'int' 「オブジェクト」 'セキュアストリング' 'String' (必須) |
パラメータ値仕様
パラメータ値仕様
パラメータ値仕様
パラメータ値仕様
パイプライン
名前 |
説明 |
価値 |
活動 |
パイプライン内のアクティビティの一覧。 |
アクティビティ[] |
注釈 |
パイプラインの記述に使用できるタグの一覧。 |
どれでも[] |
コンカレンシー |
パイプラインの同時実行の最大数。 |
int
制約: 最小値 = 1 |
説明 |
パイプラインの説明。 |
文字列 |
パラメーター |
パイプラインのパラメーターの一覧。 |
ParameterDefinitionSpecification の |
パイプライン参照
名前 |
説明 |
価値 |
名前 |
参照名。 |
文字列 |
referenceName(リファレンスネーム) |
参照パイプライン名。 |
string (必須) |
型 |
パイプライン参照型。 |
'PipelineReference' (必須) |
RedirectIncompatibleRowSettings (リダイレクト互換性のない行設定)
名前 |
説明 |
価値 |
リンクされたサービス名 |
互換性のない行のリダイレクトに使用される Azure Storage、Storage SAS、または Azure Data Lake Store のリンクされたサービスの名前。 redirectIncompatibleRowSettings が指定されている場合は、指定する必要があります。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
パス |
リダイレクトの互換性のない行データを格納するためのパス。 型: string (または resultType 文字列を含む式)。 |
任意 |
シークレットベース
名前 |
説明 |
価値 |
型 |
AzureKeyVaultSecretReference 型の場合は 、' AzureKeyVaultSecret' に設定します。 SecureString 型の場合は 、' SecureString' に設定します。 |
'AzureKeyVaultSecret' 'SecureString' (必須) |
セキュアストリング
名前 |
説明 |
価値 |
型 |
シークレットの種類。 |
string (必須) |
価値 |
セキュリティで保護された文字列の値。 |
string (必須) |
セキュアストリング
名前 |
説明 |
価値 |
型 |
シークレットの種類。 |
'SecureString' (必須) |
価値 |
セキュリティで保護された文字列の値。 |
string (必須) |
SqlServerStoredProcedureActivity
SqlServerStoredProcedureActivityTypeProperties (英語)
SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters
SsisAccessCredential
名前 |
説明 |
価値 |
ドメイン |
Windows 認証のドメイン。 |
any (必須) |
パスワード |
Windows 認証のパスワード。 |
SecretBase (必須) |
ユーザー名 |
Windows 認証の UseName。 |
any (必須) |
SsisConnectionManager (英語)
SsisConnectionManager (英語)
SsisExecutionCredential (英語)
名前 |
説明 |
価値 |
ドメイン |
Windows 認証のドメイン。 |
any (必須) |
パスワード |
Windows 認証のパスワード。 |
SecureString (必須) |
ユーザー名 |
Windows 認証の UseName。 |
any (必須) |
SsisExecutionパラメータ
名前 |
説明 |
価値 |
価値 |
SSIS パッケージ実行パラメーター値。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
SsisLogLocation
名前 |
説明 |
価値 |
ログパス |
SSIS パッケージの実行ログ パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
型 |
SSIS ログの場所の種類。 |
'File' (必須) |
タイププロパティ |
SSIS パッケージ実行ログの場所のプロパティ。 |
SsisLogLocationTypeProperties (必須) |
SsisLogLocationTypeプロパティ
名前 |
説明 |
価値 |
accessCredential |
パッケージ実行ログ アクセス資格情報。 |
SsisAccessCredential |
logRefreshInterval (ログ更新間隔) |
ログを更新する間隔を指定します。 既定の間隔は 5 分です。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
SsisPackageロケーション
名前 |
説明 |
価値 |
パッケージパス |
SSIS パッケージ パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
型 |
SSIS パッケージの場所の種類。 |
「ファイル」 「SSISDB」 |
タイププロパティ |
SSIS パッケージの場所のプロパティ。 |
SsisPackageLocationTypeプロパティ |
SsisPackageLocationTypeプロパティ
名前 |
説明 |
価値 |
accessCredential |
パッケージ アクセス資格情報。 |
SsisAccessCredential |
configurationパス |
パッケージ実行の構成ファイル。 型: string (または resultType 文字列を含む式)。 |
任意 |
パッケージパスワード |
パッケージのパスワード。 |
シークレットベース |
SsisPropertyOverride
名前 |
説明 |
価値 |
isSensitive です |
SSIS パッケージ のプロパティオーバーライド値が機密データであるかどうかを示します。 値が true の場合、SSISDB で暗号化されます |
ブール (bool) |
価値 |
SSIS パッケージ プロパティのオーバーライド値。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
ステージング設定
名前 |
説明 |
価値 |
圧縮を有効にする |
中間ステージング経由でデータをコピーするときに圧縮を使用するかどうかを指定します。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
リンクされたサービス名 |
ステージングのリンクされたサービス参照。 |
LinkedServiceReference (必須) |
パス |
中間データを格納するためのストレージへのパス。 型: string (または resultType 文字列を含む式)。 |
任意 |
ストアドプロシージャパラメータ
名前 |
説明 |
価値 |
型 |
ストアド プロシージャのパラメーター型。 |
'ブール値' 「日付」 '10進数' 「グイド」 'int' 「Int64」 '文字列' |
価値 |
ストアド プロシージャのパラメーター値。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
UntilActivity (アンティルアクティビティ)
UntilActivityTypeProperties (アクティビティタイププロパティ)
名前 |
説明 |
価値 |
活動 |
実行するアクティビティの一覧。 |
Activity[] (必須) |
式 |
ブール値に評価される式。 ループは、この式が true に評価されるまで続行されます |
式 (必須) |
タイムアウト |
アクティビティを実行するためのタイムアウトを指定します。 値が指定されていない場合は、TimeSpan.FromDays(7) の値 (既定値として 1 週間) を受け取ります。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
ウェイトアクティビティ
WaitActivityTypeプロパティ
名前 |
説明 |
価値 |
waitTimeInSeconds (英語) |
秒単位の期間。 |
int (必須) |
ウェブアクティビティ
名前 |
説明 |
価値 |
リンクされたサービス名 |
リンクされたサービス参照。 |
LinkedServiceReference の |
ポリシー |
アクティビティ ポリシー。 |
アクティビティポリシー |
型 |
アクティビティの種類。 |
'WebActivity' (必須) |
タイププロパティ |
Web アクティビティのプロパティ。 |
WebActivityTypeProperties (必須) |
WebActivity認証
名前 |
説明 |
価値 |
パスワード |
PFX ファイルまたは基本認証のパスワード。 |
SecureString の |
PFXの |
PFX ファイルの Base64 でエンコードされた内容。 |
SecureString の |
リソース |
MSI 認証を使用するときに Azure 認証トークンが要求されるリソース。 |
文字列 |
型 |
Web アクティビティ認証 (Basic/ClientCertificate/MSI) |
string (必須) |
ユーザー名 |
基本認証の Web アクティビティ認証ユーザー名。 |
文字列 |
WebActivityTypeプロパティ
名前 |
説明 |
価値 |
認証 |
エンドポイントの呼び出しに使用される認証方法。 |
WebActivity認証 |
体 |
エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドでは必須。GET メソッドの型: string (または resultType 文字列を含む式) には使用できません。 |
任意 |
データセット |
Web エンドポイントに渡されるデータセットの一覧。 |
データセット参照[] |
disableCertValidation の無効化 |
true に設定すると、証明書の検証が無効になります。 |
ブール (bool) |
ヘッダー |
要求に送信されるヘッダーを表します。 たとえば、要求に言語と型を設定するには:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。 |
任意 |
linkedServices (リンクサービス) |
Web エンドポイントに渡されるリンクされたサービスの一覧。 |
LinkedService参照[] |
メソッド |
ターゲット エンドポイントの REST API メソッド。 |
「削除」 「ゲット」 「ポスト」 'PUT' (必須) |
URL |
Web アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
使用例
Azure クイックスタート テンプレート
次の Azure クイック スタート テンプレートでは、 このリソースの種類をデプロイします。
factories/pipelines リソースの種類は、次を対象とする操作と共にデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.DataFactory/factories/pipelines リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataFactory/factories/pipelines@2017-09-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
activities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
annotations = [
?
]
concurrency = int
description = "string"
parameters = {
{customized property} = {
defaultValue = ?
type = "string"
}
}
}
}
}
CopySource オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
アクティビティ オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
AzureMLBatchExecution の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "AzureMLBatchExecution"
typeProperties = {
globalParameters = {
{customized property} = ?
}
webServiceInputs = {
{customized property} = {
filePath = ?
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
}
}
webServiceOutputs = {
{customized property} = {
filePath = ?
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
}
}
}
}
AzureMLUpdateResource の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "AzureMLUpdateResource"
typeProperties = {
trainedModelFilePath = ?
trainedModelLinkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
trainedModelName = ?
}
}
ExecutePipeline の場合は、次のコマンドを使用します。
{
type = "ExecutePipeline"
typeProperties = {
parameters = {
{customized property} = ?
}
pipeline = {
name = "string"
referenceName = "string"
type = "string"
}
waitOnCompletion = bool
}
}
フィルターの場合は、次を使用します。
{
type = "Filter"
typeProperties = {
condition = {
type = "string"
value = "string"
}
items = {
type = "string"
value = "string"
}
}
}
ForEach の場合は、次を使用します。
{
type = "ForEach"
typeProperties = {
activities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
batchCount = int
isSequential = bool
items = {
type = "string"
value = "string"
}
}
}
IfCondition の場合は、次を使用します。
{
type = "IfCondition"
typeProperties = {
expression = {
type = "string"
value = "string"
}
ifFalseActivities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
ifTrueActivities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
}
}
Until の場合は、次を使用します。
{
type = "Until"
typeProperties = {
activities = [
{
dependsOn = [
{
activity = "string"
dependencyConditions = [
"string"
]
}
]
description = "string"
name = "string"
type = "string"
// For remaining properties, see Activity objects
}
]
expression = {
type = "string"
value = "string"
}
timeout = ?
}
}
Wait の場合は、次の値を使用します。
{
type = "Wait"
typeProperties = {
waitTimeInSeconds = int
}
}
コピーの場合は、次の値を使用します。
{
inputs = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
outputs = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "Copy"
typeProperties = {
cloudDataMovementUnits = ?
enableSkipIncompatibleRow = ?
enableStaging = ?
parallelCopies = ?
redirectIncompatibleRowSettings = {
linkedServiceName = ?
path = ?
}
sink = {
sinkRetryCount = ?
sinkRetryWait = ?
writeBatchSize = ?
writeBatchTimeout = ?
type = "string"
// For remaining properties, see CopySink objects
}
source = {
sourceRetryCount = ?
sourceRetryWait = ?
type = "string"
// For remaining properties, see CopySource objects
}
stagingSettings = {
enableCompression = ?
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
path = ?
}
translator = ?
}
}
カスタムの場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "Custom"
typeProperties = {
command = ?
extendedProperties = {
{customized property} = ?
}
folderPath = ?
referenceObjects = {
datasets = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
linkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
resourceLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
}
}
DataLakeAnalyticsU-SQL の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "DataLakeAnalyticsU-SQL"
typeProperties = {
compilationMode = ?
degreeOfParallelism = ?
parameters = {
{customized property} = ?
}
priority = ?
runtimeVersion = ?
scriptLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
scriptPath = ?
}
}
DatabricksNotebook の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "DatabricksNotebook"
typeProperties = {
baseParameters = {
{customized property} = ?
}
notebookPath = ?
}
}
ExecuteSSISPackage の場合は、次のコマンドを使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "ExecuteSSISPackage"
typeProperties = {
connectVia = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
environmentPath = ?
executionCredential = {
domain = ?
password = {
type = "string"
value = "string"
}
userName = ?
}
loggingLevel = ?
logLocation = {
logPath = ?
type = "string"
typeProperties = {
accessCredential = {
domain = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
userName = ?
}
logRefreshInterval = ?
}
}
packageConnectionManagers = {
{customized property} = {
{customized property} = {
value = ?
}
}
}
packageLocation = {
packagePath = ?
type = "string"
typeProperties = {
accessCredential = {
domain = ?
password = {
type = "string"
// For remaining properties, see SecretBase objects
}
userName = ?
}
configurationPath = ?
packagePassword = {
type = "string"
// For remaining properties, see SecretBase objects
}
}
}
packageParameters = {
{customized property} = {
value = ?
}
}
projectConnectionManagers = {
{customized property} = {
{customized property} = {
value = ?
}
}
}
projectParameters = {
{customized property} = {
value = ?
}
}
propertyOverrides = {
{customized property} = {
isSensitive = bool
value = ?
}
}
runtime = ?
}
}
GetMetadata の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "GetMetadata"
typeProperties = {
dataset = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
fieldList = [
?
]
}
}
HDInsightHive の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightHive"
typeProperties = {
arguments = [
?
]
defines = {
{customized property} = ?
}
getDebugInfo = "string"
scriptLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
scriptPath = ?
storageLinkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
}
HDInsightMapReduce の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightMapReduce"
typeProperties = {
arguments = [
?
]
className = ?
defines = {
{customized property} = ?
}
getDebugInfo = "string"
jarFilePath = ?
jarLibs = [
?
]
jarLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
storageLinkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
}
HDInsightPig の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightPig"
typeProperties = {
arguments = [
?
]
defines = {
{customized property} = ?
}
getDebugInfo = "string"
scriptLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
scriptPath = ?
storageLinkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
}
HDInsightSpark の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightSpark"
typeProperties = {
arguments = [
?
]
className = "string"
entryFilePath = ?
getDebugInfo = "string"
proxyUser = ?
rootPath = ?
sparkConfig = {
{customized property} = ?
}
sparkJobLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
}
}
HDInsightStreaming の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "HDInsightStreaming"
typeProperties = {
arguments = [
?
]
combiner = ?
commandEnvironment = [
?
]
defines = {
{customized property} = ?
}
fileLinkedService = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
filePaths = [
?
]
getDebugInfo = "string"
input = ?
mapper = ?
output = ?
reducer = ?
storageLinkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
}
}
ルックアップの場合は、次の値を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "Lookup"
typeProperties = {
dataset = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
firstRowOnly = ?
source = {
sourceRetryCount = ?
sourceRetryWait = ?
type = "string"
// For remaining properties, see CopySource objects
}
}
}
SqlServerStoredProcedure の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "SqlServerStoredProcedure"
typeProperties = {
storedProcedureName = ?
storedProcedureParameters = {
{customized property} = {
type = "string"
value = ?
}
}
}
}
WebActivity の場合は、次を使用します。
{
linkedServiceName = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
policy = {
retry = ?
retryIntervalInSeconds = int
secureOutput = bool
timeout = ?
}
type = "WebActivity"
typeProperties = {
authentication = {
password = {
type = "string"
value = "string"
}
pfx = {
type = "string"
value = "string"
}
resource = "string"
type = "string"
username = "string"
}
body = ?
datasets = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
disableCertValidation = bool
headers = ?
linkedServices = [
{
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
]
method = "string"
url = ?
}
}
CopySink オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
SecretBase オブジェクト
type プロパティを設定して、オブジェクトの型を指定します。
AzureKeyVaultSecret の場合は、次を使用します。
{
secretName = ?
secretVersion = ?
store = {
parameters = {
{customized property} = ?
}
referenceName = "string"
type = "string"
}
type = "AzureKeyVaultSecret"
}
SecureString の場合は、次を使用します。
{
type = "SecureString"
value = "string"
}
プロパティ値
Microsoft.DataFactory/factories/pipelines
名前 |
説明 |
価値 |
名前 |
リソース名 |
糸
制約: 最小長 = 1 最大長 = 260 パターン = ^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$ (必須) |
parent_id |
このリソースの親であるリソースの ID。 |
種類のリソースの ID: ファクトリ |
プロパティ |
パイプラインのプロパティ。 |
パイプライン (必須) |
型 |
リソースの種類 |
"Microsoft.DataFactory/factories/pipelines@2017-09-01-preview" (英語) |
活動
アクティビティ依存関係
名前 |
説明 |
価値 |
アクティビティ |
アクティビティ名。 |
string (必須) |
dependency条件 |
依存関係の Match-Condition。 |
次のいずれかを含む文字列配列: 「完了しました」 「失敗しました」 「スキップ」 'Succeeded' (必須) |
アクティビティポリシー
名前 |
説明 |
価値 |
再試行 |
通常の再試行回数の最大値。 既定値は 0 です。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
retryIntervalInSeconds (秒単位) |
再試行の間隔 (秒単位)。 既定値は 30 秒です。 |
int
制約: 最小値 = 30 最大値 = 86400 |
セキュアアウトプット |
true に設定すると、アクティビティからの出力は安全と見なされ、監視には記録されません。 |
ブール (bool) |
タイムアウト |
アクティビティを実行するためのタイムアウトを指定します。 既定のタイムアウトは 7 日です。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
AzureKeyVaultSecretReference
名前 |
説明 |
価値 |
シークレット名 |
Azure Key Vault 内のシークレットの名前。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
秘密バージョン |
Azure Key Vault のシークレットのバージョン。 既定値は、シークレットの最新バージョンです。 型: string (または resultType 文字列を含む式)。 |
任意 |
保存する |
Azure Key Vault のリンクされたサービス リファレンス。 |
LinkedServiceReference (必須) |
型 |
シークレットの種類。 |
'AzureKeyVaultSecret' (必須) |
AzureMLBatchExecutionActivity
AzureMLBatchExecutionActivityTypeプロパティ
AzureMLBatchExecutionActivityTypePropertiesGlobalParameters
AzureMLBatchExecutionActivityTypePropertiesWebServiceOutputs
AzureMLUpdateResourceActivity
AzureMLUpdateResourceActivityTypeProperties のこと
名前 |
説明 |
価値 |
trainedModelFilePath (トレーニング済みモデルファイルパス) |
更新操作によってアップロードされる .ilearner ファイルを表す trainedModelLinkedService の相対ファイル パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
trainedModelLinkedServiceName さん |
更新操作によってアップロードされる .ilearner ファイルを保持する Azure Storage のリンクされたサービスの名前。 |
LinkedServiceReference (必須) |
trainedModelName (トレーニング済みモデル名) |
更新する Web サービス実験のトレーニング済みモデル モジュールの名前。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
AzureMLWebServiceFile の略
名前 |
説明 |
価値 |
ファイルパス |
LinkedService で指定された Azure Blob Storage 内のコンテナー名を含む相対ファイル パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
リンクされたサービス名 |
Azure ML WebService の入力/出力ファイルがある Azure Storage LinkedService への参照。 |
LinkedServiceReference (必須) |
コピーアクティビティ
CopyActivityTypeプロパティ
名前 |
説明 |
価値 |
cloudDataMovementUnits(クラウドデータ移動ユニット) |
このデータ移動を実行するために使用できるクラウド データ移動単位の最大数。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
enableSkipIncompatibleRow |
互換性のない行をスキップするかどうか。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
enableStagingの |
中間ステージングを使用してデータをコピーするかどうかを指定します。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
並列コピー |
データ ストアのオーバーロードを回避するために、ソースまたはシンクで開かれた同時セッションの最大数。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
redirectIncompatibleRowSettings (リダイレクト互換性のない行設定) |
EnableSkipIncompatibleRow が true の場合、互換性のない行設定をリダイレクトします。 |
RedirectIncompatibleRowSettings (リダイレクト互換性のない行設定) |
シンク |
コピー アクティビティ シンク。 |
CopySink (必須) |
ソース |
コピー アクティビティのソース。 |
CopySource (必須) |
ステージング設定 |
EnableStaging が true の場合の中間ステージング設定を指定します。 |
ステージング設定 |
Translator |
コピー アクティビティの翻訳ツール。 指定しない場合は、表形式変換プログラムが使用されます。 |
任意 |
コピーシンク
名前 |
説明 |
価値 |
シンクリトライカウント |
シンクの再試行回数。 型: 整数 (または resultType 整数を持つ式)。 |
任意 |
シンクリトライウェイト |
シンクの再試行の待機。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
型 |
|
(必須) |
writeBatchSize の |
書き込みバッチ サイズ。 型: 整数 (または resultType 整数を持つ式)、最小値: 0。 |
任意 |
writeBatchTimeout の |
書き込みバッチ タイムアウト。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
コピーソース
名前 |
説明 |
価値 |
sourceRetryCount |
ソースの再試行回数。 型: 整数 (または resultType 整数を持つ式)。 |
任意 |
sourceRetryWait |
ソースの再試行待機。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
型 |
|
(必須) |
カスタムアクティビティ
CustomActivityReferenceオブジェクト
CustomActivityTypeプロパティ
名前 |
説明 |
価値 |
コマンド |
カスタム アクティビティの種類のコマンド: string (または resultType 文字列を含む式)。 |
any (必須) |
拡張プロパティ |
ユーザー定義プロパティ バッグ。 使用できるキーまたは値に制限はありません。 ユーザーが指定したカスタム アクティビティには、定義されたコンテンツを使用して解釈する責任があります。 |
CustomActivityTypeProperties拡張プロパティ |
フォルダパス |
リソース ファイルのフォルダー パス タイプ: string (または resultType 文字列を含む式)。 |
任意 |
referenceObjects(リファレンスオブジェクト) |
参照オブジェクト |
CustomActivityReferenceオブジェクト |
resourceLinkedService (英語) |
リソースのリンクされたサービス参照。 |
LinkedServiceReference の |
CustomActivityTypeProperties拡張プロパティ
Databricks ノートブック アクティビティ
Databricks ノートブック アクティビティ タイププロパティ
名前 |
説明 |
価値 |
ベースパラメータ |
このジョブの実行ごとに使用される基本パラメーター。ノートブックが指定されていないパラメーターを受け取る場合は、ノートブックの既定値が使用されます。 |
Databricks ノートブックアクティビティタイププロパティベースパラメーター |
ノートブックパス |
Databricks ワークスペースで実行するノートブックの絶対パス。 このパスはスラッシュで始まる必要があります。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
Databricks ノートブックアクティビティタイププロパティベースパラメーター
DataLakeAnalyticsUsqlActivity
DataLakeAnalyticsUsqlActivityTypeProperties (英語)
名前 |
説明 |
価値 |
compilationMode (コンパイルモード) |
U-SQL のコンパイル モード。 Semantic、Full、SingleBox のいずれかの値を指定する必要があります。 型: string (または resultType 文字列を含む式)。 |
任意 |
degreeOfParallelism (並列処理の度数) |
ジョブの実行に同時に使用されるノードの最大数。 既定値は 1 です。 型: 整数 (または resultType 整数を持つ式)、最小値: 1。 |
任意 |
パラメーター |
U-SQL ジョブ要求のパラメーター。 |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters |
優先権 |
キューに登録されているすべてのジョブのうち、最初に実行するように選択する必要があるジョブを決定します。 数値が小さい方が優先度が高くなります。 既定値は 1000 です。 型: 整数 (または resultType 整数を持つ式)、最小値: 1。 |
任意 |
ランタイムバージョン |
使用する U-SQL エンジンのランタイム バージョン。 型: string (または resultType 文字列を含む式)。 |
任意 |
scriptLinkedService |
スクリプトのリンクされたサービス参照。 |
LinkedServiceReference (必須) |
スクリプトパス |
U-SQL スクリプトを含むフォルダーへの大文字と小文字を区別するパス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
DataLakeAnalyticsUsqlActivityTypePropertiesParameters
データセット参照
名前 |
説明 |
価値 |
パラメーター |
データセットの引数。 |
ParameterValueSpecification の |
referenceName(リファレンスネーム) |
参照データセット名。 |
string (必須) |
型 |
データセット参照型。 |
'DatasetReference' (必須) |
パイプラインアクティビティの実行
ExecutePipelineActivityTypeProperties (英語)
名前 |
説明 |
価値 |
パラメーター |
パイプライン パラメーター。 |
ParameterValueSpecification の |
パイプライン |
パイプラインリファレンス。 |
PipelineReference (必須) |
waitOnCompletion(ウェイトン・コンプリート) |
アクティビティの実行が依存パイプラインの実行の完了を待機するかどうかを定義します。 既定値は false です。 |
ブール (bool) |
ExecuteSsisPackageActivity (英語)
ExecuteSsisPackageActivityTypeProperties (英語)
ExecuteSsisPackageActivityTypePropertiesPackageConnectionManagers
ExecuteSsisPackageActivityTypePropertiesPackageParameters
ExecuteSsisPackageActivityTypePropertiesProjectConnectionManagers (英語)
ExecuteSsisPackageActivityTypePropertiesプロジェクトパラメータ
ExecuteSsisPackageActivityTypePropertiesPropertyOverrides
表現
名前 |
説明 |
価値 |
型 |
式の型。 |
'Expression' (必須) |
価値 |
式の値。 |
string (必須) |
フィルターアクティビティ
FilterActivityTypeプロパティ
名前 |
説明 |
価値 |
条件 |
入力のフィルター処理に使用する条件。 |
式 (必須) |
アイテム |
フィルターを適用する必要がある入力配列。 |
式 (必須) |
ForEachActivity (英語)
ForEachActivityTypeProperties (各アクティビティ タイププロパティ)
名前 |
説明 |
価値 |
活動 |
実行するアクティビティの一覧。 |
Activity[] (必須) |
バッチカウント |
並列実行の数を制御するために使用されるバッチ数 (isSequential が false に設定されている場合)。 |
int
制約: 最大値 = 50 |
isSequential です。 |
ループを順番または並列で実行する必要がある場合 (最大 50) |
ブール (bool) |
アイテム |
反復処理するコレクション。 |
式 (必須) |
名前 |
説明 |
価値 |
データセット |
GetMetadata アクティビティ データセットリファレンス。 |
DatasetReference (必須) |
フィールドリスト |
データセットから取得するメタデータのフィールド。 |
どれでも[] |
HDInsightHiveアクティビティ
HDInsightHiveActivityTypeProperties (英語)
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
定義 |
ユーザーが Hive ジョブ要求の定義を指定できるようにします。 |
HDInsightHiveActivityTypePropertiesDefines |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
scriptLinkedService |
スクリプトのリンクされたサービス参照。 |
LinkedServiceReference の |
スクリプトパス |
スクリプト パス。 型: string (または resultType 文字列を含む式)。 |
任意 |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightHiveActivityTypePropertiesDefines
HDInsightMapReduceActivity
HDInsightMapReduceActivityTypeProperties
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
クラス名 |
クラス名。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
定義 |
ユーザーが MapReduce ジョブ要求の定義を指定できるようにします。 |
HDInsightMapReduceActivityTypePropertiesDefines |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
jarFilePath (日本語) |
Jar パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
jarLibsの |
Jar ライブラリ。 |
どれでも[] |
jarLinkedサービス |
Jar のリンクされたサービス 参照。 |
LinkedServiceReference の |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightMapReduceActivityTypePropertiesDefines
HDInsightPigActivity
HDInsightPigActivityTypeProperties (英語)
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
定義 |
ユーザーが Pig ジョブ要求の定義を指定できるようにします。 |
HDInsightPigActivityTypeProperties定義 |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
scriptLinkedService |
スクリプトのリンクされたサービス参照。 |
LinkedServiceReference の |
スクリプトパス |
スクリプト パス。 型: string (または resultType 文字列を含む式)。 |
任意 |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightPigActivityTypeProperties定義
HDInsightSparkアクティビティ
HDInsightSparkActivityTypeProperties
名前 |
説明 |
価値 |
引数 |
HDInsightSparkActivity に対するユーザー指定の引数。 |
どれでも[] |
クラス名 |
アプリケーションの Java/Spark メイン クラス。 |
文字列 |
entryFilePath (エントリ ファイルパス) |
実行するコード/パッケージのルート フォルダーへの相対パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
プロキシユーザー |
ジョブを実行する権限を借用するユーザー。 型: string (または resultType 文字列を含む式)。 |
任意 |
ルートパス |
ジョブのすべてのファイルの 'sparkJobLinkedService' のルート パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
sparkコンフィグ |
Spark 構成プロパティ。 |
HDInsightSparkActivityTypePropertiesSparkConfig |
sparkJobLinkedService |
エントリ ファイルと依存関係をアップロードし、ログを受信するためのストレージのリンクされたサービス。 |
LinkedServiceReference の |
HDInsightSparkActivityTypePropertiesSparkConfig
HDInsightストリーミングアクティビティ
HDInsightStreamingActivityTypeProperties (英語)
名前 |
説明 |
価値 |
引数 |
HDInsightActivity に対してユーザーが指定した引数。 |
どれでも[] |
結合器 |
コンバイナー実行可能ファイル名。 型: string (または resultType 文字列を含む式)。 |
任意 |
コマンド環境 |
コマンド ライン環境の値。 |
どれでも[] |
定義 |
ユーザーがストリーミング ジョブ要求の定義を指定できるようにします。 |
HDInsightStreamingActivityTypeProperties定義 |
ファイルリンクサービス |
ファイルが配置されているリンクされたサービス参照。 |
LinkedServiceReference の |
ファイルパス |
ストリーミング ジョブ ファイルへのパス。 ディレクトリを指定できます。 |
any[] (必須) |
デバッグ情報取得 |
デバッグ情報オプション。 |
「常に」 「失敗」 「なし」 |
入力 |
入力 BLOB パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
Mapper |
マッパー実行可能ファイル名。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
出力 |
出力 BLOB パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
Reducer |
Reducer 実行可能ファイル名。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
ストレージLinkedServices |
ストレージのリンクされたサービス参照。 |
LinkedService参照[] |
HDInsightStreamingActivityTypeProperties定義
IfConditionActivity (英語)
IfConditionActivityTypeプロパティ
名前 |
説明 |
価値 |
式 |
ブール値に評価される式。 これは、実行されるアクティビティのブロック (ifTrueActivities または ifFalseActivities) を決定するために使用されます。 |
式 (必須) |
ifFalseアクティビティ |
式が false に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定しない場合、アクティビティはアクションなしで終了します。 |
アクティビティ[] |
ifTrueアクティビティ |
式が true に評価された場合に実行するアクティビティの一覧。 これは省略可能なプロパティであり、指定しない場合、アクティビティはアクションなしで終了します。 |
アクティビティ[] |
インテグレーションランタイムリファレンス
名前 |
説明 |
価値 |
パラメーター |
統合ランタイムの引数。 |
ParameterValueSpecification の |
referenceName(リファレンスネーム) |
統合ランタイム名を参照します。 |
string (必須) |
型 |
統合ランタイムの種類。 |
'IntegrationRuntimeReference' (必須) |
LinkedServiceReference (リンク サービス参照)
名前 |
説明 |
価値 |
パラメーター |
LinkedService の引数。 |
ParameterValueSpecification の |
referenceName(リファレンスネーム) |
LinkedService 名を参照します。 |
string (必須) |
型 |
リンクされたサービス参照の種類。 |
'LinkedServiceReference' (必須) |
ルックアップアクティビティ
LookupActivityTypeプロパティ
名前 |
説明 |
価値 |
データセット |
ルックアップ アクティビティ データセットの参照。 |
DatasetReference (必須) |
firstRowOnly (ファーストローのみ) |
最初の行またはすべての行を返すかどうか。 既定値は true です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
ソース |
コピー アクティビティ ソースと同じデータセット固有のソース プロパティ。 |
CopySource (必須) |
パラメータ定義仕様
パラメータ仕様
名前 |
説明 |
価値 |
デフォルト値 |
パラメーターの既定値。 |
任意 |
型 |
パラメーターの型。 |
'配列' 「ブール」 「フロート」 'int' 「オブジェクト」 'セキュアストリング' 'String' (必須) |
パラメータ値仕様
パラメータ値仕様
パラメータ値仕様
パラメータ値仕様
パイプライン
名前 |
説明 |
価値 |
活動 |
パイプライン内のアクティビティの一覧。 |
アクティビティ[] |
注釈 |
パイプラインの記述に使用できるタグの一覧。 |
どれでも[] |
コンカレンシー |
パイプラインの同時実行の最大数。 |
int
制約: 最小値 = 1 |
説明 |
パイプラインの説明。 |
文字列 |
パラメーター |
パイプラインのパラメーターの一覧。 |
ParameterDefinitionSpecification の |
パイプライン参照
名前 |
説明 |
価値 |
名前 |
参照名。 |
文字列 |
referenceName(リファレンスネーム) |
参照パイプライン名。 |
string (必須) |
型 |
パイプライン参照型。 |
'PipelineReference' (必須) |
RedirectIncompatibleRowSettings (リダイレクト互換性のない行設定)
名前 |
説明 |
価値 |
リンクされたサービス名 |
互換性のない行のリダイレクトに使用される Azure Storage、Storage SAS、または Azure Data Lake Store のリンクされたサービスの名前。 redirectIncompatibleRowSettings が指定されている場合は、指定する必要があります。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
パス |
リダイレクトの互換性のない行データを格納するためのパス。 型: string (または resultType 文字列を含む式)。 |
任意 |
シークレットベース
名前 |
説明 |
価値 |
型 |
AzureKeyVaultSecretReference 型の場合は 、' AzureKeyVaultSecret' に設定します。 SecureString 型の場合は 、' SecureString' に設定します。 |
'AzureKeyVaultSecret' 'SecureString' (必須) |
セキュアストリング
名前 |
説明 |
価値 |
型 |
シークレットの種類。 |
string (必須) |
価値 |
セキュリティで保護された文字列の値。 |
string (必須) |
セキュアストリング
名前 |
説明 |
価値 |
型 |
シークレットの種類。 |
'SecureString' (必須) |
価値 |
セキュリティで保護された文字列の値。 |
string (必須) |
SqlServerStoredProcedureActivity
SqlServerStoredProcedureActivityTypeProperties (英語)
SqlServerStoredProcedureActivityTypePropertiesStoredProcedureParameters
SsisAccessCredential
名前 |
説明 |
価値 |
ドメイン |
Windows 認証のドメイン。 |
any (必須) |
パスワード |
Windows 認証のパスワード。 |
SecretBase (必須) |
ユーザー名 |
Windows 認証の UseName。 |
any (必須) |
SsisConnectionManager (英語)
SsisConnectionManager (英語)
SsisExecutionCredential (英語)
名前 |
説明 |
価値 |
ドメイン |
Windows 認証のドメイン。 |
any (必須) |
パスワード |
Windows 認証のパスワード。 |
SecureString (必須) |
ユーザー名 |
Windows 認証の UseName。 |
any (必須) |
SsisExecutionパラメータ
名前 |
説明 |
価値 |
価値 |
SSIS パッケージ実行パラメーター値。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
SsisLogLocation
名前 |
説明 |
価値 |
ログパス |
SSIS パッケージの実行ログ パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
型 |
SSIS ログの場所の種類。 |
'File' (必須) |
タイププロパティ |
SSIS パッケージ実行ログの場所のプロパティ。 |
SsisLogLocationTypeProperties (必須) |
SsisLogLocationTypeプロパティ
名前 |
説明 |
価値 |
accessCredential |
パッケージ実行ログ アクセス資格情報。 |
SsisAccessCredential |
logRefreshInterval (ログ更新間隔) |
ログを更新する間隔を指定します。 既定の間隔は 5 分です。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
SsisPackageロケーション
名前 |
説明 |
価値 |
パッケージパス |
SSIS パッケージ パス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
型 |
SSIS パッケージの場所の種類。 |
「ファイル」 「SSISDB」 |
タイププロパティ |
SSIS パッケージの場所のプロパティ。 |
SsisPackageLocationTypeプロパティ |
SsisPackageLocationTypeプロパティ
名前 |
説明 |
価値 |
accessCredential |
パッケージ アクセス資格情報。 |
SsisAccessCredential |
configurationパス |
パッケージ実行の構成ファイル。 型: string (または resultType 文字列を含む式)。 |
任意 |
パッケージパスワード |
パッケージのパスワード。 |
シークレットベース |
SsisPropertyOverride
名前 |
説明 |
価値 |
isSensitive です |
SSIS パッケージ のプロパティオーバーライド値が機密データであるかどうかを示します。 値が true の場合、SSISDB で暗号化されます |
ブール (bool) |
価値 |
SSIS パッケージ プロパティのオーバーライド値。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
ステージング設定
名前 |
説明 |
価値 |
圧縮を有効にする |
中間ステージング経由でデータをコピーするときに圧縮を使用するかどうかを指定します。 既定値は false です。 型: boolean (または resultType ブール値を持つ式)。 |
任意 |
リンクされたサービス名 |
ステージングのリンクされたサービス参照。 |
LinkedServiceReference (必須) |
パス |
中間データを格納するためのストレージへのパス。 型: string (または resultType 文字列を含む式)。 |
任意 |
ストアドプロシージャパラメータ
名前 |
説明 |
価値 |
型 |
ストアド プロシージャのパラメーター型。 |
'ブール値' 「日付」 '10進数' 「グイド」 'int' 「Int64」 '文字列' |
価値 |
ストアド プロシージャのパラメーター値。 型: string (または resultType 文字列を含む式)。 |
any (必須) |
UntilActivity (アンティルアクティビティ)
UntilActivityTypeProperties (アクティビティタイププロパティ)
名前 |
説明 |
価値 |
活動 |
実行するアクティビティの一覧。 |
Activity[] (必須) |
式 |
ブール値に評価される式。 ループは、この式が true に評価されるまで続行されます |
式 (必須) |
タイムアウト |
アクティビティを実行するためのタイムアウトを指定します。 値が指定されていない場合は、TimeSpan.FromDays(7) の値 (既定値として 1 週間) を受け取ります。 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). 型: string (または resultType 文字列を含む式)、パターン: (\d+)。?(\d\d):(60|([0-5][0-9]))):(60|([0-5][0-9])). |
任意 |
ウェイトアクティビティ
WaitActivityTypeプロパティ
名前 |
説明 |
価値 |
waitTimeInSeconds (英語) |
秒単位の期間。 |
int (必須) |
ウェブアクティビティ
名前 |
説明 |
価値 |
リンクされたサービス名 |
リンクされたサービス参照。 |
LinkedServiceReference の |
ポリシー |
アクティビティ ポリシー。 |
アクティビティポリシー |
型 |
アクティビティの種類。 |
'WebActivity' (必須) |
タイププロパティ |
Web アクティビティのプロパティ。 |
WebActivityTypeProperties (必須) |
WebActivity認証
名前 |
説明 |
価値 |
パスワード |
PFX ファイルまたは基本認証のパスワード。 |
SecureString の |
PFXの |
PFX ファイルの Base64 でエンコードされた内容。 |
SecureString の |
リソース |
MSI 認証を使用するときに Azure 認証トークンが要求されるリソース。 |
文字列 |
型 |
Web アクティビティ認証 (Basic/ClientCertificate/MSI) |
string (必須) |
ユーザー名 |
基本認証の Web アクティビティ認証ユーザー名。 |
文字列 |
WebActivityTypeプロパティ
名前 |
説明 |
価値 |
認証 |
エンドポイントの呼び出しに使用される認証方法。 |
WebActivity認証 |
体 |
エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドでは必須。GET メソッドの型: string (または resultType 文字列を含む式) には使用できません。 |
任意 |
データセット |
Web エンドポイントに渡されるデータセットの一覧。 |
データセット参照[] |
disableCertValidation の無効化 |
true に設定すると、証明書の検証が無効になります。 |
ブール (bool) |
ヘッダー |
要求に送信されるヘッダーを表します。 たとえば、要求に言語と型を設定するには:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。 |
任意 |
linkedServices (リンクサービス) |
Web エンドポイントに渡されるリンクされたサービスの一覧。 |
LinkedService参照[] |
メソッド |
ターゲット エンドポイントの REST API メソッド。 |
「削除」 「ゲット」 「ポスト」 'PUT' (必須) |
URL |
Web アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。 |
any (必須) |