次の方法で共有


Microsoft.ContainerRegistry レジストリ/タスク実行 2019-06-01-preview

Bicep リソース定義

registries/taskRuns リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ContainerRegistry/registries/taskRuns リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ContainerRegistry/registries/taskRuns@2019-06-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    forceUpdateTag: 'string'
    runRequest: {
      agentPoolName: 'string'
      isArchiveEnabled: bool
      logTemplate: 'string'
      type: 'string'
      // For remaining properties, see RunRequest objects
    }
  }
}

RunRequest オブジェクト

プロパティを設定して、オブジェクトの型を指定します。

DockerBuildRequest の場合は、次を使用します。

{
  agentConfiguration: {
    cpu: int
  }
  arguments: [
    {
      isSecret: bool
      name: 'string'
      value: 'string'
    }
  ]
  credentials: {
    customRegistries: {
      {customized property}: {
        identity: 'string'
        password: {
          type: 'string'
          value: 'string'
        }
        userName: {
          type: 'string'
          value: 'string'
        }
      }
    }
    sourceRegistry: {
      loginMode: 'string'
    }
  }
  dockerFilePath: 'string'
  imageNames: [
    'string'
  ]
  isPushEnabled: bool
  noCache: bool
  platform: {
    architecture: 'string'
    os: 'string'
    variant: 'string'
  }
  sourceLocation: 'string'
  target: 'string'
  timeout: int
  type: 'DockerBuildRequest'
}

EncodedTaskRunRequest の場合は、次を使用します。

{
  agentConfiguration: {
    cpu: int
  }
  credentials: {
    customRegistries: {
      {customized property}: {
        identity: 'string'
        password: {
          type: 'string'
          value: 'string'
        }
        userName: {
          type: 'string'
          value: 'string'
        }
      }
    }
    sourceRegistry: {
      loginMode: 'string'
    }
  }
  encodedTaskContent: 'string'
  encodedValuesContent: 'string'
  platform: {
    architecture: 'string'
    os: 'string'
    variant: 'string'
  }
  sourceLocation: 'string'
  timeout: int
  type: 'EncodedTaskRunRequest'
  values: [
    {
      isSecret: bool
      name: 'string'
      value: 'string'
    }
  ]
}

FileTaskRunRequest の場合は、次のコマンドを使用します。

{
  agentConfiguration: {
    cpu: int
  }
  credentials: {
    customRegistries: {
      {customized property}: {
        identity: 'string'
        password: {
          type: 'string'
          value: 'string'
        }
        userName: {
          type: 'string'
          value: 'string'
        }
      }
    }
    sourceRegistry: {
      loginMode: 'string'
    }
  }
  platform: {
    architecture: 'string'
    os: 'string'
    variant: 'string'
  }
  sourceLocation: 'string'
  taskFilePath: 'string'
  timeout: int
  type: 'FileTaskRunRequest'
  values: [
    {
      isSecret: bool
      name: 'string'
      value: 'string'
    }
  ]
  valuesFilePath: 'string'
}

TaskRunRequest の場合は、次のコマンドを使用します。

{
  overrideTaskStepProperties: {
    arguments: [
      {
        isSecret: bool
        name: 'string'
        value: 'string'
      }
    ]
    contextPath: 'string'
    file: 'string'
    target: 'string'
    updateTriggerToken: 'string'
    values: [
      {
        isSecret: bool
        name: 'string'
        value: 'string'
      }
    ]
  }
  taskId: 'string'
  type: 'TaskRunRequest'
}

プロパティ値

Microsoft.ContainerRegistry/registries/taskRuns

名前 説明 価値
アイデンティティ リソースの ID。 IdentityProperties の
ロケーション リソースの場所 ひも
名前 リソース名

制約:
最小長 = 5
最大長 = 50
パターン = ^[a-zA-Z0-9-]*$ (必須)
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。
種類のリソースのシンボリック名: レジストリ
プロパティ タスクの実行に関連付けられているプロパティ (つまり、実行の要求と結果) タスクランプロパティ

エージェントプロパティ

名前 説明 価値
CPUの 実行に必要なコア数に関する CPU 構成。 整数 (int)

引数

名前 説明 価値
isシークレット 引数がシークレットを表し、ビルド ログから削除するかどうかを示すフラグ。 ブール (bool)
名前 引数の名前。 string (必須)
価値 引数の値。 string (必須)

資格情報

名前 説明 価値
customRegistries (カスタムレジストリ) 他のカスタム レジストリにアクセスするための資格情報パラメーターについて説明します。 そのカギ
ディクショナリ項目の場合は、レジストリ ログイン サーバー (myregistry.azurecr.io) と
項目の値は、レジストリにアクセスするためのレジストリ資格情報になります。
CredentialsCustomRegistries (英語)
ソースレジストリ ソース レジストリにアクセスするための資格情報パラメーターについて説明します。 SourceRegistryCredentials

