Microsoft.ContainerRegistry registries/tasks

Article
12/09/2024

Bicep resource definition

The registries/tasks 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/tasks resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerRegistry/registries/tasks@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: {
    agentConfiguration: {
      cpu: int
    }
    agentPoolName: 'string'
    credentials: {
      customRegistries: {
        {customized property}: {
          identity: 'string'
          password: {
            type: 'string'
            value: 'string'
          }
          userName: {
            type: 'string'
            value: 'string'
          }
        }
      }
      sourceRegistry: {
        loginMode: 'string'
      }
    }
    isSystemTask: bool
    logTemplate: 'string'
    platform: {
      architecture: 'string'
      os: 'string'
      variant: 'string'
    }
    status: 'string'
    step: {
      contextAccessToken: 'string'
      contextPath: 'string'
      type: 'string'
      // For remaining properties, see TaskStepProperties objects
    }
    timeout: int
    trigger: {
      baseImageTrigger: {
        baseImageTriggerType: 'string'
        name: 'string'
        status: 'string'
        updateTriggerEndpoint: 'string'
        updateTriggerPayloadType: 'string'
      }
      sourceTriggers: [
        {
          name: 'string'
          sourceRepository: {
            branch: 'string'
            repositoryUrl: 'string'
            sourceControlAuthProperties: {
              expiresIn: int
              refreshToken: 'string'
              scope: 'string'
              token: 'string'
              tokenType: 'string'
            }
            sourceControlType: 'string'
          }
          sourceTriggerEvents: [
            'string'
          ]
          status: 'string'
        }
      ]
      timerTriggers: [
        {
          name: 'string'
          schedule: 'string'
          status: 'string'
        }
      ]
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

TaskStepProperties objects

Set the type property to specify the type of object.

For Docker, use:

{
  arguments: [
    {
      isSecret: bool
      name: 'string'
      value: 'string'
    }
  ]
  dockerFilePath: 'string'
  imageNames: [
    'string'
  ]
  isPushEnabled: bool
  noCache: bool
  target: 'string'
  type: 'Docker'
}

For EncodedTask, use:

{
  encodedTaskContent: 'string'
  encodedValuesContent: 'string'
  type: 'EncodedTask'
  values: [
    {
      isSecret: bool
      name: 'string'
      value: 'string'
    }
  ]
}

For FileTask, use:

{
  taskFilePath: 'string'
  type: 'FileTask'
  values: [
    {
      isSecret: bool
      name: 'string'
      value: 'string'
    }
  ]
  valuesFilePath: 'string'
}

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)

AuthInfo

Name	Description	Value
expiresIn	Time in seconds that the token remains valid	int
refreshToken	The refresh token used to refresh the access token.	string
scope	The scope of the access token.	string
token	The access token used to access the source control provider.	string (required)
tokenType	The type of Auth token.	'OAuth' 'PAT' (required)

BaseImageTrigger

Name	Description	Value
baseImageTriggerType	The type of the auto trigger for base image dependency updates.	'All' 'Runtime' (required)
name	The name of the trigger.	string (required)
status	The current status of trigger.	'Disabled' 'Enabled'
updateTriggerEndpoint	The endpoint URL for receiving update triggers.	string
updateTriggerPayloadType	Type of Payload body for Base image update triggers.	'Default' 'Token'

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

DockerBuildStep

Name	Description	Value
arguments	The collection of override arguments to be used when executing this build step.	Argument[]
dockerFilePath	The Docker file path relative to the source context.	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
target	The name of the target build stage for the docker build.	string
type	The type of the step.	'Docker' (required)

EncodedTaskStep

Name	Description	Value
encodedTaskContent	Base64 encoded value of the template/definition file content.	string (required)
encodedValuesContent	Base64 encoded value of the parameters/values file content.	string
type	The type of the step.	'EncodedTask' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]

FileTaskStep

Name	Description	Value
taskFilePath	The task template/definition file path relative to the source context.	string (required)
type	The type of the step.	'FileTask' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]
valuesFilePath	The task values/parameters file path relative to the source context.	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/tasks

Name	Description	Value
identity	Identity for the resource.	IdentityProperties
location	The location of the resource. This cannot be changed after the resource is created.	string (required)
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 of a task.	TaskProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

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'

ResourceTags

Name	Description	Value

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)

