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.
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

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: 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	Архитектура ОС.
Argument	Свойства аргумента выполнения.
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	Вариант ЦП.

AgentProperties

Object

Свойства, определяющие конфигурацию агента запуска.

Имя	Тип	Описание
cpu	integer (int32)	Конфигурация ЦП с точки зрения количества ядер, необходимых для выполнения.

Architecture

Перечисление

Архитектура ОС.

Значение	Описание
amd64
arm
x86

Argument

Object

Свойства аргумента выполнения.

Имя	Тип	Default value	Описание
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

Триггер на основе зависимости базового образа.

Имя	Тип	Default value	Описание
baseImageTriggerType	BaseImageTriggerType		Тип автоматического триггера для обновлений зависимостей базового образа.
name	string		Имя триггера.
status	TriggerStatus	Enabled	Текущее состояние триггера.

BaseImageTriggerType

Перечисление

Тип автоматического триггера для обновлений зависимостей базового образа.

Значение	Описание
All
Runtime

Credentials

Object

Параметры, описывающие набор учетных данных, которые будут использоваться при вызове запуска.

Имя	Тип	Описание
customRegistries	<string, CustomRegistryCredentials>	Описывает параметры учетных данных для доступа к другим пользовательским реестрам. Ключом для элемента словаря будет сервер входа реестра (myregistry.azurecr.io), а значение элемента будет учетными данными реестра для доступа к реестру.
sourceRegistry	SourceRegistryCredentials	Описывает параметры учетных данных для доступа к исходному реестру.

CustomRegistryCredentials

Object

Описывает учетные данные, которые будут использоваться для доступа к пользовательскому реестру во время выполнения.

Имя	Тип	Описание
identity	string	Указывает управляемое удостоверение, назначенное пользовательским учетным данным. Если удостоверение, назначаемое пользователем, это значение является идентификатором клиента. Если назначаемое системой удостоверение, значение будет `system`. В случае назначаемого системой удостоверения идентификатор клиента будет определен в средстве выполнения. Это удостоверение может использоваться для проверки подлинности в хранилище ключей для получения учетных данных или может быть единственным источником проверки подлинности, используемым для доступа к реестру.
password	SecretObject	Пароль для входа в пользовательский реестр. Пароль — это секретный объект, который позволяет использовать несколько способов предоставления значения.
userName	SecretObject	Имя пользователя для входа в пользовательский реестр.

DockerBuildStep

Object

Шаг сборки Docker.

Имя	Тип	Default value	Описание
arguments	Argument[]		Коллекция переопределяемых аргументов, используемых при выполнении этого шага сборки.
baseImageDependencies	BaseImageDependency[]		Список зависимостей базового образа для шага.
contextAccessToken	string		Маркер (маркер git PAT или SAS для BLOB-объекта учетной записи хранения), связанный с контекстом для шага.
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 или SAS для BLOB-объекта учетной записи хранения), связанный с контекстом для шага.
contextPath	string	URL-адрес (абсолютный или относительный) исходного контекста для шага задачи.
encodedTaskContent	string	Закодированное значение файла шаблона или определения в кодировке Base64.
encodedValuesContent	string	Закодированное значение файла параметров и значений в кодировке Base64.
type	string: EncodedTask	Тип шага.
values	SetValue[]	Коллекция переопределенных значений, которые можно передать при выполнении задачи.

FileTaskStep

Object

Свойства шага задачи.

Имя	Тип	Описание
baseImageDependencies	BaseImageDependency[]	Список зависимостей базового образа для шага.
contextAccessToken	string	Маркер (маркер git PAT или SAS для BLOB-объекта учетной записи хранения), связанный с контекстом для шага.
contextPath	string	URL-адрес (абсолютный или относительный) исходного контекста для шага задачи.
taskFilePath	string	Путь к файлу шаблона или определения задачи относительно исходного контекста.
type	string: FileTask	Тип шага.
values	SetValue[]	Коллекция переопределенных значений, которые можно передать при выполнении задачи.
valuesFilePath	string	Путь к файлу значений и параметров задачи относительно исходного контекста.

