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

  • Artikel
  • 7 menit untuk membaca

The registries/tasks resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

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

Template format

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

resource symbolicname 'Microsoft.ContainerRegistry/registries/tasks@2019-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    agentConfiguration: {
      cpu: int
    }
    agentPoolName: 'string'
    credentials: {
      customRegistries: {}
      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:

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

For EncodedTask, use:

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

For FileTask, use:

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

Property values

registries/tasks

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.ContainerRegistry/registries/tasks'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2019-06-01-preview'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.		 string (required)

Character limit: 5-50

Valid characters:
Alphanumerics, hyphens, and underscores.
location The location of the resource. This cannot be changed after the resource is created. string (required)
tags The tags of the resource. Dictionary of tag names and values. See Tags in templates
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
identity Identity for the resource. IdentityProperties
properties The properties of a task. TaskProperties

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}'.
 object

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
trigger The properties that describe all triggers for the task. TriggerProperties

AgentProperties

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

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.		 object
sourceRegistry Describes the credential parameters for accessing the source registry. SourceRegistryCredentials

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'

PlatformProperties

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

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 the object type Docker
EncodedTask
FileTask

DockerBuildStep

Name Description Value
type The type of the step. 'Docker'
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

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)

EncodedTaskStep

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

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)

FileTaskStep

Name Description Value
type The type of the step. 'FileTask'
taskFilePath The task template/definition file path relative to the source context. string (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

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[]

BaseImageTrigger

Name Description Value
baseImageTriggerType The type of the auto trigger for base image dependency updates. 'All'
'Runtime'
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'

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'
status The current status of trigger. 'Disabled'
'Enabled'

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'

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'

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'