TriggerRunsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:trigger_runs> attribute.
Constructor
TriggerRunsOperations(*args, **kwargs)Methods
| cancel |
Cancel a single trigger instance by runId. |
| query_by_factory |
Query trigger runs. |
| rerun |
Rerun single trigger instance by runId. |
cancel
Cancel a single trigger instance by runId.
cancel(resource_group_name: str, factory_name: str, trigger_name: str, run_id: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
factory_name
Required
|
Required. |
|
trigger_name
Required
|
Required. |
|
run_id
Required
|
The pipeline run identifier. Required. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
query_by_factory
Query trigger runs.
query_by_factory(resource_group_name: str, factory_name: str, filter_parameters: _models.RunFilterParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.TriggerRunsQueryResponseParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
factory_name
Required
|
The factory name. Required. |
|
filter_parameters
Required
|
Parameters to filter the pipeline run. Is either a RunFilterParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
TriggerRunsQueryResponse. The TriggerRunsQueryResponse is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
rerun
Rerun single trigger instance by runId.
rerun(resource_group_name: str, factory_name: str, trigger_name: str, run_id: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
factory_name
Required
|
Required. |
|
trigger_name
Required
|
Required. |
|
run_id
Required
|
The pipeline run identifier. Required. |
Returns
| Type | Description |
|---|---|
|
None |
Exceptions
| Type | Description |
|---|---|