SourceProperties

Name	Description	Value
branch	The branch name of the source code.	string
repositoryUrl	The full URL to the source code repository	string (required)
sourceControlAuthProperties	The authorization properties for accessing the source code repository and to set up webhooks for notifications.	AuthInfo
sourceControlType	The type of source control service.	'Github' 'VisualStudioTeamService' (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'

SourceTrigger

Name	Description	Value
name	The name of the trigger.	string (required)
sourceRepository	The properties that describes the source(code) for the task.	SourceProperties (required)
sourceTriggerEvents	The source event corresponding to the trigger.	String array containing any of: 'commit' 'pullrequest' (required)
status	The current status of trigger.	'Disabled' 'Enabled'

TaskProperties

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
agentPoolName	The dedicated agent pool for the task.	string
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
isSystemTask	The value of this property indicates whether the task resource is system task or not.	bool
logTemplate	The template that describes the repository and tag information for run log artifact.	string
platform	The platform properties against which the run has to happen.	PlatformProperties
status	The current status of task.	'Disabled' 'Enabled'
step	The properties of a task step.	TaskStepProperties
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
trigger	The properties that describe all triggers for the task.	TriggerProperties

TaskStepProperties

Name	Description	Value
contextAccessToken	The token (git PAT or SAS token of storage account blob) associated with the context for a step.	string
contextPath	The URL(absolute or relative) of the source context for the task step.	string
type	Set to 'Docker' for type DockerBuildStep. Set to 'EncodedTask' for type EncodedTaskStep. Set to 'FileTask' for type FileTaskStep.	'Docker' 'EncodedTask' 'FileTask' (required)

TimerTrigger

Name	Description	Value
name	The name of the trigger.	string (required)
schedule	The CRON expression for the task schedule	string (required)
status	The current status of trigger.	'Disabled' 'Enabled'

TriggerProperties

Name	Description	Value
baseImageTrigger	The trigger based on base image dependencies.	BaseImageTrigger
sourceTriggers	The collection of triggers based on source code repository.	SourceTrigger[]
timerTriggers	The collection of timer triggers.	TimerTrigger[]

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/tasks 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/tasks resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerRegistry/registries/tasks",
  "apiVersion": "2019-06-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "agentConfiguration": {
      "cpu": "int"
    },
    "agentPoolName": "string",
    "credentials": {
      "customRegistries": {
        "{customized property}": {
          "identity": "string",
          "password": {
            "type": "string",
            "value": "string"
          },
          "userName": {
            "type": "string",
            "value": "string"
          }
        }
      },
      "sourceRegistry": {
        "loginMode": "string"
      }
    },
    "isSystemTask": "bool",
    "logTemplate": "string",
    "platform": {
      "architecture": "string",
      "os": "string",
      "variant": "string"
    },
    "status": "string",
    "step": {
      "contextAccessToken": "string",
      "contextPath": "string",
      "type": "string"
      // For remaining properties, see TaskStepProperties objects
    },
    "timeout": "int",
    "trigger": {
      "baseImageTrigger": {
        "baseImageTriggerType": "string",
        "name": "string",
        "status": "string",
        "updateTriggerEndpoint": "string",
        "updateTriggerPayloadType": "string"
      },
      "sourceTriggers": [
        {
          "name": "string",
          "sourceRepository": {
            "branch": "string",
            "repositoryUrl": "string",
            "sourceControlAuthProperties": {
              "expiresIn": "int",
              "refreshToken": "string",
              "scope": "string",
              "token": "string",
              "tokenType": "string"
            },
            "sourceControlType": "string"
          },
          "sourceTriggerEvents": [ "string" ],
          "status": "string"
        }
      ],
      "timerTriggers": [
        {
          "name": "string",
          "schedule": "string",
          "status": "string"
        }
      ]
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

TaskStepProperties objects

Set the type property to specify the type of object.

For Docker, use:

{
  "arguments": [
    {
      "isSecret": "bool",
      "name": "string",
      "value": "string"
    }
  ],
  "dockerFilePath": "string",
  "imageNames": [ "string" ],
  "isPushEnabled": "bool",
  "noCache": "bool",
  "target": "string",
  "type": "Docker"
}

For EncodedTask, use:

{
  "encodedTaskContent": "string",
  "encodedValuesContent": "string",
  "type": "EncodedTask",
  "values": [
    {
      "isSecret": "bool",
      "name": "string",
      "value": "string"
    }
  ]
}

For FileTask, use:

{
  "taskFilePath": "string",
  "type": "FileTask",
  "values": [
    {
      "isSecret": "bool",
      "name": "string",
      "value": "string"
    }
  ],
  "valuesFilePath": "string"
}

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)