CredentialsCustomRegistries (英語)

名前 説明 価値

CustomRegistryCredentials

名前 説明 価値
アイデンティティ カスタム資格情報に割り当てられたマネージド ID を示します。 ユーザー割り当て ID
この値はクライアント ID です。 システム割り当て ID の場合、値は systemされます。 で
システム割り当て ID の場合、クライアント ID はランナーによって決定されます。 これ
ID を使用して資格情報を取得するために Key Vault に対する認証を行うか、または唯一の
レジストリへのアクセスに使用される認証のソース。
ひも
パスワード カスタム レジストリにログインするためのパスワード。 パスワードはシークレットです
オブジェクトに値を指定する複数の方法を使用できます。
シークレットオブジェクト
ユーザー名 カスタム レジストリにログインするためのユーザー名。 シークレットオブジェクト

DockerBuildRequest (英語)

名前 説明 価値
エージェント構成 実行エージェントのマシン構成。 エージェントプロパティ
引数 実行の実行時に使用するオーバーライド引数のコレクション。 引数[]
資格情報 この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 資格情報
dockerFileパス ソースの場所を基準とした Docker ファイル パス。 string (必須)
画像名 リポジトリとタグを含む完全修飾イメージ名。 文字列[]
isPushEnabledの このプロパティの値は、ビルドされたイメージをレジストリにプッシュする必要があるかどうかを示します。 ブール (bool)
noCache(ノーキャッシュ) このプロパティの値は、イメージ キャッシュが有効かどうかを示します。 ブール (bool)
プラットフォーム 実行を実行する必要があるプラットフォーム プロパティ。 PlatformProperties (必須)
ソースロケーション ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。
相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。
ひも
目標 Docker ビルドのターゲット ビルド ステージの名前。 ひも
タイムアウト 実行タイムアウト (秒単位)。 int

制約:
最小値 = 300
最大値 = 28800
種類 実行要求の種類。 'DockerBuildRequest' (必須)

エンコードされたタスク実行要求

名前 説明 価値
エージェント構成 実行エージェントのマシン構成。 エージェントプロパティ
資格情報 この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 資格情報
encodedTaskContent テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。 string (必須)
encodedValuesコンテンツ パラメーター/値ファイルの内容の Base64 でエンコードされた値。 ひも
プラットフォーム 実行を実行する必要があるプラットフォーム プロパティ。 PlatformProperties (必須)
ソースロケーション ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。
相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。
ひも
タイムアウト 実行タイムアウト (秒単位)。 int

制約:
最小値 = 300
最大値 = 28800
種類 実行要求の種類。 'EncodedTaskRunRequest' (必須)
価値観 タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 SetValue[]

FileTaskRunRequest (英語)

名前 説明 価値
エージェント構成 実行エージェントのマシン構成。 エージェントプロパティ
資格情報 この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 資格情報
プラットフォーム 実行を実行する必要があるプラットフォーム プロパティ。 PlatformProperties (必須)
ソースロケーション ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。
相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。
ひも
taskFilePath (タスクファイルパス) ソースに対するテンプレート/定義ファイルの相対パス。 string (必須)
タイムアウト 実行タイムアウト (秒単位)。 int

制約:
最小値 = 300
最大値 = 28800
種類 実行要求の種類。 'FileTaskRunRequest' (必須)
価値観 タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 SetValue[]
valuesFilePath (値ファイルパス) ソースに対する相対値/パラメーター ファイル パス。 ひも

Identityプロパティ

名前 説明 価値
プリンシパルID リソース ID のプリンシパル ID。 ひも
テナントID リソースのテナント ID。 ひも
種類 ID の種類。 「なし」
'システム割り当て'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー ID の一覧。 ユーザー ID
ディクショナリ キー参照は、次の形式の ARM リソース ID になります。
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
IdentityPropertiesUserAssignedIdentities の

IdentityPropertiesUserAssignedIdentities

名前 説明 価値

OverrideTaskStepProperties (オーバーライド タスク ステップのプロパティ)

名前 説明 価値
引数 次の場合に使用するオーバーライド引数のコレクションを取得または設定します。
ビルド ステップを実行しています。
引数[]
コンテキストパス 実行をキューに入れる必要があるソース コンテキスト。 ひも
ファイル 実行の対象となるファイルをキューに入れる必要があります。 ひも
目標 Docker ビルドのターゲット ビルド ステージの名前。 ひも
updateTriggerToken (英語) 基本イメージ トリガー Webhook にアタッチされる Base64 でエンコードされた更新トリガー トークン。 ひも
価値観 Task の実行時に渡すことができるオーバーライド可能な値のコレクション。 SetValue[]

