Microsoft.ContainerRegistry registries/taskRuns 2019-06-01-preview

Article
12/09/2024

Bicep resource definition

The registries/taskRuns resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerRegistry/registries/taskRuns resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerRegistry/registries/taskRuns@2019-06-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    forceUpdateTag: 'string'
    runRequest: {
      agentPoolName: 'string'
      isArchiveEnabled: bool
      logTemplate: 'string'
      type: 'string'
      // For remaining properties, see RunRequest objects
    }
  }
}

RunRequest objects

Set the type property to specify the type of object.

For DockerBuildRequest, use:

{
  agentConfiguration: {
    cpu: int
  }
  arguments: [
    {
      isSecret: bool
      name: 'string'
      value: 'string'
    }
  ]
  credentials: {
    customRegistries: {
      {customized property}: {
        identity: 'string'
        password: {
          type: 'string'
          value: 'string'
        }
        userName: {
          type: 'string'
          value: 'string'
        }
      }
    }
    sourceRegistry: {
      loginMode: 'string'
    }
  }
  dockerFilePath: 'string'
  imageNames: [
    'string'
  ]
  isPushEnabled: bool
  noCache: bool
  platform: {
    architecture: 'string'
    os: 'string'
    variant: 'string'
  }
  sourceLocation: 'string'
  target: 'string'
  timeout: int
  type: 'DockerBuildRequest'
}

For EncodedTaskRunRequest, use:

{
  agentConfiguration: {
    cpu: int
  }
  credentials: {
    customRegistries: {
      {customized property}: {
        identity: 'string'
        password: {
          type: 'string'
          value: 'string'
        }
        userName: {
          type: 'string'
          value: 'string'
        }
      }
    }
    sourceRegistry: {
      loginMode: 'string'
    }
  }
  encodedTaskContent: 'string'
  encodedValuesContent: 'string'
  platform: {
    architecture: 'string'
    os: 'string'
    variant: 'string'
  }
  sourceLocation: 'string'
  timeout: int
  type: 'EncodedTaskRunRequest'
  values: [
    {
      isSecret: bool
      name: 'string'
      value: 'string'
    }
  ]
}

For FileTaskRunRequest, use:

{
  agentConfiguration: {
    cpu: int
  }
  credentials: {
    customRegistries: {
      {customized property}: {
        identity: 'string'
        password: {
          type: 'string'
          value: 'string'
        }
        userName: {
          type: 'string'
          value: 'string'
        }
      }
    }
    sourceRegistry: {
      loginMode: 'string'
    }
  }
  platform: {
    architecture: 'string'
    os: 'string'
    variant: 'string'
  }
  sourceLocation: 'string'
  taskFilePath: 'string'
  timeout: int
  type: 'FileTaskRunRequest'
  values: [
    {
      isSecret: bool
      name: 'string'
      value: 'string'
    }
  ]
  valuesFilePath: 'string'
}

For TaskRunRequest, use:

{
  overrideTaskStepProperties: {
    arguments: [
      {
        isSecret: bool
        name: 'string'
        value: 'string'
      }
    ]
    contextPath: 'string'
    file: 'string'
    target: 'string'
    updateTriggerToken: 'string'
    values: [
      {
        isSecret: bool
        name: 'string'
        value: 'string'
      }
    ]
  }
  taskId: 'string'
  type: 'TaskRunRequest'
}

Property values

AgentProperties

Name	Description	Value
cpu	The CPU configuration in terms of number of cores required for the run.	int

Argument

Name	Description	Value
isSecret	Flag to indicate whether the argument represents a secret and want to be removed from build logs.	bool
name	The name of the argument.	string (required)
value	The value of the argument.	string (required)

Credentials

Name	Description	Value
customRegistries	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.	CredentialsCustomRegistries
sourceRegistry	Describes the credential parameters for accessing the source registry.	SourceRegistryCredentials

CredentialsCustomRegistries

Name	Description	Value

CustomRegistryCredentials