AuthInfo

Name	Description	Value
expiresIn	Time in seconds that the token remains valid	int
refreshToken	The refresh token used to refresh the access token.	string
scope	The scope of the access token.	string
token	The access token used to access the source control provider.	string (required)
tokenType	The type of Auth token.	'OAuth' 'PAT' (required)

BaseImageTrigger

Name	Description	Value
baseImageTriggerType	The type of the auto trigger for base image dependency updates.	'All' 'Runtime' (required)
name	The name of the trigger.	string (required)
status	The current status of trigger.	'Disabled' 'Enabled'
updateTriggerEndpoint	The endpoint URL for receiving update triggers.	string
updateTriggerPayloadType	Type of Payload body for Base image update triggers.	'Default' 'Token'

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

DockerBuildStep

Name	Description	Value
arguments	The collection of override arguments to be used when executing this build step.	Argument[]
dockerFilePath	The Docker file path relative to the source context.	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
target	The name of the target build stage for the docker build.	string
type	The type of the step.	'Docker' (required)

EncodedTaskStep

Name	Description	Value
encodedTaskContent	Base64 encoded value of the template/definition file content.	string (required)
encodedValuesContent	Base64 encoded value of the parameters/values file content.	string
type	The type of the step.	'EncodedTask' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]

FileTaskStep

Name	Description	Value
taskFilePath	The task template/definition file path relative to the source context.	string (required)
type	The type of the step.	'FileTask' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]
valuesFilePath	The task values/parameters file path relative to the source context.	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/tasks

Name	Description	Value
apiVersion	The api version	'2019-06-01-preview'
identity	Identity for the resource.	IdentityProperties
location	The location of the resource. This cannot be changed after the resource is created.	string (required)
name	The resource name	string Constraints: Min length = 5 Max length = 5 Pattern = `^[a-zA-Z0-9-_]*$` (required)
properties	The properties of a task.	TaskProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.ContainerRegistry/registries/tasks'

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'

ResourceTags

Name	Description	Value

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)

SourceProperties

Name	Description	Value
branch	The branch name of the source code.	string
repositoryUrl	The full URL to the source code repository	string (required)
sourceControlAuthProperties	The authorization properties for accessing the source code repository and to set up webhooks for notifications.	AuthInfo
sourceControlType	The type of source control service.	'Github' 'VisualStudioTeamService' (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'

SourceTrigger

Name	Description	Value
name	The name of the trigger.	string (required)
sourceRepository	The properties that describes the source(code) for the task.	SourceProperties (required)
sourceTriggerEvents	The source event corresponding to the trigger.	String array containing any of: 'commit' 'pullrequest' (required)
status	The current status of trigger.	'Disabled' 'Enabled'

TaskProperties

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
agentPoolName	The dedicated agent pool for the task.	string
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
isSystemTask	The value of this property indicates whether the task resource is system task or not.	bool
logTemplate	The template that describes the repository and tag information for run log artifact.	string
platform	The platform properties against which the run has to happen.	PlatformProperties
status	The current status of task.	'Disabled' 'Enabled'
step	The properties of a task step.	TaskStepProperties
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
trigger	The properties that describe all triggers for the task.	TriggerProperties

TaskStepProperties

Name	Description	Value
contextAccessToken	The token (git PAT or SAS token of storage account blob) associated with the context for a step.	string
contextPath	The URL(absolute or relative) of the source context for the task step.	string
type	Set to 'Docker' for type DockerBuildStep. Set to 'EncodedTask' for type EncodedTaskStep. Set to 'FileTask' for type FileTaskStep.	'Docker' 'EncodedTask' 'FileTask' (required)

TimerTrigger

Name	Description	Value
name	The name of the trigger.	string (required)
schedule	The CRON expression for the task schedule	string (required)
status	The current status of trigger.	'Disabled' 'Enabled'

TriggerProperties

Name	Description	Value
baseImageTrigger	The trigger based on base image dependencies.	BaseImageTrigger
sourceTriggers	The collection of triggers based on source code repository.	SourceTrigger[]
timerTriggers	The collection of timer triggers.	TimerTrigger[]

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/tasks 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/tasks resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerRegistry/registries/tasks@2019-06-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      agentConfiguration = {
        cpu = int
      }
      agentPoolName = "string"
      credentials = {
        customRegistries = {
          {customized property} = {
            identity = "string"
            password = {
              type = "string"
              value = "string"
            }
            userName = {
              type = "string"
              value = "string"
            }
          }
        }
        sourceRegistry = {
          loginMode = "string"
        }
      }
      isSystemTask = bool
      logTemplate = "string"
      platform = {
        architecture = "string"
        os = "string"
        variant = "string"
      }
      status = "string"
      step = {
        contextAccessToken = "string"
        contextPath = "string"
        type = "string"
        // For remaining properties, see TaskStepProperties objects
      }
      timeout = int
      trigger = {
        baseImageTrigger = {
          baseImageTriggerType = "string"
          name = "string"
          status = "string"
          updateTriggerEndpoint = "string"
          updateTriggerPayloadType = "string"
        }
        sourceTriggers = [
          {
            name = "string"
            sourceRepository = {
              branch = "string"
              repositoryUrl = "string"
              sourceControlAuthProperties = {
                expiresIn = int
                refreshToken = "string"
                scope = "string"
                token = "string"
                tokenType = "string"
              }
              sourceControlType = "string"
            }
            sourceTriggerEvents = [
              "string"
            ]
            status = "string"
          }
        ]
        timerTriggers = [
          {
            name = "string"
            schedule = "string"
            status = "string"
          }
        ]
      }
    }
  })
}

