Microsoft.ContainerRegistry (preview:2019-06-01)

2025/09/04 • 25 new, 25 deleted methods

AgentPools_Get (new)
Description :  Gets the detailed information for a given agent pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_Create (new)
Description :  Creates an agent pool for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
agentPool:
{
Description: The parameters of an agent pool that needs to scheduled. ,
Required: True ,
}
{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_Delete (new)
Description :  Deletes a specified agent pool resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_Update (new)
Description :  Updates an agent pool with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
updateParameters:
{
Description: The parameters for updating an agent pool. ,
Required: True ,
}
{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: The ARM resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_List (new)
Description :  Lists all the agent pools for a specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_GetQueueStatus (new)
Description :  Gets the count of queued runs for a given agent pool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}/listQueueStatus
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: The number of pending runs in the queue ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_ScheduleRun (new)
Description :  Schedules a new run based on the request parameters and add it to the run queue.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scheduleRun
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runRequest:
{
Description: The parameters of a run that needs to scheduled. ,
Required: True ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_GetBuildSourceUploadUrl (new)
Description :  Get the upload location for the user to be able to upload the source.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listBuildSourceUploadUrl
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uploadUrl:
{
Description: The URL where the client can upload the source. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relative path to the source. This is used to submit the subsequent queue build request. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_List (new)
Description :  Gets all the runs for a registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is 'contains'. All logical operators except 'Not', 'Has', 'All' are allowed. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported for get list of runs, which limits the maximum number of runs to return. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_Get (new)
Description :  Gets the detailed information for a given run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runId:
{
Description: The run ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_Update (new)
Description :  Patch the run properties.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runId:
{
Description: The run ID. ,
Required: True ,
}
string ,
runUpdateParameters:
{
Description: The run update properties. ,
Required: True ,
}
{
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_GetLogSasUrl (new)
Description :  Gets a link to download the run logs.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/listLogSasUrl
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runId:
{
Description: The run ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
logLink:
{
Description: The link to logs for a run on a azure container registry. ,
Required: False ,
}
string ,
logArtifactLink:
{
Description: The link to logs in registry for a run on a azure container registry. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_Cancel (new)
Description :  Cancel an existing run.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/cancel
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runId:
{
Description: The run ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_Get (new)
Description :  Gets the detailed information for a given task run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_Create (new)
Description :  Creates a task run for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
taskRun:
{
Description: The parameters of a run that needs to scheduled. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_Delete (new)
Description :  Deletes a specified task run resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_Update (new)
Description :  Updates a task run with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
updateParameters:
{
Description: The parameters for updating a task run. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties for updating a task run. ,
Required: False ,
}
{
runRequest:
{
Description: The request (parameters) for the new run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: The ARM resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_GetDetails (new)
Description :  Gets the detailed information for a given task run that includes all secrets.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}/listDetails
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_List (new)
Description :  Lists all the task runs for a specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_List (new)
Description :  Lists all the tasks for a specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_Get (new)
Description :  Get the properties of a specified task.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_Create (new)
Description :  Creates a task for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
taskCreateParameters:
{
Description: The parameters for creating a task. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_Delete (new)
Description :  Deletes a specified task.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_Update (new)
Description :  Updates a task with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
taskUpdateParameters:
{
Description: The parameters for updating a task. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties for updating a task. ,
Required: False ,
}
{
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties for updating a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties for updating trigger properties. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: False ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: False ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: False ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: False ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: False ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: False ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: False ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The parameters that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The ARM resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_GetDetails (new)
Description :  Returns a task with extended information that includes all secrets.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}/listDetails
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_Get (removed)
Description :  Gets the detailed information for a given agent pool.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_Create (removed)
Description :  Creates an agent pool for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
agentPool:
{
Description: The parameters of an agent pool that needs to scheduled. ,
Required: True ,
}
{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_Delete (removed)
Description :  Deletes a specified agent pool resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_Update (removed)
Description :  Updates an agent pool with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
updateParameters:
{
Description: The parameters for updating an agent pool. ,
Required: True ,
}
{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: The ARM resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_List (removed)
Description :  Lists all the agent pools for a specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
properties:
{
Description: The properties associated with the agent pool ,
Required: False ,
}
{
count:
{
Description: The count of agent machine ,
Format: int32 ,
Required: False ,
}
integer ,
tier:
{
Description: The Tier of agent machine ,
Required: False ,
}
string ,
os:
{
Description: The OS of agent machine ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
virtualNetworkSubnetResourceId:
{
Description: The Virtual Network Subnet Resource Id of the agent machine ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of this agent pool ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
AgentPools_GetQueueStatus (removed)
Description :  Gets the count of queued runs for a given agent pool.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/agentPools/{agentPoolName}/listQueueStatus
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
agentPoolName:
{
Description: The name of the agent pool. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
count:
{
Description: The number of pending runs in the queue ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_ScheduleRun (removed)
Description :  Schedules a new run based on the request parameters and add it to the run queue.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scheduleRun
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runRequest:
{
Description: The parameters of a run that needs to scheduled. ,
Required: True ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Registries_GetBuildSourceUploadUrl (removed)
Description :  Get the upload location for the user to be able to upload the source.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/listBuildSourceUploadUrl
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
uploadUrl:
{
Description: The URL where the client can upload the source. ,
Required: False ,
}
string ,
relativePath:
{
Description: The relative path to the source. This is used to submit the subsequent queue build request. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_List (removed)
Description :  Gets all the runs for a registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
$filter:
{
Description: The runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is 'contains'. All logical operators except 'Not', 'Has', 'All' are allowed. ,
Required: False ,
}
string ,
$top:
{
Description: $top is supported for get list of runs, which limits the maximum number of runs to return. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_Get (removed)
Description :  Gets the detailed information for a given run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runId:
{
Description: The run ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_Update (removed)
Description :  Patch the run properties.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runId:
{
Description: The run ID. ,
Required: True ,
}
string ,
runUpdateParameters:
{
Description: The run update properties. ,
Required: True ,
}
{
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_GetLogSasUrl (removed)
Description :  Gets a link to download the run logs.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/listLogSasUrl
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runId:
{
Description: The run ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
logLink:
{
Description: The link to logs for a run on a azure container registry. ,
Required: False ,
}
string ,
logArtifactLink:
{
Description: The link to logs in registry for a run on a azure container registry. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Runs_Cancel (removed)
Description :  Cancel an existing run.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/runs/{runId}/cancel
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
runId:
{
Description: The run ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_Get (removed)
Description :  Gets the detailed information for a given task run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_Create (removed)
Description :  Creates a task run for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
taskRun:
{
Description: The parameters of a run that needs to scheduled. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_Delete (removed)
Description :  Deletes a specified task run resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_Update (removed)
Description :  Updates a task run with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
updateParameters:
{
Description: The parameters for updating a task run. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties for updating a task run. ,
Required: False ,
}
{
runRequest:
{
Description: The request (parameters) for the new run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
tags:
{
Description: The ARM resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_GetDetails (removed)
Description :  Gets the detailed information for a given task run that includes all secrets.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns/{taskRunName}/listDetails
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskRunName:
{
Description: The name of the task run. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
TaskRuns_List (removed)
Description :  Lists all the task runs for a specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/taskRuns
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties associated with the task run, i.e., request and result of the run ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of this task run ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
runRequest:
{
Description: The request (parameters) for the run ,
Required: False ,
}
{
type:
{
Description: The type of the run request. ,
Required: True ,
}
string ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled for the run or not. ,
Required: False ,
}
boolean ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
runResult:
{
Description: The result of this task run ,
Required: False ,
}
{
properties:
{
Description: The properties of a run. ,
Required: False ,
}
{
runId:
{
Description: The unique identifier for the run. ,
Required: False ,
}
string ,
status:
{
Description: The current status of the run. ,
Enum:
{
Queued: No description available. ,
Started: No description available. ,
Running: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Error: No description available. ,
Timeout: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdatedTime:
{
Description: The last updated time for the run. ,
Format: date-time ,
Required: False ,
}
string ,
runType:
{
Description: The type of run. ,
Enum:
{
QuickBuild: No description available. ,
QuickRun: No description available. ,
AutoBuild: No description available. ,
AutoRun: No description available. ,
}
,
Required: False ,
}
enum ,
agentPoolName:
{
Description: The dedicated agent pool for the run. ,
Required: False ,
}
string ,
createTime:
{
Description: The time the run was scheduled. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The time the run started. ,
Format: date-time ,
Required: False ,
}
string ,
finishTime:
{
Description: The time the run finished. ,
Format: date-time ,
Required: False ,
}
string ,
outputImages:
{
Description: The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
task:
{
Description: The task against which run was scheduled. ,
Required: False ,
}
string ,
imageUpdateTrigger:
{
Description: The image update trigger that caused the run. This is applicable if the task has base image trigger configured. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp when the image update happened. ,
Format: date-time ,
Required: False ,
}
string ,
images:
{
Description: The list of image updates that caused the build. ,
Required: False ,
}
[
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
}
,
sourceTrigger:
{
Description: The source trigger that caused the run. ,
Required: False ,
}
{
id:
{
Description: The unique ID of the trigger. ,
Required: False ,
}
string ,
eventType:
{
Description: The event type of the trigger. ,
Required: False ,
}
string ,
commitId:
{
Description: The unique ID that identifies a commit. ,
Required: False ,
}
string ,
pullRequestId:
{
Description: The unique ID that identifies pull request. ,
Required: False ,
}
string ,
repositoryUrl:
{
Description: The repository URL. ,
Required: False ,
}
string ,
branchName:
{
Description: The branch name in the repository. ,
Required: False ,
}
string ,
providerType:
{
Description: The source control provider type. ,
Required: False ,
}
string ,
}
,
timerTrigger:
{
Description: The timer trigger that caused the run. ,
Required: False ,
}
{
timerTriggerName:
{
Description: The timer trigger name that caused the run. ,
Required: False ,
}
string ,
scheduleOccurrence:
{
Description: The occurrence that triggered the run. ,
Required: False ,
}
string ,
}
,
platform:
{
Description: The platform properties against which the run will happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sourceRegistryAuth:
{
Description: The scope of the credentials that were used to login to the source registry during this run. ,
Required: False ,
}
string ,
customRegistries:
{
Description: The list of custom registries that were logged in during this run. ,
Required: False ,
}
[
string ,
]
,
runErrorMessage:
{
Description: The error message received from backend systems after the run is scheduled. ,
Required: False ,
}
string ,
updateTriggerToken:
{
Description: The update trigger token passed for the Run. ,
Required: False ,
}
string ,
logArtifact:
{
Description: The image description for the log artifact. ,
Required: False ,
}
{
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of a run. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
isArchiveEnabled:
{
Description: The value that indicates whether archiving is enabled or not. ,
Required: False ,
}
boolean ,
}
,
}
,
forceUpdateTag:
{
Description: How the run should be forced to rerun even if the run request configuration has not changed ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_List (removed)
Description :  Lists all the tasks for a specified container registry.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection value. ,
Required: False ,
}
[
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URI that can be used to request the next set of paged results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_Get (removed)
Description :  Get the properties of a specified task.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_Create (removed)
Description :  Creates a task for a container registry with the specified parameters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
taskCreateParameters:
{
Description: The parameters for creating a task. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_Delete (removed)
Description :  Deletes a specified task.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_Update (removed)
Description :  Updates a task with the specified parameters.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
taskUpdateParameters:
{
Description: The parameters for updating a task. ,
Required: True ,
}
{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties for updating a task. ,
Required: False ,
}
{
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: False ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties for updating a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties for updating trigger properties. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: False ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: False ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: False ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: False ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: False ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: False ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: False ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: False ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The parameters that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
}
,
tags:
{
Description: The ARM resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
Tasks_GetDetails (removed)
Description :  Returns a task with extended information that includes all secrets.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}/listDetails
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group to which the container registry belongs. ,
Required: True ,
}
string ,
registryName:
{
Description: The name of the container registry. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
taskName:
{
Description: The name of the container registry task. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identity:
{
Description: Identity for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The properties of a task. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state of the task. ,
Enum:
{
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
creationDate:
{
Description: The creation date of task. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The current status of task. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
platform:
{
Description: The platform properties against which the run has to happen. ,
Required: False ,
}
{
os:
{
Description: The operating system type required for the run. ,
Enum:
{
Windows: No description available. ,
Linux: No description available. ,
}
,
Required: True ,
}
enum ,
architecture:
{
Description: The OS architecture. ,
Enum:
{
amd64: No description available. ,
x86: No description available. ,
386: No description available. ,
arm: No description available. ,
arm64: No description available. ,
}
,
Required: False ,
}
enum ,
variant:
{
Description: Variant of the CPU. ,
Enum:
{
v6: No description available. ,
v7: No description available. ,
v8: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
agentConfiguration:
{
Description: The machine configuration of the run agent. ,
Required: False ,
}
{
cpu:
{
Description: The CPU configuration in terms of number of cores required for the run. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
agentPoolName:
{
Description: The dedicated agent pool for the task. ,
Required: False ,
}
string ,
timeout:
{
Description: Run timeout in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
step:
{
Description: The properties of a task step. ,
Required: False ,
}
{
type:
{
Description: The type of the step. ,
Enum:
{
Docker: No description available. ,
FileTask: No description available. ,
EncodedTask: No description available. ,
}
,
Required: True ,
}
enum ,
baseImageDependencies:
{
Description: List of base image dependencies for a step. ,
Required: False ,
}
[
{
type:
{
Description: The type of the base image dependency. ,
Enum:
{
BuildTime: No description available. ,
RunTime: No description available. ,
}
,
Required: False ,
}
enum ,
registry:
{
Description: The registry login server. ,
Required: False ,
}
string ,
repository:
{
Description: The repository name. ,
Required: False ,
}
string ,
tag:
{
Description: The tag name. ,
Required: False ,
}
string ,
digest:
{
Description: The sha256-based digest of the image manifest. ,
Required: False ,
}
string ,
}
,
]
,
contextPath:
{
Description: The URL(absolute or relative) of the source context for the task step. ,
Required: False ,
}
string ,
contextAccessToken:
{
Description: The token (git PAT or SAS token of storage account blob) associated with the context for a step. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: The properties that describe all triggers for the task. ,
Required: False ,
}
{
timerTriggers:
{
Description: The collection of timer triggers. ,
Required: False ,
}
[
{
schedule:
{
Description: The CRON expression for the task schedule ,
Required: True ,
}
string ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
sourceTriggers:
{
Description: The collection of triggers based on source code repository. ,
Required: False ,
}
[
{
sourceRepository:
{
Description: The properties that describes the source(code) for the task. ,
Required: True ,
}
{
sourceControlType:
{
Description: The type of source control service. ,
Enum:
{
Github: No description available. ,
VisualStudioTeamService: No description available. ,
}
,
Required: True ,
}
enum ,
repositoryUrl:
{
Description: The full URL to the source code repository ,
Required: True ,
}
string ,
branch:
{
Description: The branch name of the source code. ,
Required: False ,
}
string ,
sourceControlAuthProperties:
{
Description: The authorization properties for accessing the source code repository and to set up webhooks for notifications. ,
Required: False ,
}
{
tokenType:
{
Description: The type of Auth token. ,
Enum:
{
PAT: No description available. ,
OAuth: No description available. ,
}
,
Required: True ,
}
enum ,
token:
{
Description: The access token used to access the source control provider. ,
Required: True ,
}
string ,
refreshToken:
{
Description: The refresh token used to refresh the access token. ,
Required: False ,
}
string ,
scope:
{
Description: The scope of the access token. ,
Required: False ,
}
string ,
expiresIn:
{
Description: Time in seconds that the token remains valid ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
sourceTriggerEvents:
{
Description: The source event corresponding to the trigger. ,
Required: True ,
}
[
string ,
]
,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
]
,
baseImageTrigger:
{
Description: The trigger based on base image dependencies. ,
Required: False ,
}
{
baseImageTriggerType:
{
Description: The type of the auto trigger for base image dependency updates. ,
Enum:
{
All: No description available. ,
Runtime: No description available. ,
}
,
Required: True ,
}
enum ,
updateTriggerEndpoint:
{
Description: The endpoint URL for receiving update triggers. ,
Required: False ,
}
string ,
updateTriggerPayloadType:
{
Description: Type of Payload body for Base image update triggers. ,
Enum:
{
Default: No description available. ,
Token: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: The current status of trigger. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
}
,
}
,
credentials:
{
Description: The properties that describes a set of credentials that will be used when this run is invoked. ,
Required: False ,
}
{
sourceRegistry:
{
Description: Describes the credential parameters for accessing the source registry. ,
Required: False ,
}
{
loginMode:
{
Description: The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run. ,
Enum:
{
None: No description available. ,
Default: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
customRegistries:
{
Description: Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry. ,
Required: False ,
}
object ,
}
,
logTemplate:
{
Description: The template that describes the repository and tag information for run log artifact. ,
Required: False ,
}
string ,
isSystemTask:
{
Description: The value of this property indicates whether the task resource is system task or not. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Azure container registry build API error body. ,
Required: False ,
}
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
details:
{
Description: an array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: error code. ,
Required: True ,
}
string ,
message:
{
Description: error message. ,
Required: True ,
}
string ,
target:
{
Description: target of the particular error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}