WebActivity interface

パッケージ:

@azure/synapse-artifacts

Web アクティビティ。

Extends

ExecutionActivity

プロパティ

authentication	エンドポイントの呼び出しに使用される認証方法。
body	エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドでは必須。GET メソッドの型: string (または resultType 文字列を含む式) には使用できません。
connectVia	統合ランタイムリファレンス。
datasets	Web エンドポイントに渡されるデータセットの一覧。
headers	要求に送信されるヘッダーを表します。 たとえば、要求に言語と型を設定するには:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。
linkedServices	Web エンドポイントに渡されるリンクされたサービスの一覧。
method	ターゲット エンドポイントの REST API メソッド。
type	ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。
url	Web アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。

継承されたプロパティ

dependsOn	アクティビティは条件によって異なります。
description	アクティビティの説明。
linkedServiceName	リンクされたサービス参照。
name	アクティビティ名。
onInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブのときに指定されていない場合、状態は既定で Succeeded になります。
policy	アクティビティ ポリシー。
state	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定でアクティブになります。
userProperties	アクティビティ ユーザーのプロパティ。

プロパティの詳細

authentication

エンドポイントの呼び出しに使用される認証方法。

authentication?: WebActivityAuthentication

プロパティ値

WebActivityAuthentication

body

エンドポイントに送信されるペイロードを表します。 POST/PUT メソッドでは必須。GET メソッドの型: string (または resultType 文字列を含む式) には使用できません。

body?: any

プロパティ値

any

connectVia

統合ランタイムリファレンス。

connectVia?: IntegrationRuntimeReference

プロパティ値

IntegrationRuntimeReference

datasets

Web エンドポイントに渡されるデータセットの一覧。

datasets?: DatasetReference[]

プロパティ値

DatasetReference[]

headers

要求に送信されるヘッダーを表します。 たとえば、要求に言語と型を設定するには:"headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }。 型: string (または resultType 文字列を含む式)。

headers?: any

プロパティ値

any

linkedServices

Web エンドポイントに渡されるリンクされたサービスの一覧。

linkedServices?: LinkedServiceReference[]

プロパティ値

LinkedServiceReference[]

method

ターゲット エンドポイントの REST API メソッド。

method: string

プロパティ値

string

type

ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

type: "WebActivity"

プロパティ値

"WebActivity"

url

Web アクティビティのターゲット エンドポイントとパス。 型: string (または resultType 文字列を含む式)。

url: any

プロパティ値

any

継承されたプロパティの詳細

dependsOn

アクティビティは条件によって異なります。

dependsOn?: ActivityDependency[]

プロパティ値

ActivityDependency[]

ExecutionActivity.dependsOnから継承

description

アクティビティの説明。

description?: string

プロパティ値

string

ExecutionActivity.descriptionから継承

linkedServiceName

リンクされたサービス参照。

linkedServiceName?: LinkedServiceReference

プロパティ値

LinkedServiceReference

ExecutionActivity.linkedServiceNameから継承

name

アクティビティ名。

name: string

プロパティ値

string

ExecutionActivity.name から継承

onInactiveMarkAs

状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブのときに指定されていない場合、状態は既定で Succeeded になります。

onInactiveMarkAs?: string

プロパティ値

string

ExecutionActivity.onInactiveMarkAsから継承

policy

アクティビティ ポリシー。

policy?: ActivityPolicy

プロパティ値

ActivityPolicy

ExecutionActivity.policyから継承

state

アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定でアクティブになります。

state?: string

プロパティ値

string

ExecutionActivity.stateから継承

userProperties

アクティビティ ユーザーのプロパティ。

userProperties?: UserProperty[]

プロパティ値

UserProperty[]

ExecutionActivity.userPropertiesから継承