WorkflowRunsOperations クラス

  • リファレンス

警告

このクラスを直接インスタンス化しないでください。

代わりに、次の操作にアクセスする必要があります。

WebSiteManagementClient's

<xref:workflow_runs> 属性を使用する。

継承
builtins.object
WorkflowRunsOperations

コンストラクター

WorkflowRunsOperations(*args, **kwargs)

メソッド

cancel

ワークフローの実行を取り消します。
get

ワークフローの実行を取得します。
list

ワークフロー実行の一覧を取得します。

cancel

ワークフローの実行を取り消します。

cancel(resource_group_name: str, name: str, workflow_name: str, run_name: str, **kwargs: Any) -> None

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

サイト名。 必須。

workflow_name
str
必須

ワークフロー名 必須。

run_name
str
必須

ワークフローの実行名。 必須。

cls
callable

直接応答が渡されるカスタム型または関数

戻り値

なしまたは cls(response) の結果

の戻り値の型 :

None

例外

HttpResponseError

get

ワークフローの実行を取得します。

get(resource_group_name: str, name: str, workflow_name: str, run_name: str, **kwargs: Any) -> WorkflowRun

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

サイト名。 必須。

workflow_name
str
必須

ワークフロー名 必須。

run_name
str
必須

ワークフローの実行名。 必須。

cls
callable

直接応答が渡されるカスタム型または関数

戻り値

WorkflowRun または cls(response) の結果

の戻り値の型 :

WorkflowRun

例外

HttpResponseError

list

ワークフロー実行の一覧を取得します。

list(resource_group_name: str, name: str, workflow_name: str, top: int | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[WorkflowRun]

パラメーター

resource_group_name
str
必須

リソースが属しているリソース グループの名前。 必須。

name
str
必須

サイト名。 必須。

workflow_name
str
必須

ワークフロー名 必須。

top
int
必須

結果に含める項目の数。 既定値は [なし] です。

filter
str
必須

操作に適用するフィルター。 フィルターのオプションには、Status、StartTime、ClientTrackingId があります。 既定値は [なし] です。

cls
callable

直接応答が渡されるカスタム型または関数

戻り値

WorkflowRun または cls(response) の結果のいずれかのインスタンスのような反復子

の戻り値の型 :

ItemPaged[WorkflowRun]

例外

HttpResponseError

属性

models 

models = <module 'azure.mgmt.web.v2023_01_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2023_01_01\\models\\__init__.py'>