Runs interface

Package:

@azure/arm-containerregistry

Interface representing a Runs.

Methods

cancel(string, string, string, RunsCancelOptionalParams)	Cancel an existing run.
get(string, string, string, RunsGetOptionalParams)	Gets the detailed information for a given run.
getLogSasUrl(string, string, string, RunsGetLogSasUrlOptionalParams)	Gets a link to download the run logs.
list(string, string, RunsListOptionalParams)	Gets all the runs for a registry.
update(string, string, string, RunUpdateParameters, RunsUpdateOptionalParams)	Patch the run properties.

Method Details

cancel(string, string, string, RunsCancelOptionalParams)

Cancel an existing run.

function cancel(resourceGroupName: string, registryName: string, runId: string, options?: RunsCancelOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

registryName

string

The name of the Registry

runId

string

The run ID.

options

RunsCancelOptionalParams

The options parameters.

Returns

Promise<void>

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. The name is case insensitive.

registryName

string

The name of the 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. The name is case insensitive.

registryName

string

The name of the 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. The name is case insensitive.

registryName

string

The name of the Registry

options

RunsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Run, Run[], PageSettings>

update(string, string, string, RunUpdateParameters, RunsUpdateOptionalParams)

Patch the run properties.

function update(resourceGroupName: string, registryName: string, runId: string, runUpdateParameters: RunUpdateParameters, options?: RunsUpdateOptionalParams): Promise<Run>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

registryName

string

The name of the Registry

runId

string

The run ID.

runUpdateParameters

RunUpdateParameters

The run update properties.

options

RunsUpdateOptionalParams

The options parameters.

Returns

Promise<Run>