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 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 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	実行引数のプロパティ。
AuthInfo	ソースコードリポジトリにアクセスするための承認プロパティ。
BaseImageDependency	基本イメージの依存関係を記述するプロパティ。
BaseImageDependencyType	基本イメージの依存関係の型。
BaseImageTrigger	基本イメージの依存関係に基づくトリガー。
BaseImageTriggerType	基本イメージの依存関係更新の自動トリガーの種類。
Credentials	実行の呼び出し時に使用される資格情報のセットを記述するパラメーター。
CustomRegistryCredentials	実行時にカスタムレジストリにアクセスするために使用される資格情報について説明します。
DockerBuildStep	Docker ビルドステップ。
EncodedTaskStep	エンコードされたタスクステップのプロパティ。
FileTaskStep	タスクステップのプロパティ。
IdentityProperties	リソースのマネージド ID。
OS	実行に必要なオペレーティングシステムの種類。
PlatformProperties	実行を実行する必要があるプラットフォームプロパティ。
ProvisioningState	実行のプロビジョニング状態。
ResourceIdentityType	ID の種類。
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

実行引数のプロパティ。

名前	型	規定値	説明
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 を示します。ユーザー割り当て ID の場合、この値はクライアント ID です。システム割り当て ID の場合、値は `system`。システム割り当て ID の場合、クライアント ID はランナーによって決定されます。この ID は、資格情報を取得するためにキーコンテナーに対する認証に使用されるか、レジストリへのアクセスに使用される認証の唯一のソースである可能性があります。
password	SecretObject	カスタムレジストリにログインするためのパスワード。パスワードは、複数の方法で値を指定できるシークレットオブジェクトです。
userName	SecretObject	カスタムレジストリにログインするためのユーザー名。

DockerBuildStep

Object

Docker ビルドステップ。

名前	型	規定値	説明
arguments	Argument[]		このビルドステップの実行時に使用するオーバーライド引数のコレクション。
baseImageDependencies	BaseImageDependency[]		ステップの基本イメージの依存関係の一覧。
contextAccessToken	string		ステップのコンテキストに関連付けられているトークン (ストレージアカウント BLOB の git PAT または 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	ステップのコンテキストに関連付けられているトークン (ストレージアカウント BLOB の git PAT または SAS トークン)。
contextPath	string	タスクステップのソースコンテキストの URL (絶対または相対)。
encodedTaskContent	string	テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。
encodedValuesContent	string	パラメーター/値ファイルの内容の Base64 でエンコードされた値。
type	string: EncodedTask	ステップの種類。
values	SetValue[]	タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。

FileTaskStep

Object

タスクステップのプロパティ。

名前	型	説明
baseImageDependencies	BaseImageDependency[]	ステップの基本イメージの依存関係の一覧。
contextAccessToken	string	ステップのコンテキストに関連付けられているトークン (ストレージアカウント BLOB の git PAT または SAS トークン)。
contextPath	string	タスクステップのソースコンテキストの URL (絶対または相対)。
taskFilePath	string	ソースコンテキストを基準としたタスクテンプレート/定義ファイルのパス。
type	string: FileTask	ステップの種類。
values	SetValue[]	タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。
valuesFilePath	string	ソースコンテキストを基準としたタスク値/パラメーターファイルパス。

IdentityProperties

Object

リソースのマネージド ID。

名前	型	説明
principalId	string	リソース ID のプリンシパル ID。
tenantId	string	リソースのテナント ID。
type	ResourceIdentityType	ID の種類。
userAssignedIdentities	<string, UserIdentityProperties>	リソースに関連付けられているユーザー ID の一覧。ユーザー ID ディクショナリのキー参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

OS

列挙

実行に必要なオペレーティングシステムの種類。

値	説明
Linux
Windows

PlatformProperties

Object

実行を実行する必要があるプラットフォームプロパティ。

名前	型	説明
architecture	Architecture	OS アーキテクチャ。
os	OS	実行に必要なオペレーティングシステムの種類。
variant	Variant	CPU のバリアント。

ProvisioningState

列挙

実行のプロビジョニング状態。

値	説明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

列挙

ID の種類。

値	説明
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		リソースの ID。
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 のクライアント ID。
principalId	string	ユーザー割り当て ID のプリンシパル 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

その他のリソース