Microsoft.ContainerRegistry registries/taskRuns
- 最新の を
する - 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'
}
プロパティ値
AgentProperties
名前 | 形容 | 価値 |
---|---|---|
cpu | 実行に必要なコア数に関する CPU 構成。 | int |
引数
名前 | 形容 | 価値 |
---|---|---|
isSecret | 引数がシークレットを表し、ビルド ログから削除するかどうかを示すフラグ。 | bool |
名前 | 引数の名前。 | string (必須) |
価値 | 引数の値。 | string (必須) |
資格 情報
名前 | 形容 | 価値 |
---|---|---|
customRegistries | 他のカスタム レジストリにアクセスするための資格情報パラメーターについて説明します。 そのカギ ディクショナリ項目の場合は、レジストリ ログイン サーバー (myregistry.azurecr.io) と 項目の値は、レジストリにアクセスするためのレジストリ資格情報になります。 |
CredentialsCustomRegistries |
sourceRegistry | ソース レジストリにアクセスするための資格情報パラメーターについて説明します。 | SourceRegistryCredentials の |
CredentialsCustomRegistries
名前 | 形容 | 価値 |
---|
CustomRegistryCredentials
名前 | 形容 | 価値 |
---|---|---|
同一性 | カスタム資格情報に割り当てられたマネージド ID を示します。 ユーザー割り当て ID この値はクライアント ID です。 システム割り当て ID の場合、値は system 。 でシステム割り当て ID の場合、クライアント ID はランナーによって決定されます。 これ ID を使用して資格情報を取得するために Key Vault に対する認証を行うか、または唯一の レジストリへのアクセスに使用される認証のソース。 |
糸 |
パスワード | カスタム レジストリにログインするためのパスワード。 パスワードはシークレットです オブジェクトに値を指定する複数の方法を使用できます。 |
SecretObject |
userName | カスタム レジストリにログインするためのユーザー名。 | SecretObject |
DockerBuildRequest
名前 | 形容 | 価値 |
---|---|---|
agentConfiguration | 実行エージェントのマシン構成。 | AgentProperties |
引数 | 実行の実行時に使用するオーバーライド引数のコレクション。 | 引数[] |
資格 情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 の |
dockerFilePath | ソースの場所を基準とした Docker ファイル パス。 | string (必須) |
imageNames | リポジトリとタグを含む完全修飾イメージ名。 | string[] |
isPushEnabled | このプロパティの値は、ビルドされたイメージをレジストリにプッシュする必要があるかどうかを示します。 | bool |
noCache | このプロパティの値は、イメージ キャッシュが有効かどうかを示します。 | bool |
プラットホーム | 実行を実行する必要があるプラットフォーム プロパティ。 | PlatformProperties (必須) |
sourceLocation | ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。 相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。 |
糸 |
ターゲット | Docker ビルドのターゲット ビルド ステージの名前。 | 糸 |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
種類 | 実行要求の種類。 | 'DockerBuildRequest' (必須) |
EncodedTaskRunRequest
名前 | 形容 | 価値 |
---|---|---|
agentConfiguration | 実行エージェントのマシン構成。 | AgentProperties |
資格 情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 の |
encodedTaskContent | テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。 | string (必須) |
encodedValuesContent | パラメーター/値ファイルの内容の Base64 でエンコードされた値。 | 糸 |
プラットホーム | 実行を実行する必要があるプラットフォーム プロパティ。 | PlatformProperties (必須) |
sourceLocation | ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。 相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。 |
糸 |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
種類 | 実行要求の種類。 | 'EncodedTaskRunRequest' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
FileTaskRunRequest
名前 | 形容 | 価値 |
---|---|---|
agentConfiguration | 実行エージェントのマシン構成。 | AgentProperties |
資格 情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 の |
プラットホーム | 実行を実行する必要があるプラットフォーム プロパティ。 | PlatformProperties (必須) |
sourceLocation | ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。 相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。 |
糸 |
taskFilePath | ソースに対するテンプレート/定義ファイルの相対パス。 | string (必須) |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
種類 | 実行要求の種類。 | 'FileTaskRunRequest' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
valuesFilePath | ソースに対する相対値/パラメーター ファイル パス。 | 糸 |
IdentityProperties
名前 | 形容 | 価値 |
---|---|---|
principalId | リソース ID のプリンシパル ID。 | 糸 |
tenantId | リソースのテナント ID。 | 糸 |
種類 | ID の種類。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
IdentityPropertiesUserAssignedIdentities の |
IdentityPropertiesUserAssignedIdentities
名前 | 形容 | 価値 |
---|
Microsoft.ContainerRegistry/registries/taskRuns
名前 | 形容 | 価値 |
---|---|---|
同一性 | リソースの ID。 | IdentityProperties の |
場所 | リソースの場所 | 糸 |
名前 | リソース名 | 糸 制約: 最小長 = 5 最大長 = 50 パターン = ^[a-zA-Z0-9-]*$ (必須) |
親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: レジストリ |
プロパティ | タスクの実行に関連付けられているプロパティ (つまり、実行の要求と結果) | TaskRunProperties |
OverrideTaskStepProperties
名前 | 形容 | 価値 |
---|---|---|
引数 | 次の場合に使用するオーバーライド引数のコレクションを取得または設定します。 ビルド ステップを実行しています。 |
引数[] |
contextPath | 実行をキューに入れる必要があるソース コンテキスト。 | 糸 |
ファイル | 実行の対象となるファイルをキューに入れる必要があります。 | 糸 |
ターゲット | Docker ビルドのターゲット ビルド ステージの名前。 | 糸 |
updateTriggerToken | 基本イメージ トリガー Webhook にアタッチされる Base64 でエンコードされた更新トリガー トークン。 | 糸 |
価値観 | Task の実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
PlatformProperties
名前 | 形容 | 価値 |
---|---|---|
建築 | OS アーキテクチャ。 | '386' 'amd64' 'arm' 'arm64' 'x86' |
os | 実行に必要なオペレーティング システムの種類。 | 'Linux' 'Windows' (必須) |
バリアント | CPU のバリアント。 | 'v6' 'v7' 'v8' |
RunRequest
名前 | 形容 | 価値 |
---|---|---|
agentPoolName | 実行用の専用エージェント プール。 | 糸 |
isArchiveEnabled | 実行に対してアーカイブが有効かどうかを示す値。 | bool |
logTemplate | 実行ログ成果物のリポジトリとタグ情報を記述するテンプレート。 | 糸 |
種類 | DockerBuildRequestの型 |
'DockerBuildRequest' 'EncodedTaskRunRequest' 'FileTaskRunRequest' 'TaskRunRequest' (必須) |
SecretObject
名前 | 形容 | 価値 |
---|---|---|
種類 | シークレット オブジェクトの値を指定するシークレット オブジェクトの型。 解釈。 |
'Opaque' 'Vaultsecret' |
価値 | シークレットの値。 この値の形式が決定されます シークレット オブジェクトの型に基づいています。 型が Opaque の場合、値は 変更なしでそのまま使用されます。 |
糸 |
SetValue
名前 | 形容 | 価値 |
---|---|---|
isSecret | 値がシークレットを表すかどうかを示すフラグ。 | bool |
名前 | オーバーライド可能な値の名前。 | string (必須) |
価値 | オーバーライド可能な値。 | string (必須) |
SourceRegistryCredentials
名前 | 形容 | 価値 |
---|---|---|
loginMode | ソース レジストリのログイン スコープを決定する認証モード。 ソース レジストリの資格情報 は、指定されたスコープを使用して生成されます。 これらの資格情報は、〘〗〘 実行中のソース レジストリ。 |
'Default' 'None' |
TaskRunProperties
名前 | 形容 | 価値 |
---|---|---|
forceUpdateTag | 実行要求の構成が変更されていない場合でも、実行を強制的に再実行する方法 | 糸 |
runRequest | 実行の要求 (パラメーター) | RunRequest の |
TaskRunRequest
名前 | 形容 | 価値 |
---|---|---|
overrideTaskStepProperties | タスクの実行時に渡すことができるオーバーライド可能なパラメーターのセット。 | OverrideTaskStepProperties の |
taskId | 実行対象のタスクのリソース ID をキューに登録する必要があります。 | string (必須) |
種類 | 実行要求の種類。 | 'TaskRunRequest' (必須) |
UserIdentityProperties
名前 | 形容 | 価値 |
---|---|---|
clientId | ユーザー割り当て ID のクライアント ID。 | 糸 |
principalId | ユーザー割り当て 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"
}
プロパティ値
AgentProperties
名前 | 形容 | 価値 |
---|---|---|
cpu | 実行に必要なコア数に関する CPU 構成。 | int |
引数
名前 | 形容 | 価値 |
---|---|---|
isSecret | 引数がシークレットを表し、ビルド ログから削除するかどうかを示すフラグ。 | bool |
名前 | 引数の名前。 | string (必須) |
価値 | 引数の値。 | string (必須) |
資格 情報
名前 | 形容 | 価値 |
---|---|---|
customRegistries | 他のカスタム レジストリにアクセスするための資格情報パラメーターについて説明します。 そのカギ ディクショナリ項目の場合は、レジストリ ログイン サーバー (myregistry.azurecr.io) と 項目の値は、レジストリにアクセスするためのレジストリ資格情報になります。 |
CredentialsCustomRegistries |
sourceRegistry | ソース レジストリにアクセスするための資格情報パラメーターについて説明します。 | SourceRegistryCredentials の |
CredentialsCustomRegistries
名前 | 形容 | 価値 |
---|
CustomRegistryCredentials
名前 | 形容 | 価値 |
---|---|---|
同一性 | カスタム資格情報に割り当てられたマネージド ID を示します。 ユーザー割り当て ID この値はクライアント ID です。 システム割り当て ID の場合、値は system 。 でシステム割り当て ID の場合、クライアント ID はランナーによって決定されます。 これ ID を使用して資格情報を取得するために Key Vault に対する認証を行うか、または唯一の レジストリへのアクセスに使用される認証のソース。 |
糸 |
パスワード | カスタム レジストリにログインするためのパスワード。 パスワードはシークレットです オブジェクトに値を指定する複数の方法を使用できます。 |
SecretObject |
userName | カスタム レジストリにログインするためのユーザー名。 | SecretObject |
DockerBuildRequest
名前 | 形容 | 価値 |
---|---|---|
agentConfiguration | 実行エージェントのマシン構成。 | AgentProperties |
引数 | 実行の実行時に使用するオーバーライド引数のコレクション。 | 引数[] |
資格 情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 の |
dockerFilePath | ソースの場所を基準とした Docker ファイル パス。 | string (必須) |
imageNames | リポジトリとタグを含む完全修飾イメージ名。 | string[] |
isPushEnabled | このプロパティの値は、ビルドされたイメージをレジストリにプッシュする必要があるかどうかを示します。 | bool |
noCache | このプロパティの値は、イメージ キャッシュが有効かどうかを示します。 | bool |
プラットホーム | 実行を実行する必要があるプラットフォーム プロパティ。 | PlatformProperties (必須) |
sourceLocation | ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。 相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。 |
糸 |
ターゲット | Docker ビルドのターゲット ビルド ステージの名前。 | 糸 |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
種類 | 実行要求の種類。 | 'DockerBuildRequest' (必須) |
EncodedTaskRunRequest
名前 | 形容 | 価値 |
---|---|---|
agentConfiguration | 実行エージェントのマシン構成。 | AgentProperties |
資格 情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 の |
encodedTaskContent | テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。 | string (必須) |
encodedValuesContent | パラメーター/値ファイルの内容の Base64 でエンコードされた値。 | 糸 |
プラットホーム | 実行を実行する必要があるプラットフォーム プロパティ。 | PlatformProperties (必須) |
sourceLocation | ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。 相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。 |
糸 |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
種類 | 実行要求の種類。 | 'EncodedTaskRunRequest' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
FileTaskRunRequest
名前 | 形容 | 価値 |
---|---|---|
agentConfiguration | 実行エージェントのマシン構成。 | AgentProperties |
資格 情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 の |
プラットホーム | 実行を実行する必要があるプラットフォーム プロパティ。 | PlatformProperties (必須) |
sourceLocation | ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。 相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。 |
糸 |
taskFilePath | ソースに対するテンプレート/定義ファイルの相対パス。 | string (必須) |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
種類 | 実行要求の種類。 | 'FileTaskRunRequest' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
valuesFilePath | ソースに対する相対値/パラメーター ファイル パス。 | 糸 |
IdentityProperties
名前 | 形容 | 価値 |
---|---|---|
principalId | リソース ID のプリンシパル ID。 | 糸 |
tenantId | リソースのテナント ID。 | 糸 |
種類 | ID の種類。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
IdentityPropertiesUserAssignedIdentities の |
IdentityPropertiesUserAssignedIdentities
名前 | 形容 | 価値 |
---|
Microsoft.ContainerRegistry/registries/taskRuns
名前 | 形容 | 価値 |
---|---|---|
apiVersion | API のバージョン | '2019-06-01-preview' |
同一性 | リソースの ID。 | IdentityProperties の |
場所 | リソースの場所 | 糸 |
名前 | リソース名 | 糸 制約: 最小長 = 5 最大長 = 50 パターン = ^[a-zA-Z0-9-]*$ (必須) |
プロパティ | タスクの実行に関連付けられているプロパティ (つまり、実行の要求と結果) | TaskRunProperties |
種類 | リソースの種類 | 'Microsoft.ContainerRegistry/registries/taskRuns' |
OverrideTaskStepProperties
名前 | 形容 | 価値 |
---|---|---|
引数 | 次の場合に使用するオーバーライド引数のコレクションを取得または設定します。 ビルド ステップを実行しています。 |
引数[] |
contextPath | 実行をキューに入れる必要があるソース コンテキスト。 | 糸 |
ファイル | 実行の対象となるファイルをキューに入れる必要があります。 | 糸 |
ターゲット | Docker ビルドのターゲット ビルド ステージの名前。 | 糸 |
updateTriggerToken | 基本イメージ トリガー Webhook にアタッチされる Base64 でエンコードされた更新トリガー トークン。 | 糸 |
価値観 | Task の実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
PlatformProperties
名前 | 形容 | 価値 |
---|---|---|
建築 | OS アーキテクチャ。 | '386' 'amd64' 'arm' 'arm64' 'x86' |
os | 実行に必要なオペレーティング システムの種類。 | 'Linux' 'Windows' (必須) |
バリアント | CPU のバリアント。 | 'v6' 'v7' 'v8' |
RunRequest
名前 | 形容 | 価値 |
---|---|---|
agentPoolName | 実行用の専用エージェント プール。 | 糸 |
isArchiveEnabled | 実行に対してアーカイブが有効かどうかを示す値。 | bool |
logTemplate | 実行ログ成果物のリポジトリとタグ情報を記述するテンプレート。 | 糸 |
種類 | DockerBuildRequestの型 |
'DockerBuildRequest' 'EncodedTaskRunRequest' 'FileTaskRunRequest' 'TaskRunRequest' (必須) |
SecretObject
名前 | 形容 | 価値 |
---|---|---|
種類 | シークレット オブジェクトの値を指定するシークレット オブジェクトの型。 解釈。 |
'Opaque' 'Vaultsecret' |
価値 | シークレットの値。 この値の形式が決定されます シークレット オブジェクトの型に基づいています。 型が Opaque の場合、値は 変更なしでそのまま使用されます。 |
糸 |
SetValue
名前 | 形容 | 価値 |
---|---|---|
isSecret | 値がシークレットを表すかどうかを示すフラグ。 | bool |
名前 | オーバーライド可能な値の名前。 | string (必須) |
価値 | オーバーライド可能な値。 | string (必須) |
SourceRegistryCredentials
名前 | 形容 | 価値 |
---|---|---|
loginMode | ソース レジストリのログイン スコープを決定する認証モード。 ソース レジストリの資格情報 は、指定されたスコープを使用して生成されます。 これらの資格情報は、〘〗〘 実行中のソース レジストリ。 |
'Default' 'None' |
TaskRunProperties
名前 | 形容 | 価値 |
---|---|---|
forceUpdateTag | 実行要求の構成が変更されていない場合でも、実行を強制的に再実行する方法 | 糸 |
runRequest | 実行の要求 (パラメーター) | RunRequest の |
TaskRunRequest
名前 | 形容 | 価値 |
---|---|---|
overrideTaskStepProperties | タスクの実行時に渡すことができるオーバーライド可能なパラメーターのセット。 | OverrideTaskStepProperties の |
taskId | 実行対象のタスクのリソース ID をキューに登録する必要があります。 | string (必須) |
種類 | 実行要求の種類。 | 'TaskRunRequest' (必須) |
UserIdentityProperties
名前 | 形容 | 価値 |
---|---|---|
clientId | ユーザー割り当て ID のクライアント ID。 | 糸 |
principalId | ユーザー割り当て 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"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
body = jsonencode({
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"
}
プロパティ値
AgentProperties
名前 | 形容 | 価値 |
---|---|---|
cpu | 実行に必要なコア数に関する CPU 構成。 | int |
引数
名前 | 形容 | 価値 |
---|---|---|
isSecret | 引数がシークレットを表し、ビルド ログから削除するかどうかを示すフラグ。 | bool |
名前 | 引数の名前。 | string (必須) |
価値 | 引数の値。 | string (必須) |
資格 情報
名前 | 形容 | 価値 |
---|---|---|
customRegistries | 他のカスタム レジストリにアクセスするための資格情報パラメーターについて説明します。 そのカギ ディクショナリ項目の場合は、レジストリ ログイン サーバー (myregistry.azurecr.io) と 項目の値は、レジストリにアクセスするためのレジストリ資格情報になります。 |
CredentialsCustomRegistries |
sourceRegistry | ソース レジストリにアクセスするための資格情報パラメーターについて説明します。 | SourceRegistryCredentials の |
CredentialsCustomRegistries
名前 | 形容 | 価値 |
---|
CustomRegistryCredentials
名前 | 形容 | 価値 |
---|---|---|
同一性 | カスタム資格情報に割り当てられたマネージド ID を示します。 ユーザー割り当て ID この値はクライアント ID です。 システム割り当て ID の場合、値は system 。 でシステム割り当て ID の場合、クライアント ID はランナーによって決定されます。 これ ID を使用して資格情報を取得するために Key Vault に対する認証を行うか、または唯一の レジストリへのアクセスに使用される認証のソース。 |
糸 |
パスワード | カスタム レジストリにログインするためのパスワード。 パスワードはシークレットです オブジェクトに値を指定する複数の方法を使用できます。 |
SecretObject |
userName | カスタム レジストリにログインするためのユーザー名。 | SecretObject |
DockerBuildRequest
名前 | 形容 | 価値 |
---|---|---|
agentConfiguration | 実行エージェントのマシン構成。 | AgentProperties |
引数 | 実行の実行時に使用するオーバーライド引数のコレクション。 | 引数[] |
資格 情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 の |
dockerFilePath | ソースの場所を基準とした Docker ファイル パス。 | string (必須) |
imageNames | リポジトリとタグを含む完全修飾イメージ名。 | string[] |
isPushEnabled | このプロパティの値は、ビルドされたイメージをレジストリにプッシュする必要があるかどうかを示します。 | bool |
noCache | このプロパティの値は、イメージ キャッシュが有効かどうかを示します。 | bool |
プラットホーム | 実行を実行する必要があるプラットフォーム プロパティ。 | PlatformProperties (必須) |
sourceLocation | ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。 相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。 |
糸 |
ターゲット | Docker ビルドのターゲット ビルド ステージの名前。 | 糸 |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
種類 | 実行要求の種類。 | 'DockerBuildRequest' (必須) |
EncodedTaskRunRequest
名前 | 形容 | 価値 |
---|---|---|
agentConfiguration | 実行エージェントのマシン構成。 | AgentProperties |
資格 情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 の |
encodedTaskContent | テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。 | string (必須) |
encodedValuesContent | パラメーター/値ファイルの内容の Base64 でエンコードされた値。 | 糸 |
プラットホーム | 実行を実行する必要があるプラットフォーム プロパティ。 | PlatformProperties (必須) |
sourceLocation | ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。 相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。 |
糸 |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
種類 | 実行要求の種類。 | 'EncodedTaskRunRequest' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
FileTaskRunRequest
名前 | 形容 | 価値 |
---|---|---|
agentConfiguration | 実行エージェントのマシン構成。 | AgentProperties |
資格 情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 の |
プラットホーム | 実行を実行する必要があるプラットフォーム プロパティ。 | PlatformProperties (必須) |
sourceLocation | ソース コンテキストの URL (絶対または相対)。 tar または git リポジトリへの URL を指定できます。 相対 URL の場合は、listBuildSourceUploadUrl API の呼び出しから相対パスを取得する必要があります。 |
糸 |
taskFilePath | ソースに対するテンプレート/定義ファイルの相対パス。 | string (必須) |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
種類 | 実行要求の種類。 | 'FileTaskRunRequest' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
valuesFilePath | ソースに対する相対値/パラメーター ファイル パス。 | 糸 |
IdentityProperties
名前 | 形容 | 価値 |
---|---|---|
principalId | リソース ID のプリンシパル ID。 | 糸 |
tenantId | リソースのテナント ID。 | 糸 |
種類 | ID の種類。 | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
userAssignedIdentities | リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。 '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
IdentityPropertiesUserAssignedIdentities の |
IdentityPropertiesUserAssignedIdentities
名前 | 形容 | 価値 |
---|
Microsoft.ContainerRegistry/registries/taskRuns
名前 | 形容 | 価値 |
---|---|---|
同一性 | リソースの ID。 | IdentityProperties の |
場所 | リソースの場所 | 糸 |
名前 | リソース名 | 糸 制約: 最小長 = 5 最大長 = 50 パターン = ^[a-zA-Z0-9-]*$ (必須) |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: レジストリ |
プロパティ | タスクの実行に関連付けられているプロパティ (つまり、実行の要求と結果) | TaskRunProperties |
種類 | リソースの種類 | "Microsoft.ContainerRegistry/registries/taskRuns@2019-06-01-preview" |
OverrideTaskStepProperties
名前 | 形容 | 価値 |
---|---|---|
引数 | 次の場合に使用するオーバーライド引数のコレクションを取得または設定します。 ビルド ステップを実行しています。 |
引数[] |
contextPath | 実行をキューに入れる必要があるソース コンテキスト。 | 糸 |
ファイル | 実行の対象となるファイルをキューに入れる必要があります。 | 糸 |
ターゲット | Docker ビルドのターゲット ビルド ステージの名前。 | 糸 |
updateTriggerToken | 基本イメージ トリガー Webhook にアタッチされる Base64 でエンコードされた更新トリガー トークン。 | 糸 |
価値観 | Task の実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
PlatformProperties
名前 | 形容 | 価値 |
---|---|---|
建築 | OS アーキテクチャ。 | '386' 'amd64' 'arm' 'arm64' 'x86' |
os | 実行に必要なオペレーティング システムの種類。 | 'Linux' 'Windows' (必須) |
バリアント | CPU のバリアント。 | 'v6' 'v7' 'v8' |
RunRequest
名前 | 形容 | 価値 |
---|---|---|
agentPoolName | 実行用の専用エージェント プール。 | 糸 |
isArchiveEnabled | 実行に対してアーカイブが有効かどうかを示す値。 | bool |
logTemplate | 実行ログ成果物のリポジトリとタグ情報を記述するテンプレート。 | 糸 |
種類 | DockerBuildRequestの型 |
'DockerBuildRequest' 'EncodedTaskRunRequest' 'FileTaskRunRequest' 'TaskRunRequest' (必須) |
SecretObject
名前 | 形容 | 価値 |
---|---|---|
種類 | シークレット オブジェクトの値を指定するシークレット オブジェクトの型。 解釈。 |
'Opaque' 'Vaultsecret' |
価値 | シークレットの値。 この値の形式が決定されます シークレット オブジェクトの型に基づいています。 型が Opaque の場合、値は 変更なしでそのまま使用されます。 |
糸 |
SetValue
名前 | 形容 | 価値 |
---|---|---|
isSecret | 値がシークレットを表すかどうかを示すフラグ。 | bool |
名前 | オーバーライド可能な値の名前。 | string (必須) |
価値 | オーバーライド可能な値。 | string (必須) |
SourceRegistryCredentials
名前 | 形容 | 価値 |
---|---|---|
loginMode | ソース レジストリのログイン スコープを決定する認証モード。 ソース レジストリの資格情報 は、指定されたスコープを使用して生成されます。 これらの資格情報は、〘〗〘 実行中のソース レジストリ。 |
'Default' 'None' |
TaskRunProperties
名前 | 形容 | 価値 |
---|---|---|
forceUpdateTag | 実行要求の構成が変更されていない場合でも、実行を強制的に再実行する方法 | 糸 |
runRequest | 実行の要求 (パラメーター) | RunRequest の |
TaskRunRequest
名前 | 形容 | 価値 |
---|---|---|
overrideTaskStepProperties | タスクの実行時に渡すことができるオーバーライド可能なパラメーターのセット。 | OverrideTaskStepProperties の |
taskId | 実行対象のタスクのリソース ID をキューに登録する必要があります。 | string (必須) |
種類 | 実行要求の種類。 | 'TaskRunRequest' (必須) |
UserIdentityProperties
名前 | 形容 | 価値 |
---|---|---|
clientId | ユーザー割り当て ID のクライアント ID。 | 糸 |
principalId | ユーザー割り当て ID のプリンシパル ID。 | 糸 |