Runs - Update
Patch the run properties.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}?api-version=2019-04-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
registry
|
path | True |
string |
The name of the container registry. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group to which the container registry belongs. |
run
|
path | True |
string |
The run ID. |
subscription
|
path | True |
string |
The Microsoft Azure subscription ID. |
api-version
|
query | True |
string |
The client API version. |
Request Body
Name | Type | Description |
---|---|---|
isArchiveEnabled |
boolean |
The value that indicates whether archiving is enabled or not. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request was successful; the request was well-formed and received properly. |
|
201 Created |
The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource. |
|
Other Status Codes |
Error response describing why the operation failed. If the registry/build doesn't exist, 404 (Not found) is returned. If any of the input parameters is wrong, 400(Bad Request) is returned. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Runs_Update
Sample Request
PATCH https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab?api-version=2019-04-01
{
"isArchiveEnabled": true
}
Sample Response
{
"properties": {
"provisioningState": "Succeeded",
"runId": "0accec26-d6de-4757-8e74-d080f38eaaab",
"status": "Succeeded",
"lastUpdatedTime": "2018-01-25T05:13:51.617Z",
"runType": "AutoBuild",
"createTime": "2018-01-25T05:13:51.618Z",
"startTime": "2018-01-25T05:50:51.618Z",
"finishTime": "2018-01-25T06:13:51.618Z",
"outputImages": [
{
"registry": "myregistry.azurecr.io",
"repository": "myimage",
"tag": "latest",
"digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0"
}
],
"task": "myTask",
"imageUpdateTrigger": {
"id": "c0c43143-da5d-41ef-b9e1-e7d749272e88",
"timestamp": "2018-01-25T05:13:51.618Z",
"images": [
{
"registry": "registry.hub.docker.com",
"repository": "mybaseimage",
"tag": "latest",
"digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0"
}
]
},
"isArchiveEnabled": true,
"platform": {
"os": "Linux",
"architecture": "amd64"
},
"agentConfiguration": {
"cpu": 2
}
},
"id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab",
"name": "0accec26-d6de-4757-8e74-d080f38eaaab",
"type": "Microsoft.ContainerRegistry/registries/runs"
}
{
"properties": {
"provisioningState": "Updating",
"runId": "0accec26-d6de-4757-8e74-d080f38eaaab",
"status": "Succeeded",
"lastUpdatedTime": "2018-01-25T05:13:51.617Z",
"runType": "AutoBuild",
"createTime": "2018-01-25T05:13:51.618Z",
"startTime": "2018-01-25T05:50:51.618Z",
"finishTime": "2018-01-25T06:13:51.618Z",
"outputImages": [
{
"registry": "myregistry.azurecr.io",
"repository": "myimage",
"tag": "latest",
"digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0"
}
],
"task": "myTask",
"imageUpdateTrigger": {
"id": "c0c43143-da5d-41ef-b9e1-e7d749272e88",
"timestamp": "2018-01-25T05:13:51.618Z",
"images": [
{
"registry": "registry.hub.docker.com",
"repository": "mybaseimage",
"tag": "latest",
"digest": "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0"
}
]
},
"isArchiveEnabled": true,
"platform": {
"os": "Linux",
"architecture": "amd64"
},
"agentConfiguration": {
"cpu": 2
}
},
"id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab",
"name": "0accec26-d6de-4757-8e74-d080f38eaaab",
"type": "Microsoft.ContainerRegistry/registries/runs"
}
Definitions
Name | Description |
---|---|
Agent |
The properties that determine the run agent configuration. |
Architecture |
The OS architecture. |
Image |
Properties for a registry image. |
Image |
The image update trigger that caused a build. |
OS |
The operating system type required for the run. |
Platform |
The platform properties against which the run has to happen. |
Provisioning |
The provisioning state of a run. |
Run |
Run resource properties |
Run |
The current status of the run. |
Run |
The type of run. |
Run |
The set of run properties that can be updated. |
Source |
The source trigger that caused a run. |
Timer |
|
Variant |
Variant of the CPU. |
AgentProperties
The properties that determine the run agent configuration.
Name | Type | Description |
---|---|---|
cpu |
integer |
The CPU configuration in terms of number of cores required for the run. |
Architecture
The OS architecture.
Name | Type | Description |
---|---|---|
amd64 |
string |
|
arm |
string |
|
x86 |
string |
ImageDescriptor
Properties for a registry image.
Name | Type | Description |
---|---|---|
digest |
string |
The sha256-based digest of the image manifest. |
registry |
string |
The registry login server. |
repository |
string |
The repository name. |
tag |
string |
The tag name. |
ImageUpdateTrigger
The image update trigger that caused a build.
Name | Type | Description |
---|---|---|
id |
string |
The unique ID of the trigger. |
images |
The list of image updates that caused the build. |
|
timestamp |
string |
The timestamp when the image update happened. |
OS
The operating system type required for the run.
Name | Type | Description |
---|---|---|
Linux |
string |
|
Windows |
string |
PlatformProperties
The platform properties against which the run has to happen.
Name | Type | Description |
---|---|---|
architecture |
The OS architecture. |
|
os |
The operating system type required for the run. |
|
variant |
Variant of the CPU. |
ProvisioningState
The provisioning state of a run.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
Run
Run resource properties
Name | Type | Default Value | Description |
---|---|---|---|
id |
string |
The resource ID. |
|
name |
string |
The name of the resource. |
|
properties.agentConfiguration |
The machine configuration of the run agent. |
||
properties.createTime |
string |
The time the run was scheduled. |
|
properties.customRegistries |
string[] |
The list of custom registries that were logged in during this run. |
|
properties.finishTime |
string |
The time the run finished. |
|
properties.imageUpdateTrigger |
The image update trigger that caused the run. This is applicable if the task has base image trigger configured. |
||
properties.isArchiveEnabled |
boolean |
False |
The value that indicates whether archiving is enabled or not. |
properties.lastUpdatedTime |
string |
The last updated time for the run. |
|
properties.outputImages |
The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. |
||
properties.platform |
The platform properties against which the run will happen. |
||
properties.provisioningState |
The provisioning state of a run. |
||
properties.runErrorMessage |
string |
The error message received from backend systems after the run is scheduled. |
|
properties.runId |
string |
The unique identifier for the run. |
|
properties.runType |
The type of run. |
||
properties.sourceRegistryAuth |
string |
The scope of the credentials that were used to login to the source registry during this run. |
|
properties.sourceTrigger |
The source trigger that caused the run. |
||
properties.startTime |
string |
The time the run started. |
|
properties.status |
The current status of the run. |
||
properties.task |
string |
The task against which run was scheduled. |
|
properties.timerTrigger |
The timer trigger that caused the run. |
||
type |
string |
The type of the resource. |
RunStatus
The current status of the run.
Name | Type | Description |
---|---|---|
Canceled |
string |
|
Error |
string |
|
Failed |
string |
|
Queued |
string |
|
Running |
string |
|
Started |
string |
|
Succeeded |
string |
|
Timeout |
string |
RunType
The type of run.
Name | Type | Description |
---|---|---|
AutoBuild |
string |
|
AutoRun |
string |
|
QuickBuild |
string |
|
QuickRun |
string |
RunUpdateParameters
The set of run properties that can be updated.
Name | Type | Description |
---|---|---|
isArchiveEnabled |
boolean |
The value that indicates whether archiving is enabled or not. |
SourceTriggerDescriptor
The source trigger that caused a run.
Name | Type | Description |
---|---|---|
branchName |
string |
The branch name in the repository. |
commitId |
string |
The unique ID that identifies a commit. |
eventType |
string |
The event type of the trigger. |
id |
string |
The unique ID of the trigger. |
providerType |
string |
The source control provider type. |
pullRequestId |
string |
The unique ID that identifies pull request. |
repositoryUrl |
string |
The repository URL. |
TimerTriggerDescriptor
Name | Type | Description |
---|---|---|
scheduleOccurrence |
string |
The occurrence that triggered the run. |
timerTriggerName |
string |
The timer trigger name that caused the run. |
Variant
Variant of the CPU.
Name | Type | Description |
---|---|---|
v6 |
string |
|
v7 |
string |
|
v8 |
string |