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

Tasks - Get Details

参考

服务:: Container Registry

API 版本:: 2019-04-01

返回包含所有机密的扩展信息的任务。

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

URI 参数

名称	在	必需	类型	说明
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	容器注册表的名称。
resourceGroupName	path	True	string minLength: 1	容器注册表所属的资源组的名称。
subscriptionId	path	True	string	Microsoft Azure 订阅 ID。
taskName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9-_]*$	容器注册表任务的名称。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	Task	请求成功;请求格式正确，已正确接收。
Other Status Codes		描述作失败的原因的错误响应。如果注册表不存在，则返回 404（找不到）。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Tasks_GetDetails

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "properties": {
    "status": "Enabled",
    "platform": {
      "os": "Linux",
      "architecture": "amd64"
    },
    "agentConfiguration": {
      "cpu": 2
    },
    "step": {
      "type": "Docker",
      "imageNames": [
        "azurerest:testtag"
      ],
      "dockerFilePath": "src/DockerFile",
      "contextPath": "src",
      "isPushEnabled": true,
      "noCache": false,
      "arguments": [
        {
          "name": "mytestargument",
          "value": "mytestvalue",
          "isSecret": false
        },
        {
          "name": "mysecrettestargument",
          "value": "mysecrettestvalue",
          "isSecret": true
        }
      ]
    },
    "trigger": {
      "timerTriggers": [
        {
          "name": "myTimerTrigger",
          "status": "Enabled",
          "schedule": "30 9 * * 1-5"
        }
      ],
      "sourceTriggers": [
        {
          "name": "mySourceTrigger",
          "status": "Enabled",
          "sourceRepository": {
            "sourceControlType": "Github",
            "repositoryUrl": "https://github.com/Azure/azure-rest-api-specs",
            "branch": "master",
            "sourceControlAuthProperties": {
              "tokenType": "PAT",
              "token": "xxxxx"
            }
          },
          "sourceTriggerEvents": [
            "commit"
          ]
        }
      ],
      "baseImageTrigger": {
        "name": "myBaseImageTrigger",
        "status": "Enabled",
        "baseImageTriggerType": "Runtime"
      }
    },
    "credentials": {
      "customRegistries": {
        "myregistry.azure-test.io": {
          "userName": {
            "type": "Opaque",
            "value": "username"
          },
          "password": {
            "type": "Vaultsecret",
            "value": "https://myacbvault.vault.azure.net/secrets/username"
          },
          "identity": "[system]"
        }
      },
      "sourceRegistry": null
    }
  },
  "location": "eastus",
  "identity": {
    "principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v",
    "tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd",
    "type": "SystemAssigned"
  },
  "tags": {
    "testkey": "value"
  }
}

定义

名称	说明
AgentProperties	确定运行代理配置的属性。
Architecture	OS 体系结构。
Argument	run 参数的属性。
AuthInfo	用于访问源代码存储库的授权属性。
BaseImageDependency	描述基本映像依赖项的属性。
BaseImageDependencyType	基本映像依赖项的类型。
BaseImageTrigger	基于基础映像依赖项的触发器。
BaseImageTriggerType	基础映像依赖项更新的自动触发器的类型。
Credentials	描述调用运行时将使用的一组凭据的参数。
CustomRegistryCredentials	描述在运行期间用于访问自定义注册表的凭据。
DockerBuildStep	Docker 生成步骤。
EncodedTaskStep	编码任务步骤的属性。
FileTaskStep	任务步骤的属性。
IdentityProperties	资源的托管标识。
OS	运行所需的作系统类型。
PlatformProperties	运行必须针对的平台属性。
ProvisioningState	运行的预配状态。
ResourceIdentityType	标识类型。
SecretObject	描述机密对象值的属性。
SecretObjectType	机密对象的类型，用于确定如何解释机密对象的值。
SetValue	可传递至任务模板的可重写值的属性。
SourceControlType	源代码管理服务的类型。
SourceProperties	源代码存储库的属性。
SourceRegistryCredentials	描述用于访问源注册表的凭据参数。
SourceRegistryLoginMode	确定源注册表登录范围的身份验证模式。将使用给定的范围生成源注册表的凭据。这些凭据将用于在运行期间登录到源注册表。
SourceTrigger	基于源的触发器的属性。
SourceTriggerEvent	与触发器对应的源事件。
Task	具有 ARM 资源和任务属性的任务。该任务将包含所有信息来计划针对它运行的运行。
TaskStatus	任务的当前状态。
TimerTrigger	计时器触发器的属性。
TokenType	身份验证令牌的类型。
TriggerProperties	触发器的属性。
TriggerStatus	触发器的当前状态。
UserIdentityProperties
Variant	CPU 的变体。

AgentProperties

Object

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

名称	类型	说明
cpu	integer (int32)	在运行所需的内核数方面，CPU 配置。

Architecture

枚举