プラットフォームプロパティ

名前 説明 価値
建築 OS アーキテクチャ。 '386'
「AMD64」
'アーム'
'arm64'
'x86'
オス 実行に必要なオペレーティング システムの種類。 「リナックス」
'Windows' (必須)
バリアント CPU のバリアント。 「V6」
「V7」
「V8」

実行要求

名前 説明 価値
エージェントプール名 実行用の専用エージェント プール。 ひも
isArchiveEnabled (英語) 実行に対してアーカイブが有効かどうかを示す値。 ブール (bool)
ログテンプレート 実行ログ成果物のリポジトリとタグ情報を記述するテンプレート。 ひも
種類 DockerBuildRequest 型の場合は ' DockerBuildRequest' に設定します。 EncodedTaskRunRequest 型の場合は ' EncodedTaskRunRequest' に設定します。 FileTaskRunRequest 型の場合は ' FileTaskRunRequest' に設定します。 TaskRunRequest 型の場合は ' TaskRunRequest' に設定します。 'DockerBuildRequest'
'EncodedTaskRunRequest'
'FileTaskRunRequest'
'TaskRunRequest' (必須)

シークレットオブジェクト

名前 説明 価値
種類 シークレット オブジェクトの値を指定するシークレット オブジェクトの型。
解釈。
「不透明」
「ヴォールトシークレット」
価値 シークレットの値。 この値の形式が決定されます
シークレット オブジェクトの型に基づいています。 型が Opaque の場合、値は
変更なしでそのまま使用されます。
ひも

値を設定

名前 説明 価値
isシークレット 値がシークレットを表すかどうかを示すフラグ。 ブール (bool)
名前 オーバーライド可能な値の名前。 string (必須)
価値 オーバーライド可能な値。 string (必須)

SourceRegistryCredentials

名前 説明 価値
ログインモード ソース レジストリのログイン スコープを決定する認証モード。 ソース レジストリの資格情報
は、指定されたスコープを使用して生成されます。 これらの資格情報は、〘〗〘
実行中のソース レジストリ。
デフォルト
「なし」

タスクランプロパティ

名前 説明 価値
forceUpdateタグ 実行要求の構成が変更されていない場合でも、実行を強制的に再実行する方法 ひも
ランリクエスト 実行の要求 (パラメーター) 実行要求

タスク実行要求

名前 説明 価値
overrideTaskStepProperties の タスクの実行時に渡すことができるオーバーライド可能なパラメーターのセット。 OverrideTaskStepProperties (オーバーライド タスク ステップのプロパティ)
タスクID 実行対象のタスクのリソース ID をキューに登録する必要があります。 string (必須)
種類 実行要求の種類。 'TaskRunRequest' (必須)

ユーザーアイデンティティプロパティ

名前 説明 価値
クライアントID ユーザー割り当て ID のクライアント ID。 ひも
プリンシパルID ユーザー割り当て ID のプリンシパル ID。 ひも

ARM テンプレート リソース定義

registries/taskRuns リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ContainerRegistry/registries/taskRuns リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.ContainerRegistry/registries/taskRuns",
  "apiVersion": "2019-06-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "forceUpdateTag": "string",
    "runRequest": {
      "agentPoolName": "string",
      "isArchiveEnabled": "bool",
      "logTemplate": "string",
      "type": "string"
      // For remaining properties, see RunRequest objects
    }
  }
}

RunRequest オブジェクト

プロパティを設定して、オブジェクトの型を指定します。

DockerBuildRequest の場合は、次を使用します。

{
  "agentConfiguration": {
    "cpu": "int"
  },
  "arguments": [
    {
      "isSecret": "bool",
      "name": "string",
      "value": "string"
    }
  ],
  "credentials": {
    "customRegistries": {
      "{customized property}": {
        "identity": "string",
        "password": {
          "type": "string",
          "value": "string"
        },
        "userName": {
          "type": "string",
          "value": "string"
        }
      }
    },
    "sourceRegistry": {
      "loginMode": "string"
    }
  },
  "dockerFilePath": "string",
  "imageNames": [ "string" ],
  "isPushEnabled": "bool",
  "noCache": "bool",
  "platform": {
    "architecture": "string",
    "os": "string",
    "variant": "string"
  },
  "sourceLocation": "string",
  "target": "string",
  "timeout": "int",
  "type": "DockerBuildRequest"
}

EncodedTaskRunRequest の場合は、次を使用します。