TaskStepProperties objects

Set the type property to specify the type of object.

For Docker, use:

{
  arguments = [
    {
      isSecret = bool
      name = "string"
      value = "string"
    }
  ]
  dockerFilePath = "string"
  imageNames = [
    "string"
  ]
  isPushEnabled = bool
  noCache = bool
  target = "string"
  type = "Docker"
}

For EncodedTask, use:

{
  encodedTaskContent = "string"
  encodedValuesContent = "string"
  type = "EncodedTask"
  values = [
    {
      isSecret = bool
      name = "string"
      value = "string"
    }
  ]
}

For FileTask, use:

{
  taskFilePath = "string"
  type = "FileTask"
  values = [
    {
      isSecret = bool
      name = "string"
      value = "string"
    }
  ]
  valuesFilePath = "string"
}

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)

AuthInfo

Name	Description	Value
expiresIn	Time in seconds that the token remains valid	int
refreshToken	The refresh token used to refresh the access token.	string
scope	The scope of the access token.	string
token	The access token used to access the source control provider.	string (required)
tokenType	The type of Auth token.	'OAuth' 'PAT' (required)

BaseImageTrigger

Name	Description	Value
baseImageTriggerType	The type of the auto trigger for base image dependency updates.	'All' 'Runtime' (required)
name	The name of the trigger.	string (required)
status	The current status of trigger.	'Disabled' 'Enabled'
updateTriggerEndpoint	The endpoint URL for receiving update triggers.	string
updateTriggerPayloadType	Type of Payload body for Base image update triggers.	'Default' 'Token'

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

DockerBuildStep

Name	Description	Value
arguments	The collection of override arguments to be used when executing this build step.	Argument[]
dockerFilePath	The Docker file path relative to the source context.	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
target	The name of the target build stage for the docker build.	string
type	The type of the step.	'Docker' (required)

EncodedTaskStep

Name	Description	Value
encodedTaskContent	Base64 encoded value of the template/definition file content.	string (required)
encodedValuesContent	Base64 encoded value of the parameters/values file content.	string
type	The type of the step.	'EncodedTask' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]

FileTaskStep

Name	Description	Value
taskFilePath	The task template/definition file path relative to the source context.	string (required)
type	The type of the step.	'FileTask' (required)
values	The collection of overridable values that can be passed when running a task.	SetValue[]
valuesFilePath	The task values/parameters file path relative to the source context.	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/tasks

Name	Description	Value
identity	Identity for the resource.	IdentityProperties
location	The location of the resource. This cannot be changed after the resource is created.	string (required)
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 of a task.	TaskProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.ContainerRegistry/registries/tasks@2019-06-01-preview"

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'

