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

Registries (Tasks) - Schedule Run

根据请求参数计划新的运行,并将其添加到运行队列。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/scheduleRun?api-version=2019-04-01

URI 参数

名称 必需 类型 说明
registryName
path True

string

容器注册表的名称。

正则表达式模式: ^[a-zA-Z0-9]*$

resourceGroupName
path True

string

容器注册表所属的资源组的名称。

subscriptionId
path True

string

Microsoft Azure 订阅 ID。

api-version
query True

string

客户端 API 版本。

请求正文

请求正文可以为下列任一内容:

名称 说明
DockerBuildRequest

docker 快速生成的参数。

EncodedTaskRunRequest

快速任务运行请求的参数。

FileTaskRunRequest

针对任务文件进行计划运行的请求参数。

TaskRunRequest

任务运行请求的参数。

DockerBuildRequest

docker 快速生成的参数。

名称 必需 类型 说明
dockerFilePath True

string

相对于源位置的 Docker 文件路径。

platform True

PlatformProperties

必须对其执行运行的平台属性。

type True string:

DockerBuildRequest

运行请求的类型。

agentConfiguration

AgentProperties

运行代理的计算机配置。

arguments

Argument[]

执行运行时要使用的重写参数的集合。

credentials

Credentials

描述调用此运行时将使用的一组凭据的属性。

imageNames

string[]

完全限定的映像名称,包括存储库和标记。

isArchiveEnabled

boolean

该值指示是否为运行启用存档。

isPushEnabled

boolean

此属性的值指示是否应将生成的映像推送到注册表。

noCache

boolean

此属性的值指示是否启用图像缓存。

sourceLocation

string

URL (源上下文的绝对或相对) 。 它可以是 tar 或 git 存储库的 URL。 如果它是相对 URL,则应从调用 listBuildSourceUploadUrl API 获取相对路径。

target

string

docker 生成的目标生成阶段的名称。

timeout

integer

运行超时(以秒为单位)。

EncodedTaskRunRequest

快速任务运行请求的参数。

名称 必需 类型 说明
encodedTaskContent True

string

模板/定义文件内容的 Base64 编码值。

platform True

PlatformProperties

必须对其执行运行的平台属性。

type True string:

EncodedTaskRunRequest

运行请求的类型。

agentConfiguration

AgentProperties

运行代理的计算机配置。

credentials

Credentials

描述调用此运行时将使用的一组凭据的属性。

encodedValuesContent

string

参数/值文件内容的 Base64 编码值。

isArchiveEnabled

boolean

该值指示是否为运行启用存档。

sourceLocation

string

URL (源上下文的绝对或相对) 。 它可以是 tar 或 git 存储库的 URL。 如果它是相对 URL,则应从调用 listBuildSourceUploadUrl API 获取相对路径。

timeout

integer

运行超时(以秒为单位)。

values

SetValue[]

运行任务时可传递的可重写值的集合。

FileTaskRunRequest

针对任务文件进行计划运行的请求参数。

名称 必需 类型 说明
platform True

PlatformProperties

必须对其执行运行的平台属性。

taskFilePath True

string

相对于源的模板/定义文件路径。

type True string:

FileTaskRunRequest

运行请求的类型。

agentConfiguration

AgentProperties

运行代理的计算机配置。

credentials

Credentials

描述调用此运行时将使用的一组凭据的属性。

isArchiveEnabled

boolean

该值指示是否为运行启用存档。

sourceLocation

string

URL (源上下文的绝对或相对) 。 它可以是 tar 或 git 存储库的 URL。 如果它是相对 URL,则应从调用 listBuildSourceUploadUrl API 获取相对路径。

timeout

integer

运行超时(以秒为单位)。

values

SetValue[]

运行任务时可传递的可重写值的集合。

valuesFilePath

string

相对于源的值/参数文件路径。

TaskRunRequest

任务运行请求的参数。

名称 必需 类型 说明
taskName True

string

运行必须对其排队的任务的名称。

type True string:

TaskRunRequest

运行请求的类型。

isArchiveEnabled

boolean

