Package version:

Interface Runs

Interface representing a Runs.

Hierarchy

Runs

Index

Methods

beginCancel beginCancelAndWait beginUpdate beginUpdateAndWait get getLogSasUrl list

Methods

beginCancel

beginCancel(resourceGroupName: string, registryName: string, runId: string, options?: RunsCancelOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Cancel an existing 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.
- Optional options: RunsCancelOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/runs.ts:103

beginCancelAndWait

beginCancelAndWait(resourceGroupName: string, registryName: string, runId: string, options?: RunsCancelOptionalParams): Promise<void>
Cancel an existing 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.
- Optional options: RunsCancelOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/runs.ts:116

beginUpdate

beginUpdate(resourceGroupName: string, registryName: string, runId: string, runUpdateParameters: RunUpdateParameters, options?: RunsUpdateOptionalParams): Promise<PollerLike<PollOperationState<Run>, Run>>
Patch the run properties.
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.
- Optional options: RunsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Run>, Run>>
- Defined in operationsInterfaces/runs.ts:59

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, registryName: string, runId: string, runUpdateParameters: RunUpdateParameters, options?: RunsUpdateOptionalParams): Promise<Run>
Patch the run properties.
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.
- Optional options: RunsUpdateOptionalParams
  
  The options parameters.
Returns Promise<Run>
- Defined in operationsInterfaces/runs.ts:76

get

get(resourceGroupName: string, registryName: string, runId: string, options?: RunsGetOptionalParams): Promise<Run>
Gets the detailed information for a given 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.
- Optional options: RunsGetOptionalParams
  
  The options parameters.
Returns Promise<Run>
- Defined in operationsInterfaces/runs.ts:45

getLogSasUrl

getLogSasUrl(resourceGroupName: string, registryName: string, runId: string, options?: RunsGetLogSasUrlOptionalParams): Promise<RunGetLogResult>
Gets a link to download the run logs.
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.
- Optional options: RunsGetLogSasUrlOptionalParams
  
  The options parameters.
Returns Promise<RunGetLogResult>
- Defined in operationsInterfaces/runs.ts:90

list

list(resourceGroupName: string, registryName: string, options?: RunsListOptionalParams): PagedAsyncIterableIterator<Run>
Gets all the runs for a registry.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: RunsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Run>
- Defined in operationsInterfaces/runs.ts:33

Interface Runs

Hierarchy

Index

Methods

Methods

beginCancel

Parameters

resourceGroupName: string

registryName: string

runId: string

Optional options: RunsCancelOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCancelAndWait

Parameters

resourceGroupName: string

registryName: string

runId: string

Optional options: RunsCancelOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

registryName: string

runId: string

runUpdateParameters: RunUpdateParameters

Optional options: RunsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Run>, Run>>

beginUpdateAndWait

Parameters

resourceGroupName: string

registryName: string

runId: string

runUpdateParameters: RunUpdateParameters

Optional options: RunsUpdateOptionalParams

Returns Promise<Run>

get

Parameters

resourceGroupName: string

registryName: string

runId: string

Optional options: RunsGetOptionalParams

Returns Promise<Run>

getLogSasUrl

Parameters

resourceGroupName: string

registryName: string

runId: string

Optional options: RunsGetLogSasUrlOptionalParams

Returns Promise<RunGetLogResult>

list

Parameters

resourceGroupName: string

registryName: string

Optional options: RunsListOptionalParams

Returns PagedAsyncIterableIterator<Run>

Settings

Member Visibility

Theme

`Optional` options: RunsCancelOptionalParams

`Optional` options: RunsCancelOptionalParams

`Optional` options: RunsUpdateOptionalParams

`Optional` options: RunsUpdateOptionalParams

`Optional` options: RunsGetOptionalParams

`Optional` options: RunsGetLogSasUrlOptionalParams

`Optional` options: RunsListOptionalParams