{
  "agentConfiguration": {
    "cpu": "int"
  },
  "credentials": {
    "customRegistries": {
      "{customized property}": {
        "identity": "string",
        "password": {
          "type": "string",
          "value": "string"
        },
        "userName": {
          "type": "string",
          "value": "string"
        }
      }
    },
    "sourceRegistry": {
      "loginMode": "string"
    }
  },
  "encodedTaskContent": "string",
  "encodedValuesContent": "string",
  "platform": {
    "architecture": "string",
    "os": "string",
    "variant": "string"
  },
  "sourceLocation": "string",
  "timeout": "int",
  "type": "EncodedTaskRunRequest",
  "values": [
    {
      "isSecret": "bool",
      "name": "string",
      "value": "string"
    }
  ]
}

FileTaskRunRequest の場合は、次のコマンドを使用します。

{
  "agentConfiguration": {
    "cpu": "int"
  },
  "credentials": {
    "customRegistries": {
      "{customized property}": {
        "identity": "string",
        "password": {
          "type": "string",
          "value": "string"
        },
        "userName": {
          "type": "string",
          "value": "string"
        }
      }
    },
    "sourceRegistry": {
      "loginMode": "string"
    }
  },
  "platform": {
    "architecture": "string",
    "os": "string",
    "variant": "string"
  },
  "sourceLocation": "string",
  "taskFilePath": "string",
  "timeout": "int",
  "type": "FileTaskRunRequest",
  "values": [
    {
      "isSecret": "bool",
      "name": "string",
      "value": "string"
    }
  ],
  "valuesFilePath": "string"
}

TaskRunRequest の場合は、次のコマンドを使用します。

{
  "overrideTaskStepProperties": {
    "arguments": [
      {
        "isSecret": "bool",
        "name": "string",
        "value": "string"
      }
    ],
    "contextPath": "string",
    "file": "string",
    "target": "string",
    "updateTriggerToken": "string",
    "values": [
      {
        "isSecret": "bool",
        "name": "string",
        "value": "string"
      }
    ]
  },
  "taskId": "string",
  "type": "TaskRunRequest"
}

プロパティ値

Microsoft.ContainerRegistry/registries/taskRuns

名前 説明 価値
apiVersion (英語) API のバージョン '2019-06-01-プレビュー'
アイデンティティ リソースの ID。 IdentityProperties の
ロケーション リソースの場所 ひも
名前 リソース名

制約:
最小長 = 5
最大長 = 50
パターン = ^[a-zA-Z0-9-]*$ (必須)
プロパティ タスクの実行に関連付けられているプロパティ (つまり、実行の要求と結果) タスクランプロパティ
種類 リソースの種類 'Microsoft.ContainerRegistry/registries/taskRuns'

エージェントプロパティ

名前 説明 価値
CPUの 実行に必要なコア数に関する CPU 構成。 整数 (int)

引数

名前 説明 価値
isシークレット 引数がシークレットを表し、ビルド ログから削除するかどうかを示すフラグ。 ブール (bool)
名前 引数の名前。 string (必須)
価値 引数の値。 string (必須)

資格情報

名前 説明 価値
customRegistries (カスタムレジストリ) 他のカスタム レジストリにアクセスするための資格情報パラメーターについて説明します。 そのカギ
ディクショナリ項目の場合は、レジストリ ログイン サーバー (myregistry.azurecr.io) と
項目の値は、レジストリにアクセスするためのレジストリ資格情報になります。
CredentialsCustomRegistries (英語)
ソースレジストリ ソース レジストリにアクセスするための資格情報パラメーターについて説明します。 SourceRegistryCredentials

CredentialsCustomRegistries (英語)

名前 説明 価値

CustomRegistryCredentials

名前 説明 価値
アイデンティティ カスタム資格情報に割り当てられたマネージド ID を示します。 ユーザー割り当て ID
この値はクライアント ID です。 システム割り当て ID の場合、値は systemされます。 で
システム割り当て ID の場合、クライアント ID はランナーによって決定されます。 これ
ID を使用して資格情報を取得するために Key Vault に対する認証を行うか、または唯一の
レジストリへのアクセスに使用される認証のソース。
ひも
パスワード カスタム レジストリにログインするためのパスワード。 パスワードはシークレットです
オブジェクトに値を指定する複数の方法を使用できます。
シークレットオブジェクト
ユーザー名 カスタム レジストリにログインするためのユーザー名。 シークレットオブジェクト

DockerBuildRequest (英語)