该值指示是否为运行启用存档。

values

SetValue[]

运行任务时可传递的可重写值的集合。

响应

名称 类型 说明
200 OK

Run

请求成功;请求格式正确,接收正确。

202 Accepted

请求已成功接受;操作将以异步方式完成。

Other Status Codes

描述操作失败原因的错误响应。 如果注册表/运行不存在,则返回 404 (找不到) 。 如果任何输入参数错误,则返回 400 (错误的请求) 。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Registries_ScheduleRun
Registries_ScheduleRun_EncodedTaskRun
Registries_ScheduleRun_FileTaskRun
Registries_ScheduleRun_Task
Registries_ScheduleRun_Task_WithCustomCredentials
Registries_ScheduleRun_WithCustomCredentials

Registries_ScheduleRun

示例请求

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scheduleRun?api-version=2019-04-01

{
  "type": "DockerBuildRequest",
  "isArchiveEnabled": true,
  "imageNames": [
    "azurerest:testtag"
  ],
  "noCache": true,
  "sourceLocation": "https://myaccount.blob.core.windows.net/sascontainer/source.zip?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D",
  "arguments": [
    {
      "name": "mytestargument",
      "value": "mytestvalue",
      "isSecret": false
    },
    {
      "name": "mysecrettestargument",
      "value": "mysecrettestvalue",
      "isSecret": true
    }
  ],
  "isPushEnabled": true,
  "platform": {
    "os": "Linux",
    "architecture": "amd64"
  },
  "agentConfiguration": {
    "cpu": 2
  },
  "dockerFilePath": "DockerFile"
}

示例响应

