Bicep リソース定義
レジストリ/タスク のリソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ContainerRegistry/registries/tasks リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ContainerRegistry/registries/tasks@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: {
agentConfiguration: {
cpu: int
}
agentPoolName: 'string'
credentials: {
customRegistries: {
{customized property}: {
identity: 'string'
password: {
type: 'string'
value: 'string'
}
userName: {
type: 'string'
value: 'string'
}
}
}
sourceRegistry: {
loginMode: 'string'
}
}
isSystemTask: bool
logTemplate: 'string'
platform: {
architecture: 'string'
os: 'string'
variant: 'string'
}
status: 'string'
step: {
contextAccessToken: 'string'
contextPath: 'string'
type: 'string'
// For remaining properties, see TaskStepProperties objects
}
timeout: int
trigger: {
baseImageTrigger: {
baseImageTriggerType: 'string'
name: 'string'
status: 'string'
updateTriggerEndpoint: 'string'
updateTriggerPayloadType: 'string'
}
sourceTriggers: [
{
name: 'string'
sourceRepository: {
branch: 'string'
repositoryUrl: 'string'
sourceControlAuthProperties: {
expiresIn: int
refreshToken: 'string'
scope: 'string'
token: 'string'
tokenType: 'string'
}
sourceControlType: 'string'
}
sourceTriggerEvents: [
'string'
]
status: 'string'
}
]
timerTriggers: [
{
name: 'string'
schedule: 'string'
status: 'string'
}
]
}
}
tags: {
{customized property}: 'string'
}
}
TaskStepProperties オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
Docker の場合は、次を使用します。
{
arguments: [
{
isSecret: bool
name: 'string'
value: 'string'
}
]
dockerFilePath: 'string'
imageNames: [
'string'
]
isPushEnabled: bool
noCache: bool
target: 'string'
type: 'Docker'
}
EncodedTask の場合は、次を使用します。
{
encodedTaskContent: 'string'
encodedValuesContent: 'string'
type: 'EncodedTask'
values: [
{
isSecret: bool
name: 'string'
value: 'string'
}
]
}
FileTask の場合は、次を使用します。
{
taskFilePath: 'string'
type: 'FileTask'
values: [
{
isSecret: bool
name: 'string'
value: 'string'
}
]
valuesFilePath: 'string'
}
プロパティ値
Microsoft.ContainerRegistry/registries/tasks
名前 | 説明 | 価値 |
---|---|---|
アイデンティティ | リソースの ID。 | IdentityProperties の |
ロケーション | リソースの場所。 これは、リソースの作成後に変更することはできません。 | string (必須) |
名前 | リソース名 | 糸 制約: 最小長 = 5 最大長 = 50 パターン = ^[a-zA-Z0-9-_]*$ (必須) |
親 | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 |
種類のリソースのシンボリック名: レジストリ |
プロパティ | タスクのプロパティ。 | タスクプロパティ |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
エージェントプロパティ
名前 | 説明 | 価値 |
---|---|---|
CPUの | 実行に必要なコア数に関する CPU 構成。 | 整数 (int) |
引数
名前 | 説明 | 価値 |
---|---|---|
isシークレット | 引数がシークレットを表し、ビルド ログから削除するかどうかを示すフラグ。 | ブール (bool) |
名前 | 引数の名前。 | string (必須) |
価値 | 引数の値。 | string (必須) |
認証情報
名前 | 説明 | 価値 |
---|---|---|
expiresの | トークンが有効なままの時間 (秒単位) | 整数 (int) |
リフレッシュトークン | アクセス トークンの更新に使用される更新トークン。 | ひも |
範囲 | アクセス トークンのスコープ。 | ひも |
トークン | ソース管理プロバイダーへのアクセスに使用されるアクセス トークン。 | string (必須) |
トークンタイプ | 認証トークンの種類。 | 「OAuth」 'PAT' (必須) |
ベースイメージトリガー
名前 | 説明 | 価値 |
---|---|---|
baseImageTriggerType (ベースイメージトリガータイプ) | 基本イメージの依存関係更新の自動トリガーの種類。 | 「すべて」 'Runtime' (必須) |
名前 | トリガーの名前。 | string (必須) |
ステータス | トリガーの現在の状態。 | 「無効」 「有効」 |
updateTriggerエンドポイント | 更新トリガーを受信するためのエンドポイント URL。 | ひも |
updateTriggerペイロードタイプ | 基本イメージ更新トリガーのペイロード本文の種類。 | デフォルト 「トークン」 |
資格情報
名前 | 説明 | 価値 |
---|---|---|
customRegistries (カスタムレジストリ) | 他のカスタム レジストリにアクセスするための資格情報パラメーターについて説明します。 そのカギ ディクショナリ項目の場合は、レジストリ ログイン サーバー (myregistry.azurecr.io) と 項目の値は、レジストリにアクセスするためのレジストリ資格情報になります。 |
CredentialsCustomRegistries (英語) |
ソースレジストリ | ソース レジストリにアクセスするための資格情報パラメーターについて説明します。 | SourceRegistryCredentials |
CredentialsCustomRegistries (英語)
名前 | 説明 | 価値 |
---|
CustomRegistryCredentials
名前 | 説明 | 価値 |
---|---|---|
アイデンティティ | カスタム資格情報に割り当てられたマネージド ID を示します。 ユーザー割り当て ID この値はクライアント ID です。 システム割り当て ID の場合、値は system されます。 でシステム割り当て ID の場合、クライアント ID はランナーによって決定されます。 これ ID を使用して資格情報を取得するために Key Vault に対する認証を行うか、または唯一の レジストリへのアクセスに使用される認証のソース。 |
ひも |
パスワード | カスタム レジストリにログインするためのパスワード。 パスワードはシークレットです オブジェクトに値を指定する複数の方法を使用できます。 |
シークレットオブジェクト |
ユーザー名 | カスタム レジストリにログインするためのユーザー名。 | シークレットオブジェクト |
ドッカービルドステップ
名前 | 説明 | 価値 |
---|---|---|
引数 | このビルド ステップの実行時に使用するオーバーライド引数のコレクション。 | 引数[] |
dockerFileパス | ソース コンテキストを基準とした Docker ファイル パス。 | string (必須) |
画像名 | リポジトリとタグを含む完全修飾イメージ名。 | 文字列[] |
isPushEnabledの | このプロパティの値は、ビルドされたイメージをレジストリにプッシュする必要があるかどうかを示します。 | ブール (bool) |
noCache(ノーキャッシュ) | このプロパティの値は、イメージ キャッシュが有効かどうかを示します。 | ブール (bool) |
目標 | Docker ビルドのターゲット ビルド ステージの名前。 | ひも |
種類 | ステップの種類。 | 'Docker' (必須) |
エンコードされたタスクステップ
名前 | 説明 | 価値 |
---|---|---|
encodedTaskContent | テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。 | string (必須) |
encodedValuesコンテンツ | パラメーター/値ファイルの内容の Base64 でエンコードされた値。 | ひも |
種類 | ステップの種類。 | 'EncodedTask' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
ファイルタスクステップ
名前 | 説明 | 価値 |
---|---|---|
taskFilePath (タスクファイルパス) | ソース コンテキストを基準としたタスク テンプレート/定義ファイルのパス。 | string (必須) |
種類 | ステップの種類。 | 'FileTask' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | 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
名前 | 説明 | 価値 |
---|
プラットフォームプロパティ
名前 | 説明 | 価値 |
---|---|---|
建築 | OS アーキテクチャ。 | '386' 「AMD64」 'アーム' 'arm64' 'x86' |
オス | 実行に必要なオペレーティング システムの種類。 | 「リナックス」 'Windows' (必須) |
バリアント | CPU のバリアント。 | 「V6」 「V7」 「V8」 |
リソースタグ
名前 | 説明 | 価値 |
---|
シークレットオブジェクト
名前 | 説明 | 価値 |
---|---|---|
種類 | シークレット オブジェクトの値を指定するシークレット オブジェクトの型。 解釈。 |
「不透明」 「ヴォールトシークレット」 |
価値 | シークレットの値。 この値の形式が決定されます シークレット オブジェクトの型に基づいています。 型が Opaque の場合、値は 変更なしでそのまま使用されます。 |
ひも |
値を設定
名前 | 説明 | 価値 |
---|---|---|
isシークレット | 値がシークレットを表すかどうかを示すフラグ。 | ブール (bool) |
名前 | オーバーライド可能な値の名前。 | string (必須) |
価値 | オーバーライド可能な値。 | string (必須) |
ソースプロパティーズ
名前 | 説明 | 価値 |
---|---|---|
枝 | ソース コードのブランチ名。 | ひも |
リポジトリURL | ソース コード リポジトリへの完全な URL | string (必須) |
sourceControlAuthプロパティ | ソース コード リポジトリにアクセスし、設定するための承認プロパティ 通知用の webhook。 |
認証情報 |
ソースコントロールタイプ | ソース管理サービスの種類。 | 「Github」 'VisualStudioTeamService' (必須) |
SourceRegistryCredentials
名前 | 説明 | 価値 |
---|---|---|
ログインモード | ソース レジストリのログイン スコープを決定する認証モード。 ソース レジストリの資格情報 は、指定されたスコープを使用して生成されます。 これらの資格情報は、〘〗〘 実行中のソース レジストリ。 |
デフォルト 「なし」 |
ソーストリガー
名前 | 説明 | 価値 |
---|---|---|
名前 | トリガーの名前。 | string (必須) |
ソースリポジトリ | タスクのソース (コード) を記述するプロパティ。 | SourceProperties (必須) |
sourceTriggerイベント | トリガーに対応するソース イベント。 | 次のいずれかを含む文字列配列: 'コミット' 'pullrequest' (必須) |
ステータス | トリガーの現在の状態。 | 「無効」 「有効」 |
タスクプロパティ
名前 | 説明 | 価値 |
---|---|---|
エージェント構成 | 実行エージェントのマシン構成。 | エージェントプロパティ |
エージェントプール名 | タスクの専用エージェント プール。 | ひも |
資格情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 |
isSystemタスク | このプロパティの値は、タスク リソースがシステム タスクかどうかを示します。 | ブール (bool) |
ログテンプレート | 実行ログ成果物のリポジトリとタグ情報を記述するテンプレート。 | ひも |
プラットフォーム | 実行を実行する必要があるプラットフォーム プロパティ。 | プラットフォームプロパティ |
ステータス | タスクの現在の状態。 | 「無効」 「有効」 |
歩 | タスク ステップのプロパティ。 | タスク ステップ プロパティ |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
誘発要因 | タスクのすべてのトリガーを記述するプロパティ。 | トリガープロパティ |
タスク ステップ プロパティ
名前 | 説明 | 価値 |
---|---|---|
contextAccessトークン | ステップのコンテキストに関連付けられているトークン (ストレージ アカウント BLOB の git PAT または SAS トークン)。 | ひも |
コンテキストパス | タスク ステップのソース コンテキストの URL (絶対または相対)。 | ひも |
種類 | DockerBuildStep 型の場合は 'Docker' に設定します。 EncodedTaskStep 型の場合は 'EncodedTask' に設定します。 FileTaskStep 型の場合は 、' FileTask' に設定します。 | 「ドッカー」 「エンコードタスク」 'FileTask' (必須) |
タイマートリガー
名前 | 説明 | 価値 |
---|---|---|
名前 | トリガーの名前。 | string (必須) |
スケジュール | タスク スケジュールの CRON 式 | string (必須) |
ステータス | トリガーの現在の状態。 | 「無効」 「有効」 |
トリガープロパティ
名前 | 説明 | 価値 |
---|---|---|
baseImageTrigger の | 基本イメージの依存関係に基づくトリガー。 | ベースイメージトリガー |
ソーストリガー | ソース コード リポジトリに基づくトリガーのコレクション。 | ソーストリガー[] |
タイマートリガー | タイマー トリガーのコレクション。 | タイマートリガー[] |
ユーザーアイデンティティプロパティ
名前 | 説明 | 価値 |
---|---|---|
クライアントID | ユーザー割り当て ID のクライアント ID。 | ひも |
プリンシパルID | ユーザー割り当て ID のプリンシパル ID。 | ひも |
ARM テンプレート リソース定義
レジストリ/タスク のリソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ContainerRegistry/registries/tasks リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ContainerRegistry/registries/tasks",
"apiVersion": "2019-06-01-preview",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"agentConfiguration": {
"cpu": "int"
},
"agentPoolName": "string",
"credentials": {
"customRegistries": {
"{customized property}": {
"identity": "string",
"password": {
"type": "string",
"value": "string"
},
"userName": {
"type": "string",
"value": "string"
}
}
},
"sourceRegistry": {
"loginMode": "string"
}
},
"isSystemTask": "bool",
"logTemplate": "string",
"platform": {
"architecture": "string",
"os": "string",
"variant": "string"
},
"status": "string",
"step": {
"contextAccessToken": "string",
"contextPath": "string",
"type": "string"
// For remaining properties, see TaskStepProperties objects
},
"timeout": "int",
"trigger": {
"baseImageTrigger": {
"baseImageTriggerType": "string",
"name": "string",
"status": "string",
"updateTriggerEndpoint": "string",
"updateTriggerPayloadType": "string"
},
"sourceTriggers": [
{
"name": "string",
"sourceRepository": {
"branch": "string",
"repositoryUrl": "string",
"sourceControlAuthProperties": {
"expiresIn": "int",
"refreshToken": "string",
"scope": "string",
"token": "string",
"tokenType": "string"
},
"sourceControlType": "string"
},
"sourceTriggerEvents": [ "string" ],
"status": "string"
}
],
"timerTriggers": [
{
"name": "string",
"schedule": "string",
"status": "string"
}
]
}
},
"tags": {
"{customized property}": "string"
}
}
TaskStepProperties オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
Docker の場合は、次を使用します。
{
"arguments": [
{
"isSecret": "bool",
"name": "string",
"value": "string"
}
],
"dockerFilePath": "string",
"imageNames": [ "string" ],
"isPushEnabled": "bool",
"noCache": "bool",
"target": "string",
"type": "Docker"
}
EncodedTask の場合は、次を使用します。
{
"encodedTaskContent": "string",
"encodedValuesContent": "string",
"type": "EncodedTask",
"values": [
{
"isSecret": "bool",
"name": "string",
"value": "string"
}
]
}
FileTask の場合は、次を使用します。
{
"taskFilePath": "string",
"type": "FileTask",
"values": [
{
"isSecret": "bool",
"name": "string",
"value": "string"
}
],
"valuesFilePath": "string"
}
プロパティ値
Microsoft.ContainerRegistry/registries/tasks
名前 | 説明 | 価値 |
---|---|---|
apiVersion (英語) | API のバージョン | '2019-06-01-プレビュー' |
アイデンティティ | リソースの ID。 | IdentityProperties の |
ロケーション | リソースの場所。 これは、リソースの作成後に変更することはできません。 | string (必須) |
名前 | リソース名 | 糸 制約: 最小長 = 5 最大長 = 50 パターン = ^[a-zA-Z0-9-_]*$ (必須) |
プロパティ | タスクのプロパティ。 | タスクプロパティ |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
種類 | リソースの種類 | 'Microsoft.ContainerRegistry/registries/tasks' |
エージェントプロパティ
名前 | 説明 | 価値 |
---|---|---|
CPUの | 実行に必要なコア数に関する CPU 構成。 | 整数 (int) |
引数
名前 | 説明 | 価値 |
---|---|---|
isシークレット | 引数がシークレットを表し、ビルド ログから削除するかどうかを示すフラグ。 | ブール (bool) |
名前 | 引数の名前。 | string (必須) |
価値 | 引数の値。 | string (必須) |
認証情報
名前 | 説明 | 価値 |
---|---|---|
expiresの | トークンが有効なままの時間 (秒単位) | 整数 (int) |
リフレッシュトークン | アクセス トークンの更新に使用される更新トークン。 | ひも |
範囲 | アクセス トークンのスコープ。 | ひも |
トークン | ソース管理プロバイダーへのアクセスに使用されるアクセス トークン。 | string (必須) |
トークンタイプ | 認証トークンの種類。 | 「OAuth」 'PAT' (必須) |
ベースイメージトリガー
名前 | 説明 | 価値 |
---|---|---|
baseImageTriggerType (ベースイメージトリガータイプ) | 基本イメージの依存関係更新の自動トリガーの種類。 | 「すべて」 'Runtime' (必須) |
名前 | トリガーの名前。 | string (必須) |
ステータス | トリガーの現在の状態。 | 「無効」 「有効」 |
updateTriggerエンドポイント | 更新トリガーを受信するためのエンドポイント URL。 | ひも |
updateTriggerペイロードタイプ | 基本イメージ更新トリガーのペイロード本文の種類。 | デフォルト 「トークン」 |
資格情報
名前 | 説明 | 価値 |
---|---|---|
customRegistries (カスタムレジストリ) | 他のカスタム レジストリにアクセスするための資格情報パラメーターについて説明します。 そのカギ ディクショナリ項目の場合は、レジストリ ログイン サーバー (myregistry.azurecr.io) と 項目の値は、レジストリにアクセスするためのレジストリ資格情報になります。 |
CredentialsCustomRegistries (英語) |
ソースレジストリ | ソース レジストリにアクセスするための資格情報パラメーターについて説明します。 | SourceRegistryCredentials |
CredentialsCustomRegistries (英語)
名前 | 説明 | 価値 |
---|
CustomRegistryCredentials
名前 | 説明 | 価値 |
---|---|---|
アイデンティティ | カスタム資格情報に割り当てられたマネージド ID を示します。 ユーザー割り当て ID この値はクライアント ID です。 システム割り当て ID の場合、値は system されます。 でシステム割り当て ID の場合、クライアント ID はランナーによって決定されます。 これ ID を使用して資格情報を取得するために Key Vault に対する認証を行うか、または唯一の レジストリへのアクセスに使用される認証のソース。 |
ひも |
パスワード | カスタム レジストリにログインするためのパスワード。 パスワードはシークレットです オブジェクトに値を指定する複数の方法を使用できます。 |
シークレットオブジェクト |
ユーザー名 | カスタム レジストリにログインするためのユーザー名。 | シークレットオブジェクト |
ドッカービルドステップ
名前 | 説明 | 価値 |
---|---|---|
引数 | このビルド ステップの実行時に使用するオーバーライド引数のコレクション。 | 引数[] |
dockerFileパス | ソース コンテキストを基準とした Docker ファイル パス。 | string (必須) |
画像名 | リポジトリとタグを含む完全修飾イメージ名。 | 文字列[] |
isPushEnabledの | このプロパティの値は、ビルドされたイメージをレジストリにプッシュする必要があるかどうかを示します。 | ブール (bool) |
noCache(ノーキャッシュ) | このプロパティの値は、イメージ キャッシュが有効かどうかを示します。 | ブール (bool) |
目標 | Docker ビルドのターゲット ビルド ステージの名前。 | ひも |
種類 | ステップの種類。 | 'Docker' (必須) |
エンコードされたタスクステップ
名前 | 説明 | 価値 |
---|---|---|
encodedTaskContent | テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。 | string (必須) |
encodedValuesコンテンツ | パラメーター/値ファイルの内容の Base64 でエンコードされた値。 | ひも |
種類 | ステップの種類。 | 'EncodedTask' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
ファイルタスクステップ
名前 | 説明 | 価値 |
---|---|---|
taskFilePath (タスクファイルパス) | ソース コンテキストを基準としたタスク テンプレート/定義ファイルのパス。 | string (必須) |
種類 | ステップの種類。 | 'FileTask' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | 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
名前 | 説明 | 価値 |
---|
プラットフォームプロパティ
名前 | 説明 | 価値 |
---|---|---|
建築 | OS アーキテクチャ。 | '386' 「AMD64」 'アーム' 'arm64' 'x86' |
オス | 実行に必要なオペレーティング システムの種類。 | 「リナックス」 'Windows' (必須) |
バリアント | CPU のバリアント。 | 「V6」 「V7」 「V8」 |
リソースタグ
名前 | 説明 | 価値 |
---|
シークレットオブジェクト
名前 | 説明 | 価値 |
---|---|---|
種類 | シークレット オブジェクトの値を指定するシークレット オブジェクトの型。 解釈。 |
「不透明」 「ヴォールトシークレット」 |
価値 | シークレットの値。 この値の形式が決定されます シークレット オブジェクトの型に基づいています。 型が Opaque の場合、値は 変更なしでそのまま使用されます。 |
ひも |
値を設定
名前 | 説明 | 価値 |
---|---|---|
isシークレット | 値がシークレットを表すかどうかを示すフラグ。 | ブール (bool) |
名前 | オーバーライド可能な値の名前。 | string (必須) |
価値 | オーバーライド可能な値。 | string (必須) |
ソースプロパティーズ
名前 | 説明 | 価値 |
---|---|---|
枝 | ソース コードのブランチ名。 | ひも |
リポジトリURL | ソース コード リポジトリへの完全な URL | string (必須) |
sourceControlAuthプロパティ | ソース コード リポジトリにアクセスし、設定するための承認プロパティ 通知用の webhook。 |
認証情報 |
ソースコントロールタイプ | ソース管理サービスの種類。 | 「Github」 'VisualStudioTeamService' (必須) |
SourceRegistryCredentials
名前 | 説明 | 価値 |
---|---|---|
ログインモード | ソース レジストリのログイン スコープを決定する認証モード。 ソース レジストリの資格情報 は、指定されたスコープを使用して生成されます。 これらの資格情報は、〘〗〘 実行中のソース レジストリ。 |
デフォルト 「なし」 |
ソーストリガー
名前 | 説明 | 価値 |
---|---|---|
名前 | トリガーの名前。 | string (必須) |
ソースリポジトリ | タスクのソース (コード) を記述するプロパティ。 | SourceProperties (必須) |
sourceTriggerイベント | トリガーに対応するソース イベント。 | 次のいずれかを含む文字列配列: 'コミット' 'pullrequest' (必須) |
ステータス | トリガーの現在の状態。 | 「無効」 「有効」 |
タスクプロパティ
名前 | 説明 | 価値 |
---|---|---|
エージェント構成 | 実行エージェントのマシン構成。 | エージェントプロパティ |
エージェントプール名 | タスクの専用エージェント プール。 | ひも |
資格情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 |
isSystemタスク | このプロパティの値は、タスク リソースがシステム タスクかどうかを示します。 | ブール (bool) |
ログテンプレート | 実行ログ成果物のリポジトリとタグ情報を記述するテンプレート。 | ひも |
プラットフォーム | 実行を実行する必要があるプラットフォーム プロパティ。 | プラットフォームプロパティ |
ステータス | タスクの現在の状態。 | 「無効」 「有効」 |
歩 | タスク ステップのプロパティ。 | タスク ステップ プロパティ |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
誘発要因 | タスクのすべてのトリガーを記述するプロパティ。 | トリガープロパティ |
タスク ステップ プロパティ
名前 | 説明 | 価値 |
---|---|---|
contextAccessトークン | ステップのコンテキストに関連付けられているトークン (ストレージ アカウント BLOB の git PAT または SAS トークン)。 | ひも |
コンテキストパス | タスク ステップのソース コンテキストの URL (絶対または相対)。 | ひも |
種類 | DockerBuildStep 型の場合は 'Docker' に設定します。 EncodedTaskStep 型の場合は 'EncodedTask' に設定します。 FileTaskStep 型の場合は 、' FileTask' に設定します。 | 「ドッカー」 「エンコードタスク」 'FileTask' (必須) |
タイマートリガー
名前 | 説明 | 価値 |
---|---|---|
名前 | トリガーの名前。 | string (必須) |
スケジュール | タスク スケジュールの CRON 式 | string (必須) |
ステータス | トリガーの現在の状態。 | 「無効」 「有効」 |
トリガープロパティ
名前 | 説明 | 価値 |
---|---|---|
baseImageTrigger の | 基本イメージの依存関係に基づくトリガー。 | ベースイメージトリガー |
ソーストリガー | ソース コード リポジトリに基づくトリガーのコレクション。 | ソーストリガー[] |
タイマートリガー | タイマー トリガーのコレクション。 | タイマートリガー[] |
ユーザーアイデンティティプロパティ
名前 | 説明 | 価値 |
---|---|---|
クライアントID | ユーザー割り当て ID のクライアント ID。 | ひも |
プリンシパルID | ユーザー割り当て ID のプリンシパル ID。 | ひも |
使用例
Terraform (AzAPI プロバイダー) リソース定義
レジストリ/タスク のリソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループ
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ContainerRegistry/registries/tasks リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerRegistry/registries/tasks@2019-06-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
agentConfiguration = {
cpu = int
}
agentPoolName = "string"
credentials = {
customRegistries = {
{customized property} = {
identity = "string"
password = {
type = "string"
value = "string"
}
userName = {
type = "string"
value = "string"
}
}
}
sourceRegistry = {
loginMode = "string"
}
}
isSystemTask = bool
logTemplate = "string"
platform = {
architecture = "string"
os = "string"
variant = "string"
}
status = "string"
step = {
contextAccessToken = "string"
contextPath = "string"
type = "string"
// For remaining properties, see TaskStepProperties objects
}
timeout = int
trigger = {
baseImageTrigger = {
baseImageTriggerType = "string"
name = "string"
status = "string"
updateTriggerEndpoint = "string"
updateTriggerPayloadType = "string"
}
sourceTriggers = [
{
name = "string"
sourceRepository = {
branch = "string"
repositoryUrl = "string"
sourceControlAuthProperties = {
expiresIn = int
refreshToken = "string"
scope = "string"
token = "string"
tokenType = "string"
}
sourceControlType = "string"
}
sourceTriggerEvents = [
"string"
]
status = "string"
}
]
timerTriggers = [
{
name = "string"
schedule = "string"
status = "string"
}
]
}
}
}
}
TaskStepProperties オブジェクト
型 プロパティを設定して、オブジェクトの型を指定します。
Docker の場合は、次を使用します。
{
arguments = [
{
isSecret = bool
name = "string"
value = "string"
}
]
dockerFilePath = "string"
imageNames = [
"string"
]
isPushEnabled = bool
noCache = bool
target = "string"
type = "Docker"
}
EncodedTask の場合は、次を使用します。
{
encodedTaskContent = "string"
encodedValuesContent = "string"
type = "EncodedTask"
values = [
{
isSecret = bool
name = "string"
value = "string"
}
]
}
FileTask の場合は、次を使用します。
{
taskFilePath = "string"
type = "FileTask"
values = [
{
isSecret = bool
name = "string"
value = "string"
}
]
valuesFilePath = "string"
}
プロパティ値
Microsoft.ContainerRegistry/registries/tasks
名前 | 説明 | 価値 |
---|---|---|
アイデンティティ | リソースの ID。 | IdentityProperties の |
ロケーション | リソースの場所。 これは、リソースの作成後に変更することはできません。 | string (必須) |
名前 | リソース名 | 糸 制約: 最小長 = 5 最大長 = 50 パターン = ^[a-zA-Z0-9-_]*$ (必須) |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: レジストリ |
プロパティ | タスクのプロパティ。 | タスクプロパティ |
タグ | リソース タグ | タグ名と値のディクショナリ。 |
種類 | リソースの種類 | 「Microsoft.ContainerRegistry/レジストリ/tasks@2019-06-01-preview」 |
エージェントプロパティ
名前 | 説明 | 価値 |
---|---|---|
CPUの | 実行に必要なコア数に関する CPU 構成。 | 整数 (int) |
引数
名前 | 説明 | 価値 |
---|---|---|
isシークレット | 引数がシークレットを表し、ビルド ログから削除するかどうかを示すフラグ。 | ブール (bool) |
名前 | 引数の名前。 | string (必須) |
価値 | 引数の値。 | string (必須) |
認証情報
名前 | 説明 | 価値 |
---|---|---|
expiresの | トークンが有効なままの時間 (秒単位) | 整数 (int) |
リフレッシュトークン | アクセス トークンの更新に使用される更新トークン。 | ひも |
範囲 | アクセス トークンのスコープ。 | ひも |
トークン | ソース管理プロバイダーへのアクセスに使用されるアクセス トークン。 | string (必須) |
トークンタイプ | 認証トークンの種類。 | 「OAuth」 'PAT' (必須) |
ベースイメージトリガー
名前 | 説明 | 価値 |
---|---|---|
baseImageTriggerType (ベースイメージトリガータイプ) | 基本イメージの依存関係更新の自動トリガーの種類。 | 「すべて」 'Runtime' (必須) |
名前 | トリガーの名前。 | string (必須) |
ステータス | トリガーの現在の状態。 | 「無効」 「有効」 |
updateTriggerエンドポイント | 更新トリガーを受信するためのエンドポイント URL。 | ひも |
updateTriggerペイロードタイプ | 基本イメージ更新トリガーのペイロード本文の種類。 | デフォルト 「トークン」 |
資格情報
名前 | 説明 | 価値 |
---|---|---|
customRegistries (カスタムレジストリ) | 他のカスタム レジストリにアクセスするための資格情報パラメーターについて説明します。 そのカギ ディクショナリ項目の場合は、レジストリ ログイン サーバー (myregistry.azurecr.io) と 項目の値は、レジストリにアクセスするためのレジストリ資格情報になります。 |
CredentialsCustomRegistries (英語) |
ソースレジストリ | ソース レジストリにアクセスするための資格情報パラメーターについて説明します。 | SourceRegistryCredentials |
CredentialsCustomRegistries (英語)
名前 | 説明 | 価値 |
---|
CustomRegistryCredentials
名前 | 説明 | 価値 |
---|---|---|
アイデンティティ | カスタム資格情報に割り当てられたマネージド ID を示します。 ユーザー割り当て ID この値はクライアント ID です。 システム割り当て ID の場合、値は system されます。 でシステム割り当て ID の場合、クライアント ID はランナーによって決定されます。 これ ID を使用して資格情報を取得するために Key Vault に対する認証を行うか、または唯一の レジストリへのアクセスに使用される認証のソース。 |
ひも |
パスワード | カスタム レジストリにログインするためのパスワード。 パスワードはシークレットです オブジェクトに値を指定する複数の方法を使用できます。 |
シークレットオブジェクト |
ユーザー名 | カスタム レジストリにログインするためのユーザー名。 | シークレットオブジェクト |
ドッカービルドステップ
名前 | 説明 | 価値 |
---|---|---|
引数 | このビルド ステップの実行時に使用するオーバーライド引数のコレクション。 | 引数[] |
dockerFileパス | ソース コンテキストを基準とした Docker ファイル パス。 | string (必須) |
画像名 | リポジトリとタグを含む完全修飾イメージ名。 | 文字列[] |
isPushEnabledの | このプロパティの値は、ビルドされたイメージをレジストリにプッシュする必要があるかどうかを示します。 | ブール (bool) |
noCache(ノーキャッシュ) | このプロパティの値は、イメージ キャッシュが有効かどうかを示します。 | ブール (bool) |
目標 | Docker ビルドのターゲット ビルド ステージの名前。 | ひも |
種類 | ステップの種類。 | 'Docker' (必須) |
エンコードされたタスクステップ
名前 | 説明 | 価値 |
---|---|---|
encodedTaskContent | テンプレート/定義ファイルコンテンツの Base64 でエンコードされた値。 | string (必須) |
encodedValuesコンテンツ | パラメーター/値ファイルの内容の Base64 でエンコードされた値。 | ひも |
種類 | ステップの種類。 | 'EncodedTask' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | SetValue[] |
ファイルタスクステップ
名前 | 説明 | 価値 |
---|---|---|
taskFilePath (タスクファイルパス) | ソース コンテキストを基準としたタスク テンプレート/定義ファイルのパス。 | string (必須) |
種類 | ステップの種類。 | 'FileTask' (必須) |
価値観 | タスクの実行時に渡すことができるオーバーライド可能な値のコレクション。 | 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
名前 | 説明 | 価値 |
---|
プラットフォームプロパティ
名前 | 説明 | 価値 |
---|---|---|
建築 | OS アーキテクチャ。 | '386' 「AMD64」 'アーム' 'arm64' 'x86' |
オス | 実行に必要なオペレーティング システムの種類。 | 「リナックス」 'Windows' (必須) |
バリアント | CPU のバリアント。 | 「V6」 「V7」 「V8」 |
リソースタグ
名前 | 説明 | 価値 |
---|
シークレットオブジェクト
名前 | 説明 | 価値 |
---|---|---|
種類 | シークレット オブジェクトの値を指定するシークレット オブジェクトの型。 解釈。 |
「不透明」 「ヴォールトシークレット」 |
価値 | シークレットの値。 この値の形式が決定されます シークレット オブジェクトの型に基づいています。 型が Opaque の場合、値は 変更なしでそのまま使用されます。 |
ひも |
値を設定
名前 | 説明 | 価値 |
---|---|---|
isシークレット | 値がシークレットを表すかどうかを示すフラグ。 | ブール (bool) |
名前 | オーバーライド可能な値の名前。 | string (必須) |
価値 | オーバーライド可能な値。 | string (必須) |
ソースプロパティーズ
名前 | 説明 | 価値 |
---|---|---|
枝 | ソース コードのブランチ名。 | ひも |
リポジトリURL | ソース コード リポジトリへの完全な URL | string (必須) |
sourceControlAuthプロパティ | ソース コード リポジトリにアクセスし、設定するための承認プロパティ 通知用の webhook。 |
認証情報 |
ソースコントロールタイプ | ソース管理サービスの種類。 | 「Github」 'VisualStudioTeamService' (必須) |
SourceRegistryCredentials
名前 | 説明 | 価値 |
---|---|---|
ログインモード | ソース レジストリのログイン スコープを決定する認証モード。 ソース レジストリの資格情報 は、指定されたスコープを使用して生成されます。 これらの資格情報は、〘〗〘 実行中のソース レジストリ。 |
デフォルト 「なし」 |
ソーストリガー
名前 | 説明 | 価値 |
---|---|---|
名前 | トリガーの名前。 | string (必須) |
ソースリポジトリ | タスクのソース (コード) を記述するプロパティ。 | SourceProperties (必須) |
sourceTriggerイベント | トリガーに対応するソース イベント。 | 次のいずれかを含む文字列配列: 'コミット' 'pullrequest' (必須) |
ステータス | トリガーの現在の状態。 | 「無効」 「有効」 |
タスクプロパティ
名前 | 説明 | 価値 |
---|---|---|
エージェント構成 | 実行エージェントのマシン構成。 | エージェントプロパティ |
エージェントプール名 | タスクの専用エージェント プール。 | ひも |
資格情報 | この実行が呼び出されたときに使用される資格情報のセットを記述するプロパティ。 | 資格情報 |
isSystemタスク | このプロパティの値は、タスク リソースがシステム タスクかどうかを示します。 | ブール (bool) |
ログテンプレート | 実行ログ成果物のリポジトリとタグ情報を記述するテンプレート。 | ひも |
プラットフォーム | 実行を実行する必要があるプラットフォーム プロパティ。 | プラットフォームプロパティ |
ステータス | タスクの現在の状態。 | 「無効」 「有効」 |
歩 | タスク ステップのプロパティ。 | タスク ステップ プロパティ |
タイムアウト | 実行タイムアウト (秒単位)。 | int 制約: 最小値 = 300 最大値 = 28800 |
誘発要因 | タスクのすべてのトリガーを記述するプロパティ。 | トリガープロパティ |
タスク ステップ プロパティ
名前 | 説明 | 価値 |
---|---|---|
contextAccessトークン | ステップのコンテキストに関連付けられているトークン (ストレージ アカウント BLOB の git PAT または SAS トークン)。 | ひも |
コンテキストパス | タスク ステップのソース コンテキストの URL (絶対または相対)。 | ひも |
種類 | DockerBuildStep 型の場合は 'Docker' に設定します。 EncodedTaskStep 型の場合は 'EncodedTask' に設定します。 FileTaskStep 型の場合は 、' FileTask' に設定します。 | 「ドッカー」 「エンコードタスク」 'FileTask' (必須) |
タイマートリガー
名前 | 説明 | 価値 |
---|---|---|
名前 | トリガーの名前。 | string (必須) |
スケジュール | タスク スケジュールの CRON 式 | string (必須) |
ステータス | トリガーの現在の状態。 | 「無効」 「有効」 |
トリガープロパティ
名前 | 説明 | 価値 |
---|---|---|
baseImageTrigger の | 基本イメージの依存関係に基づくトリガー。 | ベースイメージトリガー |
ソーストリガー | ソース コード リポジトリに基づくトリガーのコレクション。 | ソーストリガー[] |
タイマートリガー | タイマー トリガーのコレクション。 | タイマートリガー[] |
ユーザーアイデンティティプロパティ
名前 | 説明 | 価値 |
---|---|---|
クライアントID | ユーザー割り当て ID のクライアント ID。 | ひも |
プリンシパルID | ユーザー割り当て ID のプリンシパル ID。 | ひも |