你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.ContainerRegistry registries/tasks 2018-09-01

Bicep 资源定义

注册表/任务资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.ContainerRegistry/registries/tasks 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ContainerRegistry/registries/tasks@2018-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    agentConfiguration: {
      cpu: int
    }
    credentials: {
      customRegistries: {}
      sourceRegistry: {
        loginMode: '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'
      }
      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'
        }
      ]
    }
  }
}

TaskStepProperties 对象

设置 type 属性以指定对象的类型。

对于 Docker,请使用:

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

对于 EncodedTask,请使用:

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

对于 FileTask,请使用:

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

属性值

registries/tasks

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)

字符限制:5-50

有效字符:
字母数字、连字符和下划线。
location 资源的位置。 创建资源后,无法更改此设置。 字符串 (必需)
标记 资源的标记。 标记名称和值的字典。 请参阅 模板中的标记
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型为:registries 的资源的符号名称
properties 任务的属性。 TaskProperties

TaskProperties

名称 说明
agentConfiguration 运行代理的计算机配置。 AgentProperties
凭据 描述调用此运行时将使用的一组凭据的属性。 凭据
平台 必须对其执行运行的平台属性。 PlatformProperties (必需)
status 任务的当前状态。 'Disabled'
'Enabled'
步骤 任务步骤的属性。 TaskStepProperties (必需)
timeout 运行超时(以秒为单位)。 int
触发器 描述任务的所有触发器的属性。 TriggerProperties

AgentProperties

名称 说明
cpu 运行所需的核心数的 CPU 配置。 int

凭据

名称 说明
customRegistries 介绍用于访问其他自定义注册表的凭据参数。 密钥
字典项的注册表登录服务器 (myregistry.azurecr.io) 和
项的值将是用于访问注册表的注册表凭据。
object
sourceRegistry 描述用于访问源注册表的凭据参数。 SourceRegistryCredentials

SourceRegistryCredentials

名称 说明
loginMode 确定源注册表登录范围的身份验证模式。 源注册表的凭据
将使用给定的范围生成。 这些凭据将用于登录到
运行期间的源注册表。
'Default'
“None”

PlatformProperties

名称 说明
体系结构 OS 体系结构。 'amd64'
'arm'
'x86'
os 运行所需的操作系统类型。 'Linux'
“Windows” (必需)
variant CPU 的变体。 “v6”
“v7”
“v8”

TaskStepProperties

名称 说明
contextAccessToken 存储帐户 blob 的令牌 (git PAT 或 SAS 令牌) 与步骤的上下文相关联。 string
contextPath URL (任务步骤的源上下文的绝对或相对) 。 string
type 设置对象类型 Docker
EncodedTask
FileTask (必需)

DockerBuildStep

名称 说明 Value
type 步骤的类型。 需要“Docker” ()
参数 在执行此生成步骤时要使用的重写参数的集合。 Argument[]
dockerFilePath 相对于源上下文的 Docker 文件路径。 字符串 (必需)
imageNames 完全限定的映像名称,包括存储库和标记。 string[]
isPushEnabled 此属性的值指示是否应将生成的映像推送到注册表。 bool
noCache 此属性的值指示是否启用图像缓存。 bool
目标 docker 生成的目标生成阶段的名称。 string

参数

名称 说明
isSecret 指示参数是否表示机密并想要从生成日志中删除的标志。 bool
name 参数的名称。 字符串 (必需)
参数的值。 字符串 (必需)

EncodedTaskStep

名称 说明 Value
type 步骤的类型。 “EncodedTask” (必需)
encodedTaskContent 模板/定义文件内容的 Base64 编码值。 字符串 (必需)
encodedValuesContent 参数/值文件内容的 Base64 编码值。 string
运行任务时可传递的可重写值的集合。 SetValue[]

SetValue

名称 说明
isSecret 指示值是否表示机密的标志。 bool
name 可重写值的名称。 字符串 (必需)
可重写的值。 字符串 (必需)

FileTaskStep

名称 说明 Value
type 步骤的类型。 “FileTask” (必需)
taskFilePath 相对于源上下文的任务模板/定义文件路径。 字符串 (必需)
运行任务时可以传递的可重写值的集合。 SetValue[]
valuesFilePath 相对于源上下文的任务值/参数文件路径。 string

TriggerProperties

名称 说明
baseImageTrigger 基于基础映像依赖项的触发器。 BaseImageTrigger
sourceTriggers 基于源代码存储库的触发器集合。 SourceTrigger[]

