Functions interface
関数を表すインターフェイス。
メソッド
メソッドの詳細
beginTest(string, string, string, FunctionsTestOptionalParams)
関数に指定された情報が有効かどうかをテストします。 これは、関数の背後にある基になる Web サービスへの接続のテストや、指定された関数コードが構文的に正しいことを確認することまで多岐に渡ります。
function beginTest(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsTestOptionalParams): Promise<PollerLike<PollOperationState<ResourceTestStatus>, ResourceTestStatus>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- jobName
-
string
ストリーミング ジョブの名前。
- functionName
-
string
関数の名前。
- options
- FunctionsTestOptionalParams
オプション パラメーター。
戻り値
Promise<PollerLike<@azure/core-lro.PollOperationState<ResourceTestStatus>, ResourceTestStatus>>
beginTestAndWait(string, string, string, FunctionsTestOptionalParams)
関数に指定された情報が有効かどうかをテストします。 これは、関数の背後にある基になる Web サービスへの接続のテストや、指定された関数コードが構文的に正しいことを確認することまで多岐に渡ります。
function beginTestAndWait(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsTestOptionalParams): Promise<ResourceTestStatus>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- jobName
-
string
ストリーミング ジョブの名前。
- functionName
-
string
関数の名前。
- options
- FunctionsTestOptionalParams
オプション パラメーター。
戻り値
Promise<ResourceTestStatus>
createOrReplace(string, string, string, FunctionModel, FunctionsCreateOrReplaceOptionalParams)
既存のストリーミング ジョブの下に関数を作成するか、既存の関数を置き換えます。
function createOrReplace(resourceGroupName: string, jobName: string, functionName: string, functionParam: FunctionModel, options?: FunctionsCreateOrReplaceOptionalParams): Promise<FunctionsCreateOrReplaceResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- jobName
-
string
ストリーミング ジョブの名前。
- functionName
-
string
関数の名前。
- functionParam
- FunctionModel
新しい関数を作成したり、ストリーミング ジョブの下にある既存の関数を置き換えたりするために使用される関数の定義。
オプション パラメーター。
戻り値
Promise<FunctionsCreateOrReplaceResponse>
delete(string, string, string, FunctionsDeleteOptionalParams)
ストリーミング ジョブから関数を削除します。
function delete(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- jobName
-
string
ストリーミング ジョブの名前。
- functionName
-
string
関数の名前。
- options
- FunctionsDeleteOptionalParams
オプション パラメーター。
戻り値
Promise<void>
get(string, string, string, FunctionsGetOptionalParams)
指定した関数に関する詳細を取得します。
function get(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsGetOptionalParams): Promise<FunctionsGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- jobName
-
string
ストリーミング ジョブの名前。
- functionName
-
string
関数の名前。
- options
- FunctionsGetOptionalParams
オプション パラメーター。
戻り値
Promise<FunctionsGetResponse>
listByStreamingJob(string, string, FunctionsListByStreamingJobOptionalParams)
指定したストリーミング ジョブのすべての関数を一覧表示します。
function listByStreamingJob(resourceGroupName: string, jobName: string, options?: FunctionsListByStreamingJobOptionalParams): PagedAsyncIterableIterator<FunctionModel, FunctionModel[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- jobName
-
string
ストリーミング ジョブの名前。
オプション パラメーター。
戻り値
retrieveDefaultDefinition(string, string, string, FunctionsRetrieveDefaultDefinitionOptionalParams)
指定されたパラメーターに基づいて、関数の既定の定義を取得します。
function retrieveDefaultDefinition(resourceGroupName: string, jobName: string, functionName: string, options?: FunctionsRetrieveDefaultDefinitionOptionalParams): Promise<FunctionModel>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- jobName
-
string
ストリーミング ジョブの名前。
- functionName
-
string
関数の名前。
オプション パラメーター。
戻り値
Promise<FunctionModel>
update(string, string, string, FunctionModel, FunctionsUpdateOptionalParams)
既存のストリーミング ジョブの下にある既存の関数を更新します。 これは、ジョブまたは関数定義の残りの部分に影響を与えることなく、関数を部分的に更新 (つまり、1 つまたは 2 つのプロパティを更新) するために使用できます。
function update(resourceGroupName: string, jobName: string, functionName: string, functionParam: FunctionModel, options?: FunctionsUpdateOptionalParams): Promise<FunctionsUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- jobName
-
string
ストリーミング ジョブの名前。
- functionName
-
string
関数の名前。
- functionParam
- FunctionModel
関数オブジェクト。 ここで指定したプロパティは、既存の関数 (つまり、これらのプロパティは更新されます)。 ここで null に設定されているプロパティは、既存の関数の対応するプロパティは同じままであり、この PATCH 操作の結果として変更されないことを意味します。
- options
- FunctionsUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<FunctionsUpdateResponse>