Name	Description	Value
identity	Indicates the managed identity assigned to the custom credential. If a user-assigned identity this value is the Client ID. If a system-assigned identity, the value will be `system`. In the case of a system-assigned identity, the Client ID will be determined by the runner. This identity may be used to authenticate to key vault to retrieve credentials or it may be the only source of authentication used for accessing the registry.	string
password	The password for logging into the custom registry. The password is a secret object that allows multiple ways of providing the value for it.	SecretObject
userName	The username for logging into the custom registry.	SecretObject

DockerBuildRequest

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
arguments	The collection of override arguments to be used when executing the run.	Argument[]
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
dockerFilePath	The Docker file path relative to the source location.	string (required)
imageNames	The fully qualified image names including the repository and tag.	string[]
isPushEnabled	The value of this property indicates whether the image built should be pushed to the registry or not.	bool
noCache	The value of this property indicates whether the image cache is enabled or not.	bool
platform	The platform properties against which the run has to happen.	PlatformProperties (required)
sourceLocation	The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.	string
target	The name of the target build stage for the docker build.	string
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
type	The type of the run request.	'DockerBuildRequest' (required)

EncodedTaskRunRequest

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
encodedTaskContent	Base64 encoded value of the template/definition file content.	string (required)
encodedValuesContent	Base64 encoded value of the parameters/values file content.	string
platform	The platform properties against which the run has to happen.	PlatformProperties (required)
sourceLocation	The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.	string
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
type	The type of the run request.	'EncodedTaskRunRequest' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]

FileTaskRunRequest

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
platform	The platform properties against which the run has to happen.	PlatformProperties (required)
sourceLocation	The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.	string
taskFilePath	The template/definition file path relative to the source.	string (required)
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
type	The type of the run request.	'FileTaskRunRequest' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]
valuesFilePath	The values/parameters file path relative to the source.	string

IdentityProperties

Name	Description	Value
principalId	The principal ID of resource identity.	string
tenantId	The tenant ID of resource.	string
type	The identity type.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	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}'.	IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Name	Description	Value

Microsoft.ContainerRegistry/registries/taskRuns

Name	Description	Value
identity	Identity for the resource.	IdentityProperties
location	The location of the resource	string
name	The resource name	string Constraints: Min length = 5 Max length = 5 Pattern = `^[a-zA-Z0-9-]*$` (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: registries
properties	The properties associated with the task run, i.e., request and result of the run	TaskRunProperties

OverrideTaskStepProperties

Name	Description	Value
arguments	Gets or sets the collection of override arguments to be used when executing a build step.	Argument[]
contextPath	The source context against which run has to be queued.	string
file	The file against which run has to be queued.	string
target	The name of the target build stage for the docker build.	string
updateTriggerToken	Base64 encoded update trigger token that will be attached with the base image trigger webhook.	string
values	The collection of overridable values that can be passed when running a Task.	SetValue[]

PlatformProperties

Name	Description	Value
architecture	The OS architecture.	'386' 'amd64' 'arm' 'arm64' 'x86'
os	The operating system type required for the run.	'Linux' 'Windows' (required)
variant	Variant of the CPU.	'v6' 'v7' 'v8'

RunRequest

Name	Description	Value
agentPoolName	The dedicated agent pool for the run.	string
isArchiveEnabled	The value that indicates whether archiving is enabled for the run or not.	bool
logTemplate	The template that describes the repository and tag information for run log artifact.	string
type	Set to 'DockerBuildRequest' for type DockerBuildRequest. Set to 'EncodedTaskRunRequest' for type EncodedTaskRunRequest. Set to 'FileTaskRunRequest' for type FileTaskRunRequest. Set to 'TaskRunRequest' for type TaskRunRequest.	'DockerBuildRequest' 'EncodedTaskRunRequest' 'FileTaskRunRequest' 'TaskRunRequest' (required)

SecretObject

Name	Description	Value
type	The type of the secret object which determines how the value of the secret object has to be interpreted.	'Opaque' 'Vaultsecret'
value	The value of the secret. The format of this value will be determined based on the type of the secret object. If the type is Opaque, the value will be used as is without any modification.	string

SetValue

Name	Description	Value
isSecret	Flag to indicate whether the value represents a secret or not.	bool
name	The name of the overridable value.	string (required)
value	The overridable value.	string (required)

SourceRegistryCredentials

Name	Description	Value
loginMode	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.	'Default' 'None'

TaskRunProperties

Name	Description	Value
forceUpdateTag	How the run should be forced to rerun even if the run request configuration has not changed	string
runRequest	The request (parameters) for the run	RunRequest

TaskRunRequest

Name	Description	Value
overrideTaskStepProperties	Set of overridable parameters that can be passed when running a Task.	OverrideTaskStepProperties
taskId	The resource ID of task against which run has to be queued.	string (required)
type	The type of the run request.	'TaskRunRequest' (required)

UserIdentityProperties

Name	Description	Value
clientId	The client id of user assigned identity.	string
principalId	The principal id of user assigned identity.	string

ARM template resource definition

The registries/taskRuns resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerRegistry/registries/taskRuns resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerRegistry/registries/taskRuns",
  "apiVersion": "2019-06-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "forceUpdateTag": "string",
    "runRequest": {
      "agentPoolName": "string",
      "isArchiveEnabled": "bool",
      "logTemplate": "string",
      "type": "string"
      // For remaining properties, see RunRequest objects
    }
  }
}