BaseImageTrigger

名称 说明
baseImageTriggerType 基础映像依赖项更新的自动触发器的类型。 “All”
“Runtime” (必需)
name 触发器的名称。 字符串 (必需)
status 触发器的当前状态。 “Disabled”
“已启用”

SourceTrigger

名称 说明
name 触发器的名称。 字符串 (必需)
sourceRepository 描述任务的源 (代码的属性) 。 SourceProperties (必需)
sourceTriggerEvents 与触发器对应的源事件。 包含任意项的字符串数组:
“commit”
需要“pullrequest” ()
status 触发器的当前状态。 “Disabled”
“已启用”

SourceProperties

名称 说明
branch 源代码的分支名称。 string
repositoryUrl 源代码存储库的完整 URL 字符串 (必需)
sourceControlAuthProperties 用于访问源代码存储库和设置的授权属性
通知的 webhook。
AuthInfo
sourceControlType 源代码管理服务的类型。 “Github”
需要“VisualStudioTeamService” ()

AuthInfo

名称 说明
expiresIn 令牌保持有效的时间(秒) int
refreshToken 用于刷新访问令牌的刷新令牌。 string
scope 访问令牌的范围。 string
令牌 用于访问源代码管理提供程序的访问令牌。 字符串 (必需)
tokenType 身份验证令牌的类型。 'OAuth'
需要“PAT” ()

ARM 模板资源定义

注册表/任务资源类型可以使用面向以下对象的操作进行部署:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.ContainerRegistry/registries/tasks 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ContainerRegistry/registries/tasks",
  "apiVersion": "2018-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "agentConfiguration": {
      "cpu": "int"
    },
    "credentials": {
      "customRegistries": {},
      "sourceRegistry": {
        "loginMode": "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"
      },
      "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"
        }
      ]
    }
  }
}

TaskStepProperties 对象

设置 type 属性以指定对象的类型。

对于 Docker,请使用:

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

对于 EncodedTask,请使用:

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

对于 FileTask,请使用:

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

属性值

registries/tasks

名称 说明 Value
type 资源类型 'Microsoft.ContainerRegistry/registries/tasks'
apiVersion 资源 API 版本 '2018-09-01'
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
字符串 (必需)

字符限制:5-50

有效字符:
字母数字、连字符和下划线。
location 资源的位置。 创建资源后,无法更改此设置。 字符串 (必需)
标记 资源的标记。 标记名称和值的字典。 请参阅 模板中的标记
properties 任务的属性。 TaskProperties

TaskProperties

名称 说明
agentConfiguration 运行代理的计算机配置。 AgentProperties
凭据 描述调用此运行时将使用的一组凭据的属性。 凭据
平台 必须对其执行运行的平台属性。 PlatformProperties (必需)
status 任务的当前状态。 'Disabled'
'Enabled'
步骤 任务步骤的属性。 TaskStepProperties (必需)
timeout 运行超时(以秒为单位)。 int
触发器 描述任务的所有触发器的属性。 TriggerProperties

AgentProperties

名称 说明
cpu 运行所需的核心数的 CPU 配置。 int

凭据

名称 说明
customRegistries 介绍用于访问其他自定义注册表的凭据参数。 密钥
字典项的注册表登录服务器 (myregistry.azurecr.io) 和
项的值将是用于访问注册表的注册表凭据。
object
sourceRegistry 描述用于访问源注册表的凭据参数。 SourceRegistryCredentials

SourceRegistryCredentials

名称 说明
loginMode 确定源注册表登录范围的身份验证模式。 源注册表的凭据
将使用给定的范围生成。 这些凭据将用于登录到
运行期间的源注册表。
'Default'
“None”

PlatformProperties

名称 说明
体系结构 OS 体系结构。 'amd64'
'arm'
'x86'
os 运行所需的操作系统类型。 'Linux'
“Windows” (必需)
variant CPU 的变体。 “v6”
“v7”
“v8”

TaskStepProperties

名称 说明
contextAccessToken 存储帐户 blob 的令牌 (git PAT 或 SAS 令牌) 与步骤的上下文相关联。 string
contextPath URL (任务步骤的源上下文的绝对或相对) 。 string
type 设置对象类型 Docker
EncodedTask
FileTask (必需)

DockerBuildStep