{
  "properties": {
    "provisioningState": "Succeeded",
    "runId": "0accec26-d6de-4757-8e74-d080f38eaaab",
    "status": "Succeeded",
    "lastUpdatedTime": "2018-01-25T05:13:51.617Z"
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab",
  "name": "0accec26-d6de-4757-8e74-d080f38eaaab",
  "type": "Microsoft.ContainerRegistry/registries/run"
}

Registries_ScheduleRun_EncodedTaskRun

示例请求

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scheduleRun?api-version=2019-04-01

{
  "type": "EncodedTaskRunRequest",
  "values": [
    {
      "name": "mytestargument",
      "value": "mytestvalue",
      "isSecret": false
    },
    {
      "name": "mysecrettestargument",
      "value": "mysecrettestvalue",
      "isSecret": true
    }
  ],
  "platform": {
    "os": "Linux"
  },
  "agentConfiguration": {
    "cpu": 2
  },
  "encodedTaskContent": "c3RlcHM6Cnt7IGlmIFZhbHVlcy5lbnZpcm9ubWVudCA9PSAncHJvZCcgfX0KICAtIHJ1bjogcHJvZCBzZXR1cAp7eyBlbHNlIGlmIFZhbHVlcy5lbnZpcm9ubWVudCA9PSAnc3RhZ2luZycgfX0KICAtIHJ1bjogc3RhZ2luZyBzZXR1cAp7eyBlbHNlIH19CiAgLSBydW46IGRlZmF1bHQgc2V0dXAKe3sgZW5kIH19CgogIC0gcnVuOiBidWlsZCAtdCBGYW5jeVRoaW5nOnt7LlZhbHVlcy5lbnZpcm9ubWVudH19LXt7LlZhbHVlcy52ZXJzaW9ufX0gLgoKcHVzaDogWydGYW5jeVRoaW5nOnt7LlZhbHVlcy5lbnZpcm9ubWVudH19LXt7LlZhbHVlcy52ZXJzaW9ufX0nXQ==",
  "encodedValuesContent": "ZW52aXJvbm1lbnQ6IHByb2QKdmVyc2lvbjogMQ=="
}

示例响应

{
  "properties": {
    "provisioningState": "Succeeded",
    "runId": "0accec26-d6de-4757-8e74-d080f38eaaab",
    "status": "Succeeded",
    "lastUpdatedTime": "2018-01-25T05:13:51.617Z"
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab",
  "name": "0accec26-d6de-4757-8e74-d080f38eaaab",
  "type": "Microsoft.ContainerRegistry/registries/run"
}

Registries_ScheduleRun_FileTaskRun

示例请求

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scheduleRun?api-version=2019-04-01

{
  "type": "FileTaskRunRequest",
  "sourceLocation": "https://myaccount.blob.core.windows.net/sascontainer/source.zip?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D",
  "values": [
    {
      "name": "mytestargument",
      "value": "mytestvalue",
      "isSecret": false
    },
    {
      "name": "mysecrettestargument",
      "value": "mysecrettestvalue",
      "isSecret": true
    }
  ],
  "platform": {
    "os": "Linux"
  },
  "agentConfiguration": {
    "cpu": 2
  },
  "taskFilePath": "acb.yaml",
  "valuesFilePath": "prod-values.yaml"
}

示例响应

{
  "properties": {
    "provisioningState": "Succeeded",
    "runId": "0accec26-d6de-4757-8e74-d080f38eaaab",
    "status": "Succeeded",
    "lastUpdatedTime": "2018-01-25T05:13:51.617Z"
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab",
  "name": "0accec26-d6de-4757-8e74-d080f38eaaab",
  "type": "Microsoft.ContainerRegistry/registries/run"
}

Registries_ScheduleRun_Task

示例请求

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scheduleRun?api-version=2019-04-01

{
  "type": "TaskRunRequest",
  "values": [
    {
      "name": "mytestargument",
      "value": "mytestvalue",
      "isSecret": false
    },
    {
      "name": "mysecrettestargument",
      "value": "mysecrettestvalue",
      "isSecret": true
    }
  ],
  "taskName": "myTask"
}

示例响应

{
  "properties": {
    "provisioningState": "Succeeded",
    "runId": "0accec26-d6de-4757-8e74-d080f38eaaab",
    "status": "Succeeded",
    "lastUpdatedTime": "2018-01-25T05:13:51.617Z"
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab",
  "name": "0accec26-d6de-4757-8e74-d080f38eaaab",
  "type": "Microsoft.ContainerRegistry/registries/run"
}

Registries_ScheduleRun_Task_WithCustomCredentials

示例请求

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scheduleRun?api-version=2019-04-01

{
  "type": "FileTaskRunRequest",
  "values": [
    {
      "name": "mytestargument",
      "value": "mytestvalue",
      "isSecret": false
    },
    {
      "name": "mysecrettestargument",
      "value": "mysecrettestvalue",
      "isSecret": true
    }
  ],
  "platform": {
    "os": "Linux"
  },
  "taskFilePath": "acb.yaml",
  "credentials": {
    "sourceRegistry": {
      "loginMode": "Default"
    },
    "customRegistries": {
      "myregistry.azurecr.io": {
        "userName": {
          "type": "Opaque",
          "value": "reg1"
        },
        "password": {
          "type": "Opaque",
          "value": "***"
        }
      }
    }
  }
}

示例响应

{
  "properties": {
    "provisioningState": "Succeeded",
    "runId": "0accec26-d6de-4757-8e74-d080f38eaaab",
    "status": "Succeeded",
    "lastUpdatedTime": "2018-01-25T05:13:51.617Z"
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab",
  "name": "0accec26-d6de-4757-8e74-d080f38eaaab",
  "type": "Microsoft.ContainerRegistry/registries/run"
}

Registries_ScheduleRun_WithCustomCredentials

示例请求

POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/scheduleRun?api-version=2019-04-01

{
  "type": "DockerBuildRequest",
  "isArchiveEnabled": true,
  "imageNames": [
    "azurerest:testtag"
  ],
  "noCache": true,
  "sourceLocation": "https://myaccount.blob.core.windows.net/sascontainer/source.zip?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D",
  "arguments": [
    {
      "name": "mytestargument",
      "value": "mytestvalue",
      "isSecret": false
    },
    {
      "name": "mysecrettestargument",
      "value": "mysecrettestvalue",
      "isSecret": true
    }
  ],
  "isPushEnabled": true,
  "platform": {
    "os": "Linux",
    "architecture": "amd64"
  },
  "agentConfiguration": {
    "cpu": 2
  },
  "dockerFilePath": "DockerFile",
  "target": "stage1",
  "credentials": {
    "sourceRegistry": {
      "loginMode": "Default"
    },
    "customRegistries": {
      "myregistry.azurecr.io": {
        "userName": {
          "type": "Opaque",
          "value": "reg1"
        },
        "password": {
          "type": "Opaque",
          "value": "***"
        }
      },
      "myregistry2.azurecr.io": {
        "userName": {
          "type": "Opaque",
          "value": "reg2"
        },
        "password": {
          "type": "Opaque",
          "value": "***"
        }
      }
    }
  }
}

示例响应

{
  "properties": {
    "provisioningState": "Succeeded",
    "runId": "0accec26-d6de-4757-8e74-d080f38eaaab",
    "status": "Succeeded",
    "lastUpdatedTime": "2018-01-25T05:13:51.617Z"
  },
  "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/runs/0accec26-d6de-4757-8e74-d080f38eaaab",
  "name": "0accec26-d6de-4757-8e74-d080f38eaaab",
  "type": "Microsoft.ContainerRegistry/registries/run"
}

定义

名称 说明
AgentProperties

确定运行代理配置的属性。

Architecture

OS 体系结构。

Argument

运行参数的属性。

Credentials

描述调用运行时将使用的一组凭据的参数。

CustomRegistryCredentials

描述在运行期间将用于访问自定义注册表的凭据。

DockerBuildRequest

docker 快速生成的参数。

EncodedTaskRunRequest

快速任务运行请求的参数。

FileTaskRunRequest

针对任务文件进行计划运行的请求参数。

ImageDescriptor

注册表映像的属性。

ImageUpdateTrigger

导致生成的映像更新触发器。

OS

运行所需的操作系统类型。

PlatformProperties

必须对其执行运行的平台属性。

ProvisioningState

运行的预配状态。

Run

运行资源属性

RunStatus

运行的当前状态。

RunType

运行的类型。

SecretObject

描述机密对象值的属性。

SecretObjectType

确定如何解释机密对象的值的机密对象的类型。

SetValue

可传递给任务模板的可重写值的属性。

SourceRegistryCredentials

描述用于访问源注册表的凭据参数。

SourceRegistryLoginMode

确定源注册表登录范围的身份验证模式。 将使用给定的范围生成源注册表的凭据。 这些凭据将用于在运行期间登录到源注册表。

SourceTriggerDescriptor

导致运行的源触发器。

TaskRunRequest

任务运行请求的参数。

TimerTriggerDescriptor
Variant

CPU 的变体。

AgentProperties

确定运行代理配置的属性。

名称 类型 说明
cpu

integer

运行所需的核心数的 CPU 配置。

Architecture

OS 体系结构。

名称 类型 说明
amd64

string

arm

string

x86

string

Argument

运行参数的属性。

名称 类型 默认值 说明
isSecret

boolean

False

指示参数是否表示机密并想要从生成日志中删除的标志。

name

string

参数的名称。

value

string

参数的值。

Credentials

描述调用运行时将使用的一组凭据的参数。

名称 类型 说明
customRegistries

<string,  CustomRegistryCredentials>

介绍用于访问其他自定义注册表的凭据参数。 字典项的键将是注册表登录服务器 (myregistry.azurecr.io) 项的值将是用于访问注册表的注册表凭据。

sourceRegistry

SourceRegistryCredentials

描述用于访问源注册表的凭据参数。

CustomRegistryCredentials

描述在运行期间将用于访问自定义注册表的凭据。

名称 类型 说明
identity

string

指示分配给自定义凭据的托管标识。 如果用户分配的标识,则此值为客户端 ID。 如果系统分配的标识,则值为 system。 对于系统分配的标识,客户端 ID 将由运行器确定。 此标识可用于向密钥保管库进行身份验证以检索凭据,也可以是用于访问注册表的唯一身份验证源。

password

SecretObject

用于登录到自定义注册表的密码。 密码是一个机密对象,允许通过多种方式为其提供值。

userName

SecretObject

用于登录到自定义注册表的用户名。

DockerBuildRequest

docker 快速生成的参数。

名称 类型 默认值 说明
agentConfiguration

AgentProperties

运行代理的计算机配置。

arguments

Argument[]

执行运行时要使用的重写参数的集合。

credentials

Credentials

描述调用此运行时将使用的一组凭据的属性。

dockerFilePath

string

相对于源位置的 Docker 文件路径。

imageNames

string[]

完全限定的映像名称,包括存储库和标记。

isArchiveEnabled

boolean

False

该值指示是否为运行启用存档。

isPushEnabled

boolean

True

此属性的值指示是否应将生成的映像推送到注册表。

noCache

boolean

False

此属性的值指示是否启用图像缓存。

platform

PlatformProperties

必须对其执行运行的平台属性。

sourceLocation

string

URL (源上下文的绝对或相对) 。 它可以是 tar 或 git 存储库的 URL。 如果它是相对 URL,则应从调用 listBuildSourceUploadUrl API 获取相对路径。

target

string

docker 生成的目标生成阶段的名称。

timeout

integer

3600

运行超时(以秒为单位)。

type string:

DockerBuildRequest

运行请求的类型。

EncodedTaskRunRequest

快速任务运行请求的参数。

名称 类型 默认值 说明
agentConfiguration

AgentProperties

运行代理的计算机配置。

credentials

Credentials

描述调用此运行时将使用的一组凭据的属性。

encodedTaskContent

string

模板/定义文件内容的 Base64 编码值。

encodedValuesContent

string

参数/值文件内容的 Base64 编码值。

isArchiveEnabled

boolean

False

该值指示是否为运行启用存档。

platform

PlatformProperties

必须对其执行运行的平台属性。

sourceLocation

string

URL (源上下文的绝对或相对) 。 它可以是 tar 或 git 存储库的 URL。 如果它是相对 URL,则应从调用 listBuildSourceUploadUrl API 获取相对路径。

timeout

integer

3600

运行超时(以秒为单位)。

type string:

EncodedTaskRunRequest

运行请求的类型。

values

SetValue[]

运行任务时可传递的可重写值的集合。

FileTaskRunRequest

针对任务文件进行计划运行的请求参数。

名称 类型 默认值 说明
agentConfiguration

AgentProperties

运行代理的计算机配置。

credentials

Credentials

描述调用此运行时将使用的一组凭据的属性。

isArchiveEnabled

boolean

False

该值指示是否为运行启用存档。

platform

PlatformProperties

必须对其执行运行的平台属性。

sourceLocation

string

URL (源上下文的绝对或相对) 。 它可以是 tar 或 git 存储库的 URL。 如果它是相对 URL,则应从调用 listBuildSourceUploadUrl API 获取相对路径。

taskFilePath

string

相对于源的模板/定义文件路径。

timeout

integer

3600

运行超时(以秒为单位)。

type string:

FileTaskRunRequest

运行请求的类型。

values

SetValue[]

运行任务时可传递的可重写值的集合。

valuesFilePath

string

相对于源的值/参数文件路径。

ImageDescriptor

注册表映像的属性。

名称 类型 说明
digest

string

映像清单的基于 sha256 的摘要。

registry

string

注册表登录服务器。

repository

string

存储库名称。

tag

string

标记名称。

ImageUpdateTrigger

导致生成的映像更新触发器。

名称 类型 说明
id

string

触发器的唯一 ID。

images

ImageDescriptor[]

导致生成的映像更新的列表。

timestamp

string

发生映像更新时的时间戳。

OS

运行所需的操作系统类型。

名称 类型 说明
Linux

string

Windows

string

PlatformProperties

必须对其执行运行的平台属性。

名称 类型 说明
architecture

Architecture

OS 体系结构。

os

OS

运行所需的操作系统类型。

variant

Variant

CPU 的变体。

ProvisioningState

运行的预配状态。

名称 类型 说明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

Run

运行资源属性

名称 类型 默认值 说明
id

string

资源 ID。

name

string

资源的名称。

properties.agentConfiguration

AgentProperties

运行代理的计算机配置。

properties.createTime

string

计划运行的时间。

properties.customRegistries

string[]

在此运行期间登录的自定义注册表的列表。

properties.finishTime

string

运行完成的时间。

properties.imageUpdateTrigger

ImageUpdateTrigger

导致运行的映像更新触发器。 如果任务配置了基础映像触发器,则这一点适用。

properties.isArchiveEnabled

boolean

False

指示是否启用存档的值。

properties.lastUpdatedTime

string

上次运行更新时间。

properties.outputImages

ImageDescriptor[]

从运行生成的所有映像的列表。 如果运行生成基础映像依赖项,则这适用。

properties.platform

PlatformProperties

将对其执行运行的平台属性。

properties.provisioningState

ProvisioningState

运行的预配状态。

properties.runErrorMessage

string

计划运行后从后端系统收到的错误消息。

properties.runId

string

运行的唯一标识符。

properties.runType

RunType

运行的类型。

properties.sourceRegistryAuth

string

在此运行期间用于登录到源注册表的凭据的范围。

properties.sourceTrigger

SourceTriggerDescriptor

导致运行的源触发器。

properties.startTime

string

运行开始的时间。

properties.status

RunStatus

运行的当前状态。

properties.task

string

计划运行所针对的任务。

properties.timerTrigger

TimerTriggerDescriptor

导致运行的计时器触发器。

type

string

资源类型。

RunStatus

运行的当前状态。

名称 类型 说明
Canceled

string

Error

string

Failed

string

Queued

string

Running

string

Started

string

Succeeded

string

Timeout

string

RunType

运行的类型。

名称 类型 说明
AutoBuild

string

AutoRun

string

QuickBuild

string

QuickRun

string

SecretObject

描述机密对象值的属性。

名称 类型 说明
type

SecretObjectType

确定如何解释机密对象的值的机密对象的类型。

value

string

机密的值。 此值的格式将根据机密对象的类型确定。 如果类型不透明,则该值将按原样使用,而无需进行任何修改。

SecretObjectType

确定如何解释机密对象的值的机密对象的类型。

名称 类型 说明
Opaque

string

Vaultsecret

string

SetValue

可传递给任务模板的可重写值的属性。

名称 类型 默认值 说明
isSecret

boolean

False

指示值是否表示机密的标志。

name

string

可重写值的名称。

value

string

可重写的值。

SourceRegistryCredentials

描述用于访问源注册表的凭据参数。

名称 类型 说明
loginMode

SourceRegistryLoginMode

确定源注册表登录范围的身份验证模式。 将使用给定的范围生成源注册表的凭据。 这些凭据将用于在运行期间登录到源注册表。

SourceRegistryLoginMode

确定源注册表登录范围的身份验证模式。 将使用给定的范围生成源注册表的凭据。 这些凭据将用于在运行期间登录到源注册表。

名称 类型 说明
Default

string

None

string

SourceTriggerDescriptor

导致运行的源触发器。

名称 类型 说明
branchName

string

存储库中的分支名称。

commitId

string

标识提交的唯一 ID。

eventType

string

触发器的事件类型。

id

string

触发器的唯一 ID。

providerType

string

源代码管理提供程序类型。

pullRequestId

string

标识拉取请求的唯一 ID。

repositoryUrl

string

存储库 URL。

TaskRunRequest

任务运行请求的参数。

名称 类型 默认值 说明
isArchiveEnabled

boolean

False

该值指示是否为运行启用存档。

taskName

string

运行必须对其排队的任务的名称。

type string:

TaskRunRequest

运行请求的类型。

values

SetValue[]

运行任务时可传递的可重写值的集合。

TimerTriggerDescriptor

名称 类型 说明
scheduleOccurrence

string

触发运行的匹配项。

timerTriggerName

string

导致运行的计时器触发器名称。

Variant

CPU 的变体。

名称 类型 说明
v6

string

v7

string

v8

string