RunRequest objects

Set the type property to specify the type of object.

For DockerBuildRequest, use:

{
  "agentConfiguration": {
    "cpu": "int"
  },
  "arguments": [
    {
      "isSecret": "bool",
      "name": "string",
      "value": "string"
    }
  ],
  "credentials": {
    "customRegistries": {
      "{customized property}": {
        "identity": "string",
        "password": {
          "type": "string",
          "value": "string"
        },
        "userName": {
          "type": "string",
          "value": "string"
        }
      }
    },
    "sourceRegistry": {
      "loginMode": "string"
    }
  },
  "dockerFilePath": "string",
  "imageNames": [ "string" ],
  "isPushEnabled": "bool",
  "noCache": "bool",
  "platform": {
    "architecture": "string",
    "os": "string",
    "variant": "string"
  },
  "sourceLocation": "string",
  "target": "string",
  "timeout": "int",
  "type": "DockerBuildRequest"
}

For EncodedTaskRunRequest, use:

{
  "agentConfiguration": {
    "cpu": "int"
  },
  "credentials": {
    "customRegistries": {
      "{customized property}": {
        "identity": "string",
        "password": {
          "type": "string",
          "value": "string"
        },
        "userName": {
          "type": "string",
          "value": "string"
        }
      }
    },
    "sourceRegistry": {
      "loginMode": "string"
    }
  },
  "encodedTaskContent": "string",
  "encodedValuesContent": "string",
  "platform": {
    "architecture": "string",
    "os": "string",
    "variant": "string"
  },
  "sourceLocation": "string",
  "timeout": "int",
  "type": "EncodedTaskRunRequest",
  "values": [
    {
      "isSecret": "bool",
      "name": "string",
      "value": "string"
    }
  ]
}

For FileTaskRunRequest, use:

{
  "agentConfiguration": {
    "cpu": "int"
  },
  "credentials": {
    "customRegistries": {
      "{customized property}": {
        "identity": "string",
        "password": {
          "type": "string",
          "value": "string"
        },
        "userName": {
          "type": "string",
          "value": "string"
        }
      }
    },
    "sourceRegistry": {
      "loginMode": "string"
    }
  },
  "platform": {
    "architecture": "string",
    "os": "string",
    "variant": "string"
  },
  "sourceLocation": "string",
  "taskFilePath": "string",
  "timeout": "int",
  "type": "FileTaskRunRequest",
  "values": [
    {
      "isSecret": "bool",
      "name": "string",
      "value": "string"
    }
  ],
  "valuesFilePath": "string"
}

For TaskRunRequest, use:

{
  "overrideTaskStepProperties": {
    "arguments": [
      {
        "isSecret": "bool",
        "name": "string",
        "value": "string"
      }
    ],
    "contextPath": "string",
    "file": "string",
    "target": "string",
    "updateTriggerToken": "string",
    "values": [
      {
        "isSecret": "bool",
        "name": "string",
        "value": "string"
      }
    ]
  },
  "taskId": "string",
  "type": "TaskRunRequest"
}