OS 体系结构。

值	说明
amd64
arm
x86

Argument

Object

run 参数的属性。

名称	类型	默认值	说明
isSecret	boolean	False	用于指示参数是否表示机密并想要从生成日志中删除的标志。
name	string		参数的名称。
value	string		参数的值。

AuthInfo

Object

用于访问源代码存储库的授权属性。

名称	类型	说明
expiresIn	integer (int32)	令牌保持有效时间（以秒为单位）
refreshToken	string	用于刷新访问令牌的刷新令牌。
scope	string	访问令牌的范围。
token	string	用于访问源代码管理提供程序的访问令牌。
tokenType	TokenType	身份验证令牌的类型。

BaseImageDependency

Object

描述基本映像依赖项的属性。

名称	类型	说明
digest	string	基于 sha256 的映像清单摘要。
registry	string	注册表登录服务器。
repository	string	存储库名称。
tag	string	标记名称。
type	BaseImageDependencyType	基本映像依赖项的类型。

BaseImageDependencyType

枚举

基本映像依赖项的类型。

值	说明
BuildTime
RunTime

BaseImageTrigger

Object

基于基础映像依赖项的触发器。

名称	类型	默认值	说明
baseImageTriggerType	BaseImageTriggerType		基础映像依赖项更新的自动触发器的类型。
name	string		触发器的名称。
status	TriggerStatus	Enabled	触发器的当前状态。

BaseImageTriggerType

枚举

基础映像依赖项更新的自动触发器的类型。

值	说明
All
Runtime

Credentials

Object

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

名称	类型	说明
customRegistries	<string, CustomRegistryCredentials>	描述用于访问其他自定义注册表的凭据参数。字典项的键将是注册表登录服务器（myregistry.azurecr.io），项的值将是用于访问注册表的注册表凭据。
sourceRegistry	SourceRegistryCredentials	描述用于访问源注册表的凭据参数。

CustomRegistryCredentials

Object

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

名称	类型	说明
identity	string	指示分配给自定义凭据的托管标识。如果用户分配的标识，则此值为客户端 ID。如果系统分配的标识，该值将 `system`。对于系统分配的标识，客户端 ID 将由运行程序确定。此标识可用于对密钥保管库进行身份验证以检索凭据，也可能是用于访问注册表的唯一身份验证源。
password	SecretObject	用于登录到自定义注册表的密码。密码是一个机密对象，允许通过多种方式为其提供值。
userName	SecretObject	用于登录到自定义注册表的用户名。

DockerBuildStep

Object

Docker 生成步骤。

名称	类型	默认值	说明
arguments	Argument[]		执行此生成步骤时要使用的重写参数的集合。
baseImageDependencies	BaseImageDependency[]		步骤的基本映像依赖项列表。
contextAccessToken	string		与步骤上下文关联的令牌（git PAT 或存储帐户 blob 的 SAS 令牌）。
contextPath	string		任务步骤的源上下文的 URL（绝对或相对）。
dockerFilePath	string		相对于源上下文的 Docker 文件路径。
imageNames	string[]		完全限定的映像名称，包括存储库和标记。
isPushEnabled	boolean	True	此属性的值指示是否应将生成的映像推送到注册表。
noCache	boolean	False	此属性的值指示是否启用映像缓存。
target	string		docker 生成的目标生成阶段的名称。
type	string: Docker		步骤的类型。

EncodedTaskStep

Object

编码任务步骤的属性。

名称	类型	说明
baseImageDependencies	BaseImageDependency[]	步骤的基本映像依赖项列表。
contextAccessToken	string	与步骤上下文关联的令牌（git PAT 或存储帐户 blob 的 SAS 令牌）。
contextPath	string	任务步骤的源上下文的 URL（绝对或相对）。
encodedTaskContent	string	模板/定义文件内容的 Base64 编码值。
encodedValuesContent	string	参数/值文件内容的 Base64 编码值。
type	string: EncodedTask	步骤的类型。
values	SetValue[]	运行任务时可以传递的可重写值的集合。

FileTaskStep

Object

任务步骤的属性。

名称	类型	说明
baseImageDependencies	BaseImageDependency[]	步骤的基本映像依赖项列表。
contextAccessToken	string	与步骤上下文关联的令牌（git PAT 或存储帐户 blob 的 SAS 令牌）。
contextPath	string	任务步骤的源上下文的 URL（绝对或相对）。
taskFilePath	string	相对于源上下文的任务模板/定义文件路径。
type	string: FileTask	步骤的类型。
values	SetValue[]	运行任务时可以传递的可重写值的集合。
valuesFilePath	string	相对于源上下文的任务值/参数文件路径。

IdentityProperties

Object

资源的托管标识。

名称	类型	说明
principalId	string	资源标识的主体 ID。
tenantId	string	资源的租户 ID。
type	ResourceIdentityType	标识类型。
userAssignedIdentities	<string, UserIdentityProperties>	与资源关联的用户标识列表。用户标识字典密钥引用的格式为 ARM 资源 ID：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

