Runs interface
Interface representing a Runs.
Methods
begin |
Cancel an existing run. |
begin |
Cancel an existing run. |
begin |
Patch the run properties. |
begin |
Patch the run properties. |
get(string, string, string, Runs |
Gets the detailed information for a given run. |
get |
Gets a link to download the run logs. |
list(string, string, Runs |
Gets all the runs for a registry. |
Method Details
beginCancel(string, string, string, RunsCancelOptionalParams)
Cancel an existing run.
function beginCancel(resourceGroupName: string, registryName: string, runId: string, options?: RunsCancelOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parameters
- resourceGroupName
-
string
The name of the resource group to which the container registry belongs.
- registryName
-
string
The name of the container registry.
- runId
-
string
The run ID.
- options
- RunsCancelOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginCancelAndWait(string, string, string, RunsCancelOptionalParams)
Cancel an existing run.
function beginCancelAndWait(resourceGroupName: string, registryName: string, runId: string, options?: RunsCancelOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
The name of the resource group to which the container registry belongs.
- registryName
-
string
The name of the container registry.
- runId
-
string
The run ID.
- options
- RunsCancelOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, RunUpdateParameters, RunsUpdateOptionalParams)
Patch the run properties.
function beginUpdate(resourceGroupName: string, registryName: string, runId: string, runUpdateParameters: RunUpdateParameters, options?: RunsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Run>, Run>>
Parameters
- resourceGroupName
-
string
The name of the resource group to which the container registry belongs.
- registryName
-
string
The name of the container registry.
- runId
-
string
The run ID.
- runUpdateParameters
- RunUpdateParameters
The run update properties.
- options
- RunsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Run>, Run>>
beginUpdateAndWait(string, string, string, RunUpdateParameters, RunsUpdateOptionalParams)
Patch the run properties.
function beginUpdateAndWait(resourceGroupName: string, registryName: string, runId: string, runUpdateParameters: RunUpdateParameters, options?: RunsUpdateOptionalParams): Promise<Run>
Parameters
- resourceGroupName
-
string
The name of the resource group to which the container registry belongs.
- registryName
-
string
The name of the container registry.
- runId
-
string
The run ID.
- runUpdateParameters
- RunUpdateParameters
The run update properties.
- options
- RunsUpdateOptionalParams
The options parameters.
Returns
Promise<Run>
get(string, string, string, RunsGetOptionalParams)
Gets the detailed information for a given run.
function get(resourceGroupName: string, registryName: string, runId: string, options?: RunsGetOptionalParams): Promise<Run>
Parameters
- resourceGroupName
-
string
The name of the resource group to which the container registry belongs.
- registryName
-
string
The name of the container registry.
- runId
-
string
The run ID.
- options
- RunsGetOptionalParams
The options parameters.
Returns
Promise<Run>
getLogSasUrl(string, string, string, RunsGetLogSasUrlOptionalParams)
Gets a link to download the run logs.
function getLogSasUrl(resourceGroupName: string, registryName: string, runId: string, options?: RunsGetLogSasUrlOptionalParams): Promise<RunGetLogResult>
Parameters
- resourceGroupName
-
string
The name of the resource group to which the container registry belongs.
- registryName
-
string
The name of the container registry.
- runId
-
string
The run ID.
- options
- RunsGetLogSasUrlOptionalParams
The options parameters.
Returns
Promise<RunGetLogResult>
list(string, string, RunsListOptionalParams)
Gets all the runs for a registry.
function list(resourceGroupName: string, registryName: string, options?: RunsListOptionalParams): PagedAsyncIterableIterator<Run, Run[], PageSettings>
Parameters
- resourceGroupName
-
string
The name of the resource group to which the container registry belongs.
- registryName
-
string
The name of the container registry.
- options
- RunsListOptionalParams
The options parameters.