名称 说明 Value
type 步骤的类型。 需要“Docker” ()
参数 在执行此生成步骤时要使用的重写参数的集合。 Argument[]
dockerFilePath 相对于源上下文的 Docker 文件路径。 字符串 (必需)
imageNames 完全限定的映像名称,包括存储库和标记。 string[]
isPushEnabled 此属性的值指示是否应将生成的映像推送到注册表。 bool
noCache 此属性的值指示是否启用图像缓存。 bool
目标 docker 生成的目标生成阶段的名称。 string

参数

名称 说明
isSecret 指示参数是否表示机密并想要从生成日志中删除的标志。 bool
name 参数的名称。 字符串 (必需)
参数的值。 字符串 (必需)

EncodedTaskStep

名称 说明 Value
type 步骤的类型。 “EncodedTask” (必需)
encodedTaskContent 模板/定义文件内容的 Base64 编码值。 字符串 (必需)
encodedValuesContent 参数/值文件内容的 Base64 编码值。 string
运行任务时可传递的可重写值的集合。 SetValue[]

SetValue

名称 说明
isSecret 指示值是否表示机密的标志。 bool
name 可重写值的名称。 字符串 (必需)
可重写的值。 字符串 (必需)

FileTaskStep

名称 说明 Value
type 步骤的类型。 “FileTask” (必需)
taskFilePath 相对于源上下文的任务模板/定义文件路径。 字符串 (必需)
运行任务时可传递的可重写值的集合。 SetValue[]
valuesFilePath 相对于源上下文的任务值/参数文件路径。 string

TriggerProperties

名称 说明
baseImageTrigger 基于基础映像依赖项的触发器。 BaseImageTrigger
sourceTriggers 基于源代码存储库的触发器集合。 SourceTrigger[]

BaseImageTrigger

名称 说明
baseImageTriggerType 基础映像依赖项更新的自动触发器的类型。 “All”
需要“运行时” ()
name 触发器的名称。 字符串 (必需)
status 触发器的当前状态。 'Disabled'
'Enabled'

SourceTrigger

名称 说明
name 触发器的名称。 字符串 (必需)
sourceRepository 描述任务的源 (代码) 的属性。 SourceProperties (必需)
sourceTriggerEvents 与触发器对应的源事件。 包含任何一项的字符串数组:
'commit'
需要“pullrequest” ()
status 触发器的当前状态。 'Disabled'
'Enabled'

SourceProperties

名称 说明
branch 源代码的分支名称。 string
repositoryUrl 源代码存储库的完整 URL 字符串 (必需)
sourceControlAuthProperties 用于访问源代码存储库和设置的授权属性
用于通知的 webhook。
AuthInfo
sourceControlType 源代码管理服务的类型。 “Github”
需要“VisualStudioTeamService” ()

AuthInfo

名称 说明
expiresIn 令牌保持有效的时间(秒) int
refreshToken 用于刷新访问令牌的刷新令牌。 string
scope 访问令牌的范围。 string
令牌 用于访问源代码管理提供程序的访问令牌。 字符串 (必需)
tokenType 身份验证令牌的类型。 'OAuth'
需要“PAT” ()

Terraform (AzAPI 提供程序) 资源定义

注册表/任务资源类型可以使用面向以下对象的操作进行部署:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.ContainerRegistry/registries/tasks 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerRegistry/registries/tasks@2018-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      agentConfiguration = {
        cpu = int
      }
      credentials = {
        customRegistries = {}
        sourceRegistry = {
          loginMode = "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"
        }
        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"
          }
        ]
      }
    }
  })
}

TaskStepProperties 对象

设置 type 属性以指定对象的类型。

对于 Docker,请使用:

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

对于 EncodedTask,请使用:

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

对于 FileTask,请使用:

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

属性值

registries/tasks

名称 说明 Value
type 资源类型 “Microsoft.ContainerRegistry/registries/tasks@2018-09-01”
name 资源名称 字符串 (必需)

字符限制:5-50

有效字符:
字母数字、连字符和下划线字符。
location 资源的位置。 创建资源后,无法更改此设置。 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型为:注册表的资源的 ID
标记 资源的标记。 标记名称和值的字典。
properties 任务的属性。 TaskProperties

TaskProperties

名称 说明
agentConfiguration 运行代理的计算机配置。 AgentProperties
凭据 描述调用此运行时将使用的一组凭据的属性。 凭据
平台 必须对其执行运行的平台属性。 PlatformProperties (必需)
status 任务的当前状态。 “Disabled”
“Enabled”
步骤 任务步骤的属性。 TaskStepProperties (必需)
timeout 运行超时(以秒为单位)。 int
触发器 描述任务的所有触发器的属性。 TriggerProperties