OS

枚举

运行所需的作系统类型。

值	说明
Linux
Windows

PlatformProperties

Object

运行必须针对的平台属性。

名称	类型	说明
architecture	Architecture	OS 体系结构。
os	OS	运行所需的作系统类型。
variant	Variant	CPU 的变体。

ProvisioningState

枚举

运行的预配状态。

值	说明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

枚举

标识类型。

值	说明
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SecretObject

Object

描述机密对象值的属性。

名称	类型	说明
type	SecretObjectType	机密对象的类型，用于确定如何解释机密对象的值。
value	string	机密的值。此值的格式将根据机密对象的类型确定。如果类型为 Opaque，则该值将按原样使用，无需进行任何修改。

SecretObjectType

枚举

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

值	说明
Opaque
Vaultsecret

SetValue

Object

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

名称	类型	默认值	说明
isSecret	boolean	False	用于指示值是否表示机密的标志。
name	string		可重写值的名称。
value	string		可重写的值。

SourceControlType

枚举

源代码管理服务的类型。

值	说明
Github
VisualStudioTeamService

SourceProperties

Object

源代码存储库的属性。

名称	类型	说明
branch	string	源代码的分支名称。
repositoryUrl	string	源代码存储库的完整 URL
sourceControlAuthProperties	AuthInfo	用于访问源代码存储库和为通知设置 Webhook 的授权属性。
sourceControlType	SourceControlType	源代码管理服务的类型。

SourceRegistryCredentials

Object

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

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

SourceRegistryLoginMode

枚举

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

值	说明
Default
None

SourceTrigger

Object

基于源的触发器的属性。

名称	类型	默认值	说明
name	string		触发器的名称。
sourceRepository	SourceProperties		描述任务的源代码的属性。
sourceTriggerEvents	SourceTriggerEvent[]		与触发器对应的源事件。
status	TriggerStatus	Enabled	触发器的当前状态。

SourceTriggerEvent

枚举

与触发器对应的源事件。

值	说明
commit
pullrequest

Task

Object

具有 ARM 资源和任务属性的任务。该任务将包含所有信息来计划针对它运行的运行。

名称	类型	默认值	说明
id	string		资源 ID。
identity	IdentityProperties		资源的标识。
location	string		资源的位置。创建资源后，无法更改此更改。
name	string		资源的名称。
properties.agentConfiguration	AgentProperties		运行代理的计算机配置。
properties.creationDate	string (date-time)		任务的创建日期。
properties.credentials	Credentials		描述调用此运行时将使用的一组凭据的属性。
properties.platform	PlatformProperties		运行必须针对的平台属性。
properties.provisioningState	ProvisioningState		任务的预配状态。
properties.status	TaskStatus		任务的当前状态。
properties.step	TaskStepProperties: DockerBuildStep EncodedTaskStep FileTaskStep		任务步骤的属性。
properties.timeout	integer (int32) minimum: 300 maximum: 28800	3600	运行超时（以秒为单位）。
properties.trigger	TriggerProperties		描述任务的所有触发器的属性。
tags	object		资源的标记。
type	string		资源的类型。

TaskStatus

枚举

任务的当前状态。

值	说明
Disabled
Enabled

TimerTrigger

Object

计时器触发器的属性。

名称	类型	默认值	说明
name	string		触发器的名称。
schedule	string		任务计划的 CRON 表达式
status	TriggerStatus	Enabled	触发器的当前状态。

TokenType

枚举

身份验证令牌的类型。

值	说明
OAuth
PAT

TriggerProperties

Object

触发器的属性。

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

TriggerStatus

枚举

触发器的当前状态。

值	说明
Disabled
Enabled

UserIdentityProperties

Object

名称	类型	说明
clientId	string	用户分配标识的客户端 ID。
principalId	string	用户分配标识的主体 ID。

Variant

枚举

CPU 的变体。

值	说明
v6
v7
v8

通过

Tasks - Get Details

URI 参数

响应

安全性

azure_auth

作用域

示例

Tasks_GetDetails

示例请求

示例响应

定义

AgentProperties

Architecture

Argument

AuthInfo

BaseImageDependency

BaseImageDependencyType

BaseImageTrigger

BaseImageTriggerType

Credentials

CustomRegistryCredentials

DockerBuildStep

EncodedTaskStep

FileTaskStep

IdentityProperties

OS

PlatformProperties

ProvisioningState

ResourceIdentityType

SecretObject

SecretObjectType

SetValue

SourceControlType

SourceProperties

SourceRegistryCredentials

SourceRegistryLoginMode

SourceTrigger

SourceTriggerEvent

Task

TaskStatus

TimerTrigger

TokenType

TriggerProperties

TriggerStatus

UserIdentityProperties

Variant

其他资源