Property values

AgentProperties

Name	Description	Value
cpu	The CPU configuration in terms of number of cores required for the run.	int

Argument

Name	Description	Value
isSecret	Flag to indicate whether the argument represents a secret and want to be removed from build logs.	bool
name	The name of the argument.	string (required)
value	The value of the argument.	string (required)

Credentials

Name	Description	Value
customRegistries	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.	CredentialsCustomRegistries
sourceRegistry	Describes the credential parameters for accessing the source registry.	SourceRegistryCredentials

CredentialsCustomRegistries

Name	Description	Value

CustomRegistryCredentials

Name	Description	Value
identity	Indicates the managed identity assigned to the custom credential. If a user-assigned identity this value is the Client ID. If a system-assigned identity, the value will be `system`. In the case of a system-assigned identity, the Client ID will be determined by the runner. This identity may be used to authenticate to key vault to retrieve credentials or it may be the only source of authentication used for accessing the registry.	string
password	The password for logging into the custom registry. The password is a secret object that allows multiple ways of providing the value for it.	SecretObject
userName	The username for logging into the custom registry.	SecretObject

DockerBuildRequest

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
arguments	The collection of override arguments to be used when executing the run.	Argument[]
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
dockerFilePath	The Docker file path relative to the source location.	string (required)
imageNames	The fully qualified image names including the repository and tag.	string[]
isPushEnabled	The value of this property indicates whether the image built should be pushed to the registry or not.	bool
noCache	The value of this property indicates whether the image cache is enabled or not.	bool
platform	The platform properties against which the run has to happen.	PlatformProperties (required)
sourceLocation	The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.	string
target	The name of the target build stage for the docker build.	string
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
type	The type of the run request.	'DockerBuildRequest' (required)

EncodedTaskRunRequest

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
encodedTaskContent	Base64 encoded value of the template/definition file content.	string (required)
encodedValuesContent	Base64 encoded value of the parameters/values file content.	string
platform	The platform properties against which the run has to happen.	PlatformProperties (required)
sourceLocation	The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.	string
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
type	The type of the run request.	'EncodedTaskRunRequest' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]

FileTaskRunRequest

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
platform	The platform properties against which the run has to happen.	PlatformProperties (required)
sourceLocation	The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.	string
taskFilePath	The template/definition file path relative to the source.	string (required)
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
type	The type of the run request.	'FileTaskRunRequest' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]
valuesFilePath	The values/parameters file path relative to the source.	string

IdentityProperties

Name	Description	Value
principalId	The principal ID of resource identity.	string
tenantId	The tenant ID of resource.	string
type	The identity type.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	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}'.	IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Name	Description	Value

Microsoft.ContainerRegistry/registries/taskRuns

Name	Description	Value
apiVersion	The api version	'2019-06-01-preview'
identity	Identity for the resource.	IdentityProperties
location	The location of the resource	string
name	The resource name	string Constraints: Min length = 5 Max length = 5 Pattern = `^[a-zA-Z0-9-]*$` (required)
properties	The properties associated with the task run, i.e., request and result of the run	TaskRunProperties
type	The resource type	'Microsoft.ContainerRegistry/registries/taskRuns'

OverrideTaskStepProperties

Name	Description	Value
arguments	Gets or sets the collection of override arguments to be used when executing a build step.	Argument[]
contextPath	The source context against which run has to be queued.	string
file	The file against which run has to be queued.	string
target	The name of the target build stage for the docker build.	string
updateTriggerToken	Base64 encoded update trigger token that will be attached with the base image trigger webhook.	string
values	The collection of overridable values that can be passed when running a Task.	SetValue[]

PlatformProperties

Name	Description	Value
architecture	The OS architecture.	'386' 'amd64' 'arm' 'arm64' 'x86'
os	The operating system type required for the run.	'Linux' 'Windows' (required)
variant	Variant of the CPU.	'v6' 'v7' 'v8'

RunRequest