名前 説明 価値
エージェント構成 実行エージェントのマシン構成。 エージェントプロパティ
引数 実行の実行時に使用するオーバーライド引数のコレクション。 引数[]
資格情報 この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 資格情報
dockerFileパス ソースの場所を基準とした Docker ファイル パス。 string (必須)
画像名 リポジトリとタグを含む完全修飾イメージ名。 文字列[]
isPushEnabledの このプロパティの値は、ビルドされたイメージをレジストリにプッシュする必要があるかどうかを示します。 ブール (bool)
noCache(ノーキャッシュ) このプロパティの値は、イメージ キャッシュが有効かどうかを示します。 ブール (bool)
プラットフォーム 実行を実行する必要があるプラットフォーム プロパティ。 PlatformProperties (必須)
ソースロケーション ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。
相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。
ひも
目標 Docker ビルドのターゲット ビルド ステージの名前。 ひも
タイムアウト 実行タイムアウト (秒単位)。 int

制約:
最小値 = 300
最大値 = 28800
種類 実行要求の種類。 'DockerBuildRequest' (必須)

エンコードされたタスク実行要求

名前 説明 価値
エージェント構成 実行エージェントのマシン構成。 エージェントプロパティ
資格情報 この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 資格情報
encodedTaskContent テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。 string (必須)
encodedValuesコンテンツ パラメーター/値ファイルの内容の Base64 でエンコードされた値。 ひも
プラットフォーム 実行を実行する必要があるプラットフォーム プロパティ。 PlatformProperties (必須)
ソースロケーション ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。
相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。
ひも
タイムアウト 実行タイムアウト (秒単位)。 int

制約:
最小値 = 300
最大値 = 28800
種類 実行要求の種類。 'EncodedTaskRunRequest' (必須)
価値観 タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 SetValue[]

FileTaskRunRequest (英語)

名前 説明 価値
エージェント構成 実行エージェントのマシン構成。 エージェントプロパティ
資格情報 この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 資格情報
プラットフォーム 実行を実行する必要があるプラットフォーム プロパティ。 PlatformProperties (必須)
ソースロケーション ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。
相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。
ひも
taskFilePath (タスクファイルパス) ソースに対するテンプレート/定義ファイルの相対パス。 string (必須)
タイムアウト 実行タイムアウト (秒単位)。 int

制約:
最小値 = 300
最大値 = 28800
種類 実行要求の種類。 'FileTaskRunRequest' (必須)
価値観 タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 SetValue[]
valuesFilePath (値ファイルパス) ソースに対する相対値/パラメーター ファイル パス。 ひも

Identityプロパティ

名前 説明 価値
プリンシパルID リソース ID のプリンシパル ID。 ひも
テナントID リソースのテナント ID。 ひも
種類 ID の種類。 「なし」
'システム割り当て'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー ID の一覧。 ユーザー ID
ディクショナリ キー参照は、次の形式の ARM リソース ID になります。
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
IdentityPropertiesUserAssignedIdentities の

IdentityPropertiesUserAssignedIdentities

名前 説明 価値

OverrideTaskStepProperties (オーバーライド タスク ステップのプロパティ)

名前 説明 価値
引数 次の場合に使用するオーバーライド引数のコレクションを取得または設定します。
ビルド ステップを実行しています。
引数[]
コンテキストパス 実行をキューに入れる必要があるソース コンテキスト。 ひも
ファイル 実行の対象となるファイルをキューに入れる必要があります。 ひも
目標 Docker ビルドのターゲット ビルド ステージの名前。 ひも
updateTriggerToken (英語) 基本イメージ トリガー Webhook にアタッチされる Base64 でエンコードされた更新トリガー トークン。 ひも
価値観 Task の実行時に渡すことができるオーバーライド可能な値のコレクション。 SetValue[]

プラットフォームプロパティ

名前 説明 価値
建築 OS アーキテクチャ。 '386'
「AMD64」
'アーム'
'arm64'
'x86'
オス 実行に必要なオペレーティング システムの種類。 「リナックス」
'Windows' (必須)
バリアント CPU のバリアント。 「V6」
「V7」
「V8」

実行要求

名前 説明 価値
エージェントプール名 実行用の専用エージェント プール。 ひも
isArchiveEnabled (英語) 実行に対してアーカイブが有効かどうかを示す値。 ブール (bool)
ログテンプレート 実行ログ成果物のリポジトリとタグ情報を記述するテンプレート。 ひも
種類 DockerBuildRequest 型の場合は ' DockerBuildRequest' に設定します。 EncodedTaskRunRequest 型の場合は ' EncodedTaskRunRequest' に設定します。 FileTaskRunRequest 型の場合は ' FileTaskRunRequest' に設定します。 TaskRunRequest 型の場合は ' TaskRunRequest' に設定します。 'DockerBuildRequest'
'EncodedTaskRunRequest'
'FileTaskRunRequest'
'TaskRunRequest' (必須)

シークレットオブジェクト