AgentProperties

名称 说明
cpu 运行所需的核心数的 CPU 配置。 int

凭据

名称 说明
customRegistries 介绍用于访问其他自定义注册表的凭据参数。 密钥
字典项的注册表登录服务器 (myregistry.azurecr.io) 和
项的值将是用于访问注册表的注册表凭据。
object
sourceRegistry 描述用于访问源注册表的凭据参数。 SourceRegistryCredentials

SourceRegistryCredentials

名称 说明
loginMode 确定源注册表登录范围的身份验证模式。 源注册表的凭据
将使用给定的范围生成。 这些凭据将用于登录到
运行期间的源注册表。
“Default”
"None"

PlatformProperties

名称 说明
体系结构 OS 体系结构。 “amd64”
“arm”
“x86”
os 运行所需的操作系统类型。 “Linux”
“Windows” (必需)
variant CPU 的变体。 “v6”
“v7”
“v8”

TaskStepProperties

名称 说明
contextAccessToken 存储帐户 blob 的 git PAT 或 SAS 令牌 (令牌) 与步骤的上下文相关联。 string
contextPath URL (任务步骤的源上下文的绝对或相对) 。 string
type 设置对象类型 Docker
EncodedTask
FileTask (必需)

DockerBuildStep

名称 说明 Value
type 步骤的类型。 “Docker” (必需)
参数 在执行此生成步骤时要使用的替代参数集合。 Argument[]
dockerFilePath 相对于源上下文的 Docker 文件路径。 字符串 (必需)
imageNames 完全限定的映像名称,包括存储库和标记。 string[]
isPushEnabled 此属性的值指示是否应将生成的映像推送到注册表。 bool
noCache 此属性的值指示是否启用图像缓存。 bool
目标 Docker 生成的目标生成阶段的名称。 string

参数

名称 说明
isSecret 指示参数是否表示机密并想要从生成日志中删除的标志。 bool
name 参数的名称。 字符串 (必需)
参数的值。 字符串 (必需)

EncodedTaskStep

名称 说明 Value
type 步骤的类型。 “EncodedTask” (必需)
encodedTaskContent 模板/定义文件内容的 Base64 编码值。 字符串 (必需)
encodedValuesContent 参数/值文件内容的 Base64 编码值。 string
运行任务时可以传递的可重写值的集合。 SetValue[]

SetValue

名称 说明
isSecret 指示值是否表示机密的标志。 bool
name 可重写值的名称。 字符串 (必需)
可重写的值。 字符串 (必需)

FileTaskStep

名称 说明 Value
type 步骤的类型。 “FileTask” (必需)
taskFilePath 相对于源上下文的任务模板/定义文件路径。 字符串 (必需)
运行任务时可传递的可重写值的集合。 SetValue[]
valuesFilePath 相对于源上下文的任务值/参数文件路径。 string

TriggerProperties

名称 说明
baseImageTrigger 基于基础映像依赖项的触发器。 BaseImageTrigger
sourceTriggers 基于源代码存储库的触发器集合。 SourceTrigger[]

BaseImageTrigger

名称 说明
baseImageTriggerType 基础映像依赖项更新的自动触发器的类型。 “全部”
需要“运行时” ()
name 触发器的名称。 字符串 (必需)
status 触发器的当前状态。 “Disabled”
“Enabled”

SourceTrigger

名称 说明
name 触发器的名称。 字符串 (必需)
sourceRepository 描述任务的源 (代码) 的属性。 SourceProperties (必需)
sourceTriggerEvents 与触发器对应的源事件。 包含任何一项的字符串数组:
“commit”
需要“pullrequest” ()
status 触发器的当前状态。 “Disabled”
“Enabled”

SourceProperties

名称 说明
branch 源代码的分支名称。 string
repositoryUrl 源代码存储库的完整 URL 字符串 (必需)
sourceControlAuthProperties 用于访问源代码存储库和设置的授权属性
用于通知的 webhook。
AuthInfo
sourceControlType 源代码管理服务的类型。 “Github”
“VisualStudioTeamService” (必需)

AuthInfo

名称 说明
expiresIn 令牌保持有效的时间(秒) int
refreshToken 用于刷新访问令牌的刷新令牌。 string
scope 访问令牌的范围。 string
令牌 用于访问源代码管理提供程序的访问令牌。 字符串 (必需)
tokenType 身份验证令牌的类型。 “OAuth”
需要“PAT” ()