Name	Description	Value
agentPoolName	The dedicated agent pool for the run.	string
isArchiveEnabled	The value that indicates whether archiving is enabled for the run or not.	bool
logTemplate	The template that describes the repository and tag information for run log artifact.	string
type	Set to 'DockerBuildRequest' for type DockerBuildRequest. Set to 'EncodedTaskRunRequest' for type EncodedTaskRunRequest. Set to 'FileTaskRunRequest' for type FileTaskRunRequest. Set to 'TaskRunRequest' for type TaskRunRequest.	'DockerBuildRequest' 'EncodedTaskRunRequest' 'FileTaskRunRequest' 'TaskRunRequest' (required)

SecretObject

Name	Description	Value
type	The type of the secret object which determines how the value of the secret object has to be interpreted.	'Opaque' 'Vaultsecret'
value	The value of the secret. The format of this value will be determined based on the type of the secret object. If the type is Opaque, the value will be used as is without any modification.	string

SetValue

Name	Description	Value
isSecret	Flag to indicate whether the value represents a secret or not.	bool
name	The name of the overridable value.	string (required)
value	The overridable value.	string (required)

SourceRegistryCredentials

Name	Description	Value
loginMode	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.	'Default' 'None'

TaskRunProperties

Name	Description	Value
forceUpdateTag	How the run should be forced to rerun even if the run request configuration has not changed	string
runRequest	The request (parameters) for the run	RunRequest

TaskRunRequest

Name	Description	Value
overrideTaskStepProperties	Set of overridable parameters that can be passed when running a Task.	OverrideTaskStepProperties
taskId	The resource ID of task against which run has to be queued.	string (required)
type	The type of the run request.	'TaskRunRequest' (required)

UserIdentityProperties

Name	Description	Value
clientId	The client id of user assigned identity.	string
principalId	The principal id of user assigned identity.	string

Terraform (AzAPI provider) resource definition

The registries/taskRuns resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ContainerRegistry/registries/taskRuns resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerRegistry/registries/taskRuns@2019-06-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  body = jsonencode({
    properties = {
      forceUpdateTag = "string"
      runRequest = {
        agentPoolName = "string"
        isArchiveEnabled = bool
        logTemplate = "string"
        type = "string"
        // For remaining properties, see RunRequest objects
      }
    }
  })
}

RunRequest objects

Set the type property to specify the type of object.

For DockerBuildRequest, use:

{
  agentConfiguration = {
    cpu = int
  }
  arguments = [
    {
      isSecret = bool
      name = "string"
      value = "string"
    }
  ]
  credentials = {
    customRegistries = {
      {customized property} = {
        identity = "string"
        password = {
          type = "string"
          value = "string"
        }
        userName = {
          type = "string"
          value = "string"
        }
      }
    }
    sourceRegistry = {
      loginMode = "string"
    }
  }
  dockerFilePath = "string"
  imageNames = [
    "string"
  ]
  isPushEnabled = bool
  noCache = bool
  platform = {
    architecture = "string"
    os = "string"
    variant = "string"
  }
  sourceLocation = "string"
  target = "string"
  timeout = int
  type = "DockerBuildRequest"
}

For EncodedTaskRunRequest, use:

{
  agentConfiguration = {
    cpu = int
  }
  credentials = {
    customRegistries = {
      {customized property} = {
        identity = "string"
        password = {
          type = "string"
          value = "string"
        }
        userName = {
          type = "string"
          value = "string"
        }
      }
    }
    sourceRegistry = {
      loginMode = "string"
    }
  }
  encodedTaskContent = "string"
  encodedValuesContent = "string"
  platform = {
    architecture = "string"
    os = "string"
    variant = "string"
  }
  sourceLocation = "string"
  timeout = int
  type = "EncodedTaskRunRequest"
  values = [
    {
      isSecret = bool
      name = "string"
      value = "string"
    }
  ]
}

For FileTaskRunRequest, use:

{
  agentConfiguration = {
    cpu = int
  }
  credentials = {
    customRegistries = {
      {customized property} = {
        identity = "string"
        password = {
          type = "string"
          value = "string"
        }
        userName = {
          type = "string"
          value = "string"
        }
      }
    }
    sourceRegistry = {
      loginMode = "string"
    }
  }
  platform = {
    architecture = "string"
    os = "string"
    variant = "string"
  }
  sourceLocation = "string"
  taskFilePath = "string"
  timeout = int
  type = "FileTaskRunRequest"
  values = [
    {
      isSecret = bool
      name = "string"
      value = "string"
    }
  ]
  valuesFilePath = "string"
}