名前 説明 価値
種類 シークレット オブジェクトの値を指定するシークレット オブジェクトの型。
解釈。
「不透明」
「ヴォールトシークレット」
価値 シークレットの値。 この値の形式が決定されます
シークレット オブジェクトの型に基づいています。 型が Opaque の場合、値は
変更なしでそのまま使用されます。
ひも

値を設定

名前 説明 価値
isシークレット 値がシークレットを表すかどうかを示すフラグ。 ブール (bool)
名前 オーバーライド可能な値の名前。 string (必須)
価値 オーバーライド可能な値。 string (必須)

SourceRegistryCredentials

名前 説明 価値
ログインモード ソース レジストリのログイン スコープを決定する認証モード。 ソース レジストリの資格情報
は、指定されたスコープを使用して生成されます。 これらの資格情報は、〘〗〘
実行中のソース レジストリ。
デフォルト
「なし」

タスクランプロパティ

名前 説明 価値
forceUpdateタグ 実行要求の構成が変更されていない場合でも、実行を強制的に再実行する方法 ひも
ランリクエスト 実行の要求 (パラメーター) 実行要求

タスク実行要求

名前 説明 価値
overrideTaskStepProperties の タスクの実行時に渡すことができるオーバーライド可能なパラメーターのセット。 OverrideTaskStepProperties (オーバーライド タスク ステップのプロパティ)
タスクID 実行対象のタスクのリソース ID をキューに登録する必要があります。 string (必須)
種類 実行要求の種類。 'TaskRunRequest' (必須)

ユーザーアイデンティティプロパティ

名前 説明 価値
クライアントID ユーザー割り当て ID のクライアント ID。 ひも
プリンシパルID ユーザー割り当て ID のプリンシパル ID。 ひも

使用例

Terraform (AzAPI プロバイダー) リソース定義

registries/taskRuns リソースの種類は、次を対象とする操作と共にデプロイできます。

  • リソース グループ

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ContainerRegistry/registries/taskRuns リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerRegistry/registries/taskRuns@2019-06-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  body = {
    properties = {
      forceUpdateTag = "string"
      runRequest = {
        agentPoolName = "string"
        isArchiveEnabled = bool
        logTemplate = "string"
        type = "string"
        // For remaining properties, see RunRequest objects
      }
    }
  }
}

RunRequest オブジェクト

プロパティを設定して、オブジェクトの型を指定します。

DockerBuildRequest の場合は、次を使用します。

{
  agentConfiguration = {
    cpu = int
  }
  arguments = [
    {
      isSecret = bool
      name = "string"
      value = "string"
    }
  ]
  credentials = {
    customRegistries = {
      {customized property} = {
        identity = "string"
        password = {
          type = "string"
          value = "string"
        }
        userName = {
          type = "string"
          value = "string"
        }
      }
    }
    sourceRegistry = {
      loginMode = "string"
    }
  }
  dockerFilePath = "string"
  imageNames = [
    "string"
  ]
  isPushEnabled = bool
  noCache = bool
  platform = {
    architecture = "string"
    os = "string"
    variant = "string"
  }
  sourceLocation = "string"
  target = "string"
  timeout = int
  type = "DockerBuildRequest"
}

EncodedTaskRunRequest の場合は、次を使用します。

{
  agentConfiguration = {
    cpu = int
  }
  credentials = {
    customRegistries = {
      {customized property} = {
        identity = "string"
        password = {
          type = "string"
          value = "string"
        }
        userName = {
          type = "string"
          value = "string"
        }
      }
    }
    sourceRegistry = {
      loginMode = "string"
    }
  }
  encodedTaskContent = "string"
  encodedValuesContent = "string"
  platform = {
    architecture = "string"
    os = "string"
    variant = "string"
  }
  sourceLocation = "string"
  timeout = int
  type = "EncodedTaskRunRequest"
  values = [
    {
      isSecret = bool
      name = "string"
      value = "string"
    }
  ]
}

FileTaskRunRequest の場合は、次のコマンドを使用します。

{
  agentConfiguration = {
    cpu = int
  }
  credentials = {
    customRegistries = {
      {customized property} = {
        identity = "string"
        password = {
          type = "string"
          value = "string"
        }
        userName = {
          type = "string"
          value = "string"
        }
      }
    }
    sourceRegistry = {
      loginMode = "string"
    }
  }
  platform = {
    architecture = "string"
    os = "string"
    variant = "string"
  }
  sourceLocation = "string"
  taskFilePath = "string"
  timeout = int
  type = "FileTaskRunRequest"
  values = [
    {
      isSecret = bool
      name = "string"
      value = "string"
    }
  ]
  valuesFilePath = "string"
}

TaskRunRequest の場合は、次のコマンドを使用します。