IdentityProperties

Object

Управляемое удостоверение для ресурса.

Имя	Тип	Описание
principalId	string	Идентификатор субъекта удостоверения ресурса.
tenantId	string	Идентификатор клиента ресурса.
type	ResourceIdentityType	Тип удостоверения.
userAssignedIdentities	<string, UserIdentityProperties>	Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

OS

Перечисление

Тип операционной системы, необходимый для выполнения.

Значение	Описание
Linux
Windows

PlatformProperties

Object

Свойства платформы, для которых должен произойти запуск.

Имя	Тип	Описание
architecture	Architecture	Архитектура ОС.
os	OS	Тип операционной системы, необходимый для выполнения.
variant	Variant	Вариант ЦП.

ProvisioningState

Перечисление

Состояние подготовки запуска.

Значение	Описание
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

Перечисление

Тип удостоверения.

Значение	Описание
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SecretObject

Object

Описывает свойства значения секретного объекта.

Имя	Тип	Описание
type	SecretObjectType	Тип секретного объекта, который определяет способ интерпретации значения секретного объекта.
value	string	Значение секрета. Формат этого значения определяется на основе типа секретного объекта. Если тип непрозрачн, значение будет использоваться без каких-либо изменений.

SecretObjectType

Перечисление

Тип секретного объекта, который определяет способ интерпретации значения секретного объекта.

Значение	Описание
Opaque
Vaultsecret

SetValue

Object

Свойства переопределения значения, которое можно передать в шаблон задачи.

Имя	Тип	Default value	Описание
isSecret	boolean	False	Флаг, указывающий, представляет ли значение секрет или нет.
name	string		Имя переопределиемого значения.
value	string		Переопределяется значение.

SourceControlType

Перечисление

Тип службы управления версиями.

Значение	Описание
Github
VisualStudioTeamService

SourceProperties

Object

Свойства репозитория исходного кода.

Имя	Тип	Описание
branch	string	Имя ветви исходного кода.
repositoryUrl	string	Полный URL-адрес репозитория исходного кода
sourceControlAuthProperties	AuthInfo	Свойства авторизации для доступа к репозиторию исходного кода и настройке веб-перехватчиков для уведомлений.
sourceControlType	SourceControlType	Тип службы управления версиями.

SourceRegistryCredentials

Object

Описывает параметры учетных данных для доступа к исходному реестру.

Имя	Тип	Описание
loginMode	SourceRegistryLoginMode	Режим проверки подлинности, определяющий область входа в исходный реестр. Учетные данные для исходного реестра будут созданы с помощью заданной области. Эти учетные данные будут использоваться для входа в исходный реестр во время выполнения.

SourceRegistryLoginMode

Перечисление

Режим проверки подлинности, определяющий область входа в исходный реестр. Учетные данные для исходного реестра будут созданы с помощью заданной области. Эти учетные данные будут использоваться для входа в исходный реестр во время выполнения.

Значение	Описание
Default
None

SourceTrigger

Object

Свойства триггера на основе источника.

Имя	Тип	Default value	Описание
name	string		Имя триггера.
sourceRepository	SourceProperties		Свойства, описывающие исходный(код) для задачи.
sourceTriggerEvents	SourceTriggerEvent[]		Исходное событие, соответствующее триггеру.
status	TriggerStatus	Enabled	Текущее состояние триггера.

SourceTriggerEvent

Перечисление

Исходное событие, соответствующее триггеру.

Значение	Описание
commit
pullrequest

Task

Object

Задача, которая имеет свойства ресурса и задачи ARM. Задача будет иметь все сведения для планирования выполнения.

Имя	Тип	Default value	Описание
id	string		Идентификатор ресурса.
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

Свойства триггера таймера.

Имя	Тип	Default value	Описание
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	Идентификатор клиента назначаемого пользователем удостоверения.
principalId	string	Идентификатор субъекта назначаемого пользователем удостоверения.

Variant

Перечисление

Вариант ЦП.

Значение	Описание
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

Дополнительные ресурсы