For TaskRunRequest, use:

{
  overrideTaskStepProperties = {
    arguments = [
      {
        isSecret = bool
        name = "string"
        value = "string"
      }
    ]
    contextPath = "string"
    file = "string"
    target = "string"
    updateTriggerToken = "string"
    values = [
      {
        isSecret = bool
        name = "string"
        value = "string"
      }
    ]
  }
  taskId = "string"
  type = "TaskRunRequest"
}

Property values

AgentProperties

Name	Description	Value
cpu	The CPU configuration in terms of number of cores required for the run.	int

Argument

Name	Description	Value
isSecret	Flag to indicate whether the argument represents a secret and want to be removed from build logs.	bool
name	The name of the argument.	string (required)
value	The value of the argument.	string (required)

Credentials

Name	Description	Value
customRegistries	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.	CredentialsCustomRegistries
sourceRegistry	Describes the credential parameters for accessing the source registry.	SourceRegistryCredentials

CredentialsCustomRegistries

Name	Description	Value

CustomRegistryCredentials

Name	Description	Value
identity	Indicates the managed identity assigned to the custom credential. If a user-assigned identity this value is the Client ID. If a system-assigned identity, the value will be `system`. In the case of a system-assigned identity, the Client ID will be determined by the runner. This identity may be used to authenticate to key vault to retrieve credentials or it may be the only source of authentication used for accessing the registry.	string
password	The password for logging into the custom registry. The password is a secret object that allows multiple ways of providing the value for it.	SecretObject
userName	The username for logging into the custom registry.	SecretObject

DockerBuildRequest

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
arguments	The collection of override arguments to be used when executing the run.	Argument[]
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
dockerFilePath	The Docker file path relative to the source location.	string (required)
imageNames	The fully qualified image names including the repository and tag.	string[]
isPushEnabled	The value of this property indicates whether the image built should be pushed to the registry or not.	bool
noCache	The value of this property indicates whether the image cache is enabled or not.	bool
platform	The platform properties against which the run has to happen.	PlatformProperties (required)
sourceLocation	The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.	string
target	The name of the target build stage for the docker build.	string
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
type	The type of the run request.	'DockerBuildRequest' (required)

EncodedTaskRunRequest

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
encodedTaskContent	Base64 encoded value of the template/definition file content.	string (required)
encodedValuesContent	Base64 encoded value of the parameters/values file content.	string
platform	The platform properties against which the run has to happen.	PlatformProperties (required)
sourceLocation	The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.	string
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
type	The type of the run request.	'EncodedTaskRunRequest' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]

FileTaskRunRequest

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
platform	The platform properties against which the run has to happen.	PlatformProperties (required)
sourceLocation	The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.	string
taskFilePath	The template/definition file path relative to the source.	string (required)
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
type	The type of the run request.	'FileTaskRunRequest' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]
valuesFilePath	The values/parameters file path relative to the source.	string

IdentityProperties

Name	Description	Value
principalId	The principal ID of resource identity.	string
tenantId	The tenant ID of resource.	string
type	The identity type.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	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}'.	IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Name	Description	Value

Microsoft.ContainerRegistry/registries/taskRuns