{
  overrideTaskStepProperties = {
    arguments = [
      {
        isSecret = bool
        name = "string"
        value = "string"
      }
    ]
    contextPath = "string"
    file = "string"
    target = "string"
    updateTriggerToken = "string"
    values = [
      {
        isSecret = bool
        name = "string"
        value = "string"
      }
    ]
  }
  taskId = "string"
  type = "TaskRunRequest"
}

プロパティ値

Microsoft.ContainerRegistry/registries/taskRuns

名前 説明 価値
アイデンティティ リソースの ID。 IdentityProperties の
ロケーション リソースの場所 ひも
名前 リソース名

制約:
最小長 = 5
最大長 = 50
パターン = ^[a-zA-Z0-9-]*$ (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: レジストリ
プロパティ タスクの実行に関連付けられているプロパティ (つまり、実行の要求と結果) タスクランプロパティ
種類 リソースの種類 "Microsoft.ContainerRegistry/registries/taskRuns@2019-06-01-preview" (英語)

エージェントプロパティ

名前 説明 価値
CPUの 実行に必要なコア数に関する CPU 構成。 整数 (int)

引数

名前 説明 価値
isシークレット 引数がシークレットを表し、ビルド ログから削除するかどうかを示すフラグ。 ブール (bool)
名前 引数の名前。 string (必須)
価値 引数の値。 string (必須)

資格情報

名前 説明 価値
customRegistries (カスタムレジストリ) 他のカスタム レジストリにアクセスするための資格情報パラメーターについて説明します。 そのカギ
ディクショナリ項目の場合は、レジストリ ログイン サーバー (myregistry.azurecr.io) と
項目の値は、レジストリにアクセスするためのレジストリ資格情報になります。
CredentialsCustomRegistries (英語)
ソースレジストリ ソース レジストリにアクセスするための資格情報パラメーターについて説明します。 SourceRegistryCredentials

CredentialsCustomRegistries (英語)

名前 説明 価値

CustomRegistryCredentials

名前 説明 価値
アイデンティティ カスタム資格情報に割り当てられたマネージド ID を示します。 ユーザー割り当て ID
この値はクライアント ID です。 システム割り当て ID の場合、値は systemされます。 で
システム割り当て ID の場合、クライアント ID はランナーによって決定されます。 これ
ID を使用して資格情報を取得するために Key Vault に対する認証を行うか、または唯一の
レジストリへのアクセスに使用される認証のソース。
ひも
パスワード カスタム レジストリにログインするためのパスワード。 パスワードはシークレットです
オブジェクトに値を指定する複数の方法を使用できます。
シークレットオブジェクト
ユーザー名 カスタム レジストリにログインするためのユーザー名。 シークレットオブジェクト

DockerBuildRequest (英語)

名前 説明 価値
エージェント構成 実行エージェントのマシン構成。 エージェントプロパティ
引数 実行の実行時に使用するオーバーライド引数のコレクション。 引数[]
資格情報 この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 資格情報
dockerFileパス ソースの場所を基準とした Docker ファイル パス。 string (必須)
画像名 リポジトリとタグを含む完全修飾イメージ名。 文字列[]
isPushEnabledの このプロパティの値は、ビルドされたイメージをレジストリにプッシュする必要があるかどうかを示します。 ブール (bool)
noCache(ノーキャッシュ) このプロパティの値は、イメージ キャッシュが有効かどうかを示します。 ブール (bool)
プラットフォーム 実行を実行する必要があるプラットフォーム プロパティ。 PlatformProperties (必須)
ソースロケーション ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。
相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。
ひも
目標 Docker ビルドのターゲット ビルド ステージの名前。 ひも
タイムアウト 実行タイムアウト (秒単位)。 int

制約:
最小値 = 300
最大値 = 28800
種類 実行要求の種類。 'DockerBuildRequest' (必須)

エンコードされたタスク実行要求

名前 説明 価値
エージェント構成 実行エージェントのマシン構成。 エージェントプロパティ
資格情報 この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 資格情報
encodedTaskContent テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。 string (必須)
encodedValuesコンテンツ パラメーター/値ファイルの内容の Base64 でエンコードされた値。 ひも
プラットフォーム 実行を実行する必要があるプラットフォーム プロパティ。 PlatformProperties (必須)
ソースロケーション ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。
相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。
ひも
タイムアウト 実行タイムアウト (秒単位)。 int

制約:
最小値 = 300
最大値 = 28800
種類 実行要求の種類。 'EncodedTaskRunRequest' (必須)
価値観 タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 SetValue[]

FileTaskRunRequest (英語)

名前 説明 価値
エージェント構成 実行エージェントのマシン構成。 エージェントプロパティ
資格情報 この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 資格情報
プラットフォーム 実行を実行する必要があるプラットフォーム プロパティ。 PlatformProperties (必須)
ソースロケーション ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。
相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。
ひも
taskFilePath (タスクファイルパス) ソースに対するテンプレート/定義ファイルの相対パス。 string (必須)
タイムアウト 実行タイムアウト (秒単位)。 int

制約:
最小値 = 300
最大値 = 28800
種類 実行要求の種類。 'FileTaskRunRequest' (必須)
価値観 タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 SetValue[]
valuesFilePath (値ファイルパス) ソースに対する相対値/パラメーター ファイル パス。 ひも

Identityプロパティ

名前 説明 価値
プリンシパルID リソース ID のプリンシパル ID。 ひも
テナントID リソースのテナント ID。 ひも
種類 ID の種類。 「なし」
'システム割り当て'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities (ユーザー割り当て済みアイデンティティ) リソースに関連付けられているユーザー ID の一覧。 ユーザー ID
ディクショナリ キー参照は、次の形式の ARM リソース ID になります。
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/
providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
IdentityPropertiesUserAssignedIdentities の

IdentityPropertiesUserAssignedIdentities

名前 説明 価値

OverrideTaskStepProperties (オーバーライド タスク ステップのプロパティ)

名前 説明 価値
引数 次の場合に使用するオーバーライド引数のコレクションを取得または設定します。
ビルド ステップを実行しています。
引数[]
コンテキストパス 実行をキューに入れる必要があるソース コンテキスト。 ひも
ファイル 実行の対象となるファイルをキューに入れる必要があります。 ひも
目標 Docker ビルドのターゲット ビルド ステージの名前。 ひも
updateTriggerToken (英語) 基本イメージ トリガー Webhook にアタッチされる Base64 でエンコードされた更新トリガー トークン。 ひも
価値観 Task の実行時に渡すことができるオーバーライド可能な値のコレクション。 SetValue[]

プラットフォームプロパティ

名前 説明 価値
建築 OS アーキテクチャ。 '386'
「AMD64」
'アーム'
'arm64'
'x86'
オス 実行に必要なオペレーティング システムの種類。 「リナックス」
'Windows' (必須)
バリアント CPU のバリアント。 「V6」
「V7」
「V8」

実行要求

名前 説明 価値
エージェントプール名 実行用の専用エージェント プール。 ひも
isArchiveEnabled (英語) 実行に対してアーカイブが有効かどうかを示す値。 ブール (bool)
ログテンプレート 実行ログ成果物のリポジトリとタグ情報を記述するテンプレート。 ひも
種類 DockerBuildRequest 型の場合は ' DockerBuildRequest' に設定します。 EncodedTaskRunRequest 型の場合は ' EncodedTaskRunRequest' に設定します。 FileTaskRunRequest 型の場合は ' FileTaskRunRequest' に設定します。 TaskRunRequest 型の場合は ' TaskRunRequest' に設定します。 'DockerBuildRequest'
'EncodedTaskRunRequest'
'FileTaskRunRequest'
'TaskRunRequest' (必須)

シークレットオブジェクト

名前 説明 価値
種類 シークレット オブジェクトの値を指定するシークレット オブジェクトの型。
解釈。
「不透明」
「ヴォールトシークレット」
価値 シークレットの値。 この値の形式が決定されます
シークレット オブジェクトの型に基づいています。 型が Opaque の場合、値は
変更なしでそのまま使用されます。
ひも

値を設定

名前 説明 価値
isシークレット 値がシークレットを表すかどうかを示すフラグ。 ブール (bool)
名前 オーバーライド可能な値の名前。 string (必須)
価値 オーバーライド可能な値。 string (必須)

SourceRegistryCredentials

名前 説明 価値
ログインモード ソース レジストリのログイン スコープを決定する認証モード。 ソース レジストリの資格情報
は、指定されたスコープを使用して生成されます。 これらの資格情報は、〘〗〘
実行中のソース レジストリ。
デフォルト
「なし」

タスクランプロパティ

名前 説明 価値
forceUpdateタグ 実行要求の構成が変更されていない場合でも、実行を強制的に再実行する方法 ひも
ランリクエスト 実行の要求 (パラメーター) 実行要求

タスク実行要求

名前 説明 価値
overrideTaskStepProperties の タスクの実行時に渡すことができるオーバーライド可能なパラメーターのセット。 OverrideTaskStepProperties (オーバーライド タスク ステップのプロパティ)
タスクID 実行対象のタスクのリソース ID をキューに登録する必要があります。 string (必須)
種類 実行要求の種類。 'TaskRunRequest' (必須)

ユーザーアイデンティティプロパティ

名前 説明 価値
クライアントID ユーザー割り当て ID のクライアント ID。 ひも
プリンシパルID ユーザー割り当て ID のプリンシパル ID。 ひも