ResourceTags

Name	Description	Value

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)

SourceProperties

Name	Description	Value
branch	The branch name of the source code.	string
repositoryUrl	The full URL to the source code repository	string (required)
sourceControlAuthProperties	The authorization properties for accessing the source code repository and to set up webhooks for notifications.	AuthInfo
sourceControlType	The type of source control service.	'Github' 'VisualStudioTeamService' (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'

SourceTrigger

Name	Description	Value
name	The name of the trigger.	string (required)
sourceRepository	The properties that describes the source(code) for the task.	SourceProperties (required)
sourceTriggerEvents	The source event corresponding to the trigger.	String array containing any of: 'commit' 'pullrequest' (required)
status	The current status of trigger.	'Disabled' 'Enabled'

TaskProperties

Name	Description	Value
agentConfiguration	The machine configuration of the run agent.	AgentProperties
agentPoolName	The dedicated agent pool for the task.	string
credentials	The properties that describes a set of credentials that will be used when this run is invoked.	Credentials
isSystemTask	The value of this property indicates whether the task resource is system task or not.	bool
logTemplate	The template that describes the repository and tag information for run log artifact.	string
platform	The platform properties against which the run has to happen.	PlatformProperties
status	The current status of task.	'Disabled' 'Enabled'
step	The properties of a task step.	TaskStepProperties
timeout	Run timeout in seconds.	int Constraints: Min value = 300 Max value = 28800
trigger	The properties that describe all triggers for the task.	TriggerProperties

TaskStepProperties

Name	Description	Value
contextAccessToken	The token (git PAT or SAS token of storage account blob) associated with the context for a step.	string
contextPath	The URL(absolute or relative) of the source context for the task step.	string
type	Set to 'Docker' for type DockerBuildStep. Set to 'EncodedTask' for type EncodedTaskStep. Set to 'FileTask' for type FileTaskStep.	'Docker' 'EncodedTask' 'FileTask' (required)

TimerTrigger

Name	Description	Value
name	The name of the trigger.	string (required)
schedule	The CRON expression for the task schedule	string (required)
status	The current status of trigger.	'Disabled' 'Enabled'

TriggerProperties

Name	Description	Value
baseImageTrigger	The trigger based on base image dependencies.	BaseImageTrigger
sourceTriggers	The collection of triggers based on source code repository.	SourceTrigger[]
timerTriggers	The collection of timer triggers.	TimerTrigger[]

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/tasks

Bicep resource definition

Resource format

TaskStepProperties objects

Property values

AgentProperties

Argument

AuthInfo

BaseImageTrigger

Credentials

CredentialsCustomRegistries

CustomRegistryCredentials

DockerBuildStep

EncodedTaskStep

FileTaskStep

IdentityProperties

IdentityPropertiesUserAssignedIdentities

Microsoft.ContainerRegistry/registries/tasks

PlatformProperties

ResourceTags

SecretObject

SetValue

SourceProperties

SourceRegistryCredentials

SourceTrigger

TaskProperties

TaskStepProperties

TimerTrigger

TriggerProperties

UserIdentityProperties

ARM template resource definition

Resource format

TaskStepProperties objects

Property values

AgentProperties

Argument

AuthInfo

BaseImageTrigger

Credentials

CredentialsCustomRegistries

CustomRegistryCredentials

DockerBuildStep

EncodedTaskStep

FileTaskStep

IdentityProperties

IdentityPropertiesUserAssignedIdentities

Microsoft.ContainerRegistry/registries/tasks

PlatformProperties

ResourceTags

SecretObject

SetValue

SourceProperties

SourceRegistryCredentials

SourceTrigger

TaskProperties

TaskStepProperties

TimerTrigger

TriggerProperties

UserIdentityProperties

Terraform (AzAPI provider) resource definition

Resource format

TaskStepProperties objects

Property values

AgentProperties

Argument

AuthInfo

BaseImageTrigger

Credentials

CredentialsCustomRegistries

CustomRegistryCredentials

DockerBuildStep

EncodedTaskStep

FileTaskStep

IdentityProperties

IdentityPropertiesUserAssignedIdentities

Microsoft.ContainerRegistry/registries/tasks

PlatformProperties

ResourceTags

SecretObject