Name	Description	Value
identity	Identity for the resource.	IdentityProperties
location	The location of the resource	string
name	The resource name	string Constraints: Min length = 5 Max length = 5 Pattern = `^[a-zA-Z0-9-]*$` (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: registries
properties	The properties associated with the task run, i.e., request and result of the run	TaskRunProperties
type	The resource type	"Microsoft.ContainerRegistry/registries/taskRuns@2019-06-01-preview"

OverrideTaskStepProperties

Name	Description	Value
arguments	Gets or sets the collection of override arguments to be used when executing a build step.	Argument[]
contextPath	The source context against which run has to be queued.	string
file	The file against which run has to be queued.	string
target	The name of the target build stage for the docker build.	string
updateTriggerToken	Base64 encoded update trigger token that will be attached with the base image trigger webhook.	string
values	The collection of overridable values that can be passed when running a Task.	SetValue[]

PlatformProperties

Name	Description	Value
architecture	The OS architecture.	'386' 'amd64' 'arm' 'arm64' 'x86'
os	The operating system type required for the run.	'Linux' 'Windows' (required)
variant	Variant of the CPU.	'v6' 'v7' 'v8'

RunRequest

Name	Description	Value
agentPoolName	The dedicated agent pool for the run.	string
isArchiveEnabled	The value that indicates whether archiving is enabled for the run or not.	bool
logTemplate	The template that describes the repository and tag information for run log artifact.	string
type	Set to 'DockerBuildRequest' for type DockerBuildRequest. Set to 'EncodedTaskRunRequest' for type EncodedTaskRunRequest. Set to 'FileTaskRunRequest' for type FileTaskRunRequest. Set to 'TaskRunRequest' for type TaskRunRequest.	'DockerBuildRequest' 'EncodedTaskRunRequest' 'FileTaskRunRequest' 'TaskRunRequest' (required)

SecretObject

Name	Description	Value
type	The type of the secret object which determines how the value of the secret object has to be interpreted.	'Opaque' 'Vaultsecret'
value	The value of the secret. The format of this value will be determined based on the type of the secret object. If the type is Opaque, the value will be used as is without any modification.	string

SetValue

Name	Description	Value
isSecret	Flag to indicate whether the value represents a secret or not.	bool
name	The name of the overridable value.	string (required)
value	The overridable value.	string (required)

SourceRegistryCredentials

Name	Description	Value
loginMode	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.	'Default' 'None'

TaskRunProperties

Name	Description	Value
forceUpdateTag	How the run should be forced to rerun even if the run request configuration has not changed	string
runRequest	The request (parameters) for the run	RunRequest

TaskRunRequest

Name	Description	Value
overrideTaskStepProperties	Set of overridable parameters that can be passed when running a Task.	OverrideTaskStepProperties
taskId	The resource ID of task against which run has to be queued.	string (required)
type	The type of the run request.	'TaskRunRequest' (required)

UserIdentityProperties

Name	Description	Value
clientId	The client id of user assigned identity.	string
principalId	The principal id of user assigned identity.	string

Share via

Microsoft.ContainerRegistry registries/taskRuns 2019-06-01-preview

Bicep resource definition

Resource format

RunRequest objects

Property values

AgentProperties

Argument

Credentials

CredentialsCustomRegistries

CustomRegistryCredentials

DockerBuildRequest

EncodedTaskRunRequest

FileTaskRunRequest

IdentityProperties

IdentityPropertiesUserAssignedIdentities

Microsoft.ContainerRegistry/registries/taskRuns

OverrideTaskStepProperties

PlatformProperties

RunRequest

SecretObject

SetValue

SourceRegistryCredentials

TaskRunProperties

TaskRunRequest

UserIdentityProperties

ARM template resource definition

Resource format

RunRequest objects

Property values

AgentProperties

Argument

Credentials

CredentialsCustomRegistries

CustomRegistryCredentials

DockerBuildRequest

EncodedTaskRunRequest

FileTaskRunRequest

IdentityProperties

IdentityPropertiesUserAssignedIdentities

Microsoft.ContainerRegistry/registries/taskRuns

OverrideTaskStepProperties

PlatformProperties

RunRequest

SecretObject

SetValue

SourceRegistryCredentials

TaskRunProperties

TaskRunRequest

UserIdentityProperties

Terraform (AzAPI provider) resource definition

Resource format

RunRequest objects

Property values

AgentProperties

Argument

Credentials

CredentialsCustomRegistries

CustomRegistryCredentials

DockerBuildRequest

EncodedTaskRunRequest

FileTaskRunRequest

IdentityProperties

IdentityPropertiesUserAssignedIdentities

Microsoft.ContainerRegistry/registries/taskRuns

OverrideTaskStepProperties

PlatformProperties

RunRequest

SecretObject

SetValue

SourceRegistryCredentials

TaskRunProperties

TaskRunRequest

UserIdentityProperties

Feedback

Additional resources