Microsoft.ContainerRegistry 登錄/taskRuns 2019-06-01-preview
Bicep 資源定義
登錄/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 組態。 | int |
論點
名字 | 描述 | 價值 |
---|---|---|
isSecret | 旗標,指出自變數是否代表秘密,而且想要從組建記錄中移除。 | bool |
名字 | 自變數的名稱。 | 字串 (必要) |
價值 | 自變數的值。 | 字串 (必要) |
憑據
名字 | 描述 | 價值 |
---|---|---|
customRegistries | 描述存取其他自定義登錄的認證參數。 機碼 字典專案的 是登錄登入伺服器 (myregistry.azurecr.io) 和 專案的值將會是用來存取登錄的登錄認證。 |
CredentialsCustomRegistries |
sourceRegistry | 描述存取來源登錄的認證參數。 | SourceRegistryCredentials |
CredentialsCustomRegistries
名字 | 描述 | 價值 |
---|
CustomRegistryCredentials
名字 | 描述 | 價值 |
---|---|---|
身份 | 指出指派給自定義認證的受控識別。 如果使用者指派的身分識別 此值為用戶端識別碼。 如果系統指派的身分識別,此值將會 system 。 在系統指派的身分識別案例,用戶端標識碼將由執行器決定。 這 身分識別可用來向金鑰保存庫進行驗證以擷取認證,或可能是唯一的 用於存取登錄的驗證來源。 |
字串 |
密碼 | 登入自定義登錄的密碼。 密碼是秘密 物件,可讓多種方式為其提供值。 |
SecretObject |
userName | 登入自定義登錄的用戶名稱。 | SecretObject |
DockerBuildRequest
名字 | 描述 | 價值 |
---|---|---|
agentConfiguration | 執行代理程式的機器組態。 | AgentProperties |
參數 | 執行執行時要使用的覆寫自變數集合。 | 自變數[] |
憑據 | 屬性,描述叫用此執行時將使用的一組認證。 | 認證 |
dockerFilePath | 相對於來源位置的 Docker 檔案路徑。 | 字串 (必要) |
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編碼值。 | 字串 (必要) |
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 | 相對於來源的範本/定義檔案路徑。 | 字串 (必要) |
超時 | 以秒為單位執行逾時。 | int 約束: 最小值 = 300 最大值 = 28800 |
類型 | 執行要求的型別。 | 'FileTaskRunRequest' (必要) |
值 | 執行工作時可傳遞之可覆寫值的集合。 | SetValue[] |
valuesFilePath | 相對於來源的值/參數檔案路徑。 | 字串 |
IdentityProperties
名字 | 描述 | 價值 |
---|---|---|
principalId | 資源識別的主要標識碼。 | 字串 |
tenantId | 資源的租用戶標識碼。 | 字串 |
類型 | 識別類型。 | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別 字典索引鍵參考的格式會是 ARM 資源識別碼: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
IdentityPropertiesUserAssignedIdentities |
IdentityPropertiesUserAssignedIdentities
名字 | 描述 | 價值 |
---|
Microsoft.ContainerRegistry/registries/taskRuns
名字 | 描述 | 價值 |
---|---|---|
身份 | 資源的身分識別。 | IdentityProperties |
位置 | 資源的位置 | 字串 |
名字 | 資源名稱 | 字串 約束: 最小長度 = 5 最大長度 = 5 模式 = ^[a-zA-Z0-9-]*$ (必要) |
父母 | 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。 如需詳細資訊,請參閱 父資源外部的子資源。 |
類型資源的符號名稱:登錄 |
性能 | 與工作執行相關聯的屬性,也就是執行的要求和結果 | TaskRunProperties |
OverrideTaskStepProperties
名字 | 描述 | 價值 |
---|---|---|
參數 | 取得或設定在何時使用的覆寫自變數集合 執行建置步驟。 |
自變數[] |
contextPath | 執行必須排入佇列的來源內容。 | 字串 |
檔 | 執行所針對的檔案必須排入佇列。 | 字串 |
目標 | Docker 組建的目標建置階段名稱。 | 字串 |
updateTriggerToken | 將附加基底映像觸發程式 Webhook 的 Base64 編碼更新觸發程式令牌。 | 字串 |
值 | 執行 Task 時可傳遞之可覆寫值的集合。 | SetValue[] |
PlatformProperties
名字 | 描述 | 價值 |
---|---|---|
建築 | OS 架構。 | '386' 'amd64' 'arm' 'arm64' 'x86' |
操作系統 | 執行所需的作業系統類型。 | 'Linux' 'Windows' (必要) |
變體 | CPU 的變體。 | 'v6' 'v7' 'v8' |
RunRequest
名字 | 描述 | 價值 |
---|---|---|
agentPoolName | 執行的專用代理程式集區。 | 字串 |
isArchiveEnabled | 值,指出是否為執行啟用封存。 | bool |
logTemplate | 範本,描述執行記錄成品的存放庫和標記資訊。 | 字串 |
類型 | 針對 dockerBuildRequest 類型設定為 'DockerBuildRequest',。 針對 type EncodedTaskRunRequest,設定為 'EncodedTaskRunRequest'。 針對 fileTaskRunRequest 類型設定為 'FileTaskRunRequest',。 針對TaskRunRequest 類型設定為 'TaskRunRequest',。 | 'DockerBuildRequest' 'EncodedTaskRunRequest' 'FileTaskRunRequest' 'TaskRunRequest' (必要) |
SecretObject
名字 | 描述 | 價值 |
---|---|---|
類型 | 秘密物件的型別,決定秘密物件的值必須如何 解釋。 |
'不透明' 'Vaultsecret' |
價值 | 秘密的值。 將決定此值的格式 根據秘密物件的類型。 如果類型為不透明,則值會是 使用 為 ,而不需要任何修改。 |
字串 |
SetValue
名字 | 描述 | 價值 |
---|---|---|
isSecret | 指出值是否代表秘密的旗標。 | bool |
名字 | 可覆寫值的名稱。 | 字串 (必要) |
價值 | 可覆寫的值。 | 字串 (必要) |
SourceRegistryCredentials
名字 | 描述 | 價值 |
---|---|---|
loginMode | 決定來源登錄登入範圍的驗證模式。 來源登錄的認證 將會使用指定的範圍產生。 這些認證將用來登入 執行期間的來源登錄。 |
'Default' 'None' |
TaskRunProperties
名字 | 描述 | 價值 |
---|---|---|
forceUpdateTag | 即使執行要求設定未變更,也應該強制重新執行執行的方式 | 字串 |
runRequest | 執行的要求(參數) | RunRequest |
TaskRunRequest
名字 | 描述 | 價值 |
---|---|---|
overrideTaskStepProperties | 執行 Task 時可傳遞的可覆寫參數集。 | OverrideTaskStepProperties |
taskId | 必須排入佇列之工作的資源標識碼。 | 字串 (必要) |
類型 | 執行要求的型別。 | 'TaskRunRequest' (必要) |
UserIdentityProperties
名字 | 描述 | 價值 |
---|---|---|
clientId | 使用者指派身分識別的用戶端標識碼。 | 字串 |
principalId | 使用者指派身分識別的主體標識碼。 | 字串 |
ARM 樣本資源定義
登錄/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 組態。 | int |
論點
名字 | 描述 | 價值 |
---|---|---|
isSecret | 旗標,指出自變數是否代表秘密,而且想要從組建記錄中移除。 | bool |
名字 | 自變數的名稱。 | 字串 (必要) |
價值 | 自變數的值。 | 字串 (必要) |
憑據
名字 | 描述 | 價值 |
---|---|---|
customRegistries | 描述存取其他自定義登錄的認證參數。 機碼 字典專案的 是登錄登入伺服器 (myregistry.azurecr.io) 和 專案的值將會是用來存取登錄的登錄認證。 |
CredentialsCustomRegistries |
sourceRegistry | 描述存取來源登錄的認證參數。 | SourceRegistryCredentials |
CredentialsCustomRegistries
名字 | 描述 | 價值 |
---|
CustomRegistryCredentials
名字 | 描述 | 價值 |
---|---|---|
身份 | 指出指派給自定義認證的受控識別。 如果使用者指派的身分識別 此值為用戶端識別碼。 如果系統指派的身分識別,此值將會 system 。 在系統指派的身分識別案例,用戶端標識碼將由執行器決定。 這 身分識別可用來向金鑰保存庫進行驗證以擷取認證,或可能是唯一的 用於存取登錄的驗證來源。 |
字串 |
密碼 | 登入自定義登錄的密碼。 密碼是秘密 物件,可讓多種方式為其提供值。 |
SecretObject |
userName | 登入自定義登錄的用戶名稱。 | SecretObject |
DockerBuildRequest
名字 | 描述 | 價值 |
---|---|---|
agentConfiguration | 執行代理程式的機器組態。 | AgentProperties |
參數 | 執行執行時要使用的覆寫自變數集合。 | 自變數[] |
憑據 | 屬性,描述叫用此執行時將使用的一組認證。 | 認證 |
dockerFilePath | 相對於來源位置的 Docker 檔案路徑。 | 字串 (必要) |
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編碼值。 | 字串 (必要) |
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 | 相對於來源的範本/定義檔案路徑。 | 字串 (必要) |
超時 | 以秒為單位執行逾時。 | int 約束: 最小值 = 300 最大值 = 28800 |
類型 | 執行要求的型別。 | 'FileTaskRunRequest' (必要) |
值 | 執行工作時可傳遞之可覆寫值的集合。 | SetValue[] |
valuesFilePath | 相對於來源的值/參數檔案路徑。 | 字串 |
IdentityProperties
名字 | 描述 | 價值 |
---|---|---|
principalId | 資源識別的主要標識碼。 | 字串 |
tenantId | 資源的租用戶標識碼。 | 字串 |
類型 | 識別類型。 | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別 字典索引鍵參考的格式會是 ARM 資源識別碼: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
IdentityPropertiesUserAssignedIdentities |
IdentityPropertiesUserAssignedIdentities
名字 | 描述 | 價值 |
---|
Microsoft.ContainerRegistry/registries/taskRuns
名字 | 描述 | 價值 |
---|---|---|
apiVersion | API 版本 | '2019-06-01-preview' |
身份 | 資源的身分識別。 | IdentityProperties |
位置 | 資源的位置 | 字串 |
名字 | 資源名稱 | 字串 約束: 最小長度 = 5 最大長度 = 5 模式 = ^[a-zA-Z0-9-]*$ (必要) |
性能 | 與工作執行相關聯的屬性,也就是執行的要求和結果 | TaskRunProperties |
類型 | 資源類型 | 'Microsoft.ContainerRegistry/registries/taskRuns' |
OverrideTaskStepProperties
名字 | 描述 | 價值 |
---|---|---|
參數 | 取得或設定在何時使用的覆寫自變數集合 執行建置步驟。 |
自變數[] |
contextPath | 執行必須排入佇列的來源內容。 | 字串 |
檔 | 執行所針對的檔案必須排入佇列。 | 字串 |
目標 | Docker 組建的目標建置階段名稱。 | 字串 |
updateTriggerToken | 將附加基底映像觸發程式 Webhook 的 Base64 編碼更新觸發程式令牌。 | 字串 |
值 | 執行 Task 時可傳遞之可覆寫值的集合。 | SetValue[] |
PlatformProperties
名字 | 描述 | 價值 |
---|---|---|
建築 | OS 架構。 | '386' 'amd64' 'arm' 'arm64' 'x86' |
操作系統 | 執行所需的作業系統類型。 | 'Linux' 'Windows' (必要) |
變體 | CPU 的變體。 | 'v6' 'v7' 'v8' |
RunRequest
名字 | 描述 | 價值 |
---|---|---|
agentPoolName | 執行的專用代理程式集區。 | 字串 |
isArchiveEnabled | 值,指出是否為執行啟用封存。 | bool |
logTemplate | 範本,描述執行記錄成品的存放庫和標記資訊。 | 字串 |
類型 | 針對 dockerBuildRequest 類型設定為 'DockerBuildRequest',。 針對 type EncodedTaskRunRequest,設定為 'EncodedTaskRunRequest'。 針對 fileTaskRunRequest 類型設定為 'FileTaskRunRequest',。 針對TaskRunRequest 類型設定為 'TaskRunRequest',。 | 'DockerBuildRequest' 'EncodedTaskRunRequest' 'FileTaskRunRequest' 'TaskRunRequest' (必要) |
SecretObject
名字 | 描述 | 價值 |
---|---|---|
類型 | 秘密物件的型別,決定秘密物件的值必須如何 解釋。 |
'不透明' 'Vaultsecret' |
價值 | 秘密的值。 將決定此值的格式 根據秘密物件的類型。 如果類型為不透明,則值會是 使用 為 ,而不需要任何修改。 |
字串 |
SetValue
名字 | 描述 | 價值 |
---|---|---|
isSecret | 指出值是否代表秘密的旗標。 | bool |
名字 | 可覆寫值的名稱。 | 字串 (必要) |
價值 | 可覆寫的值。 | 字串 (必要) |
SourceRegistryCredentials
名字 | 描述 | 價值 |
---|---|---|
loginMode | 決定來源登錄登入範圍的驗證模式。 來源登錄的認證 將會使用指定的範圍產生。 這些認證將用來登入 執行期間的來源登錄。 |
'Default' 'None' |
TaskRunProperties
名字 | 描述 | 價值 |
---|---|---|
forceUpdateTag | 即使執行要求設定未變更,也應該強制重新執行執行的方式 | 字串 |
runRequest | 執行的要求(參數) | RunRequest |
TaskRunRequest
名字 | 描述 | 價值 |
---|---|---|
overrideTaskStepProperties | 執行 Task 時可傳遞的可覆寫參數集。 | OverrideTaskStepProperties |
taskId | 必須排入佇列之工作的資源標識碼。 | 字串 (必要) |
類型 | 執行要求的型別。 | 'TaskRunRequest' (必要) |
UserIdentityProperties
名字 | 描述 | 價值 |
---|---|---|
clientId | 使用者指派身分識別的用戶端標識碼。 | 字串 |
principalId | 使用者指派身分識別的主體標識碼。 | 字串 |
Terraform (AzAPI 提供者) 資源定義
登錄/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 組態。 | int |
論點
名字 | 描述 | 價值 |
---|---|---|
isSecret | 旗標,指出自變數是否代表秘密,而且想要從組建記錄中移除。 | bool |
名字 | 自變數的名稱。 | 字串 (必要) |
價值 | 自變數的值。 | 字串 (必要) |
憑據
名字 | 描述 | 價值 |
---|---|---|
customRegistries | 描述存取其他自定義登錄的認證參數。 機碼 字典專案的 是登錄登入伺服器 (myregistry.azurecr.io) 和 專案的值將會是用來存取登錄的登錄認證。 |
CredentialsCustomRegistries |
sourceRegistry | 描述存取來源登錄的認證參數。 | SourceRegistryCredentials |
CredentialsCustomRegistries
名字 | 描述 | 價值 |
---|
CustomRegistryCredentials
名字 | 描述 | 價值 |
---|---|---|
身份 | 指出指派給自定義認證的受控識別。 如果使用者指派的身分識別 此值為用戶端識別碼。 如果系統指派的身分識別,此值將會 system 。 在系統指派的身分識別案例,用戶端標識碼將由執行器決定。 這 身分識別可用來向金鑰保存庫進行驗證以擷取認證,或可能是唯一的 用於存取登錄的驗證來源。 |
字串 |
密碼 | 登入自定義登錄的密碼。 密碼是秘密 物件,可讓多種方式為其提供值。 |
SecretObject |
userName | 登入自定義登錄的用戶名稱。 | SecretObject |
DockerBuildRequest
名字 | 描述 | 價值 |
---|---|---|
agentConfiguration | 執行代理程式的機器組態。 | AgentProperties |
參數 | 執行執行時要使用的覆寫自變數集合。 | 自變數[] |
憑據 | 屬性,描述叫用此執行時將使用的一組認證。 | 認證 |
dockerFilePath | 相對於來源位置的 Docker 檔案路徑。 | 字串 (必要) |
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編碼值。 | 字串 (必要) |
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 | 相對於來源的範本/定義檔案路徑。 | 字串 (必要) |
超時 | 以秒為單位執行逾時。 | int 約束: 最小值 = 300 最大值 = 28800 |
類型 | 執行要求的型別。 | 'FileTaskRunRequest' (必要) |
值 | 執行工作時可傳遞之可覆寫值的集合。 | SetValue[] |
valuesFilePath | 相對於來源的值/參數檔案路徑。 | 字串 |
IdentityProperties
名字 | 描述 | 價值 |
---|---|---|
principalId | 資源識別的主要標識碼。 | 字串 |
tenantId | 資源的租用戶標識碼。 | 字串 |
類型 | 識別類型。 | 'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' |
userAssignedIdentities | 與資源相關聯的使用者身分識別清單。 使用者身分識別 字典索引鍵參考的格式會是 ARM 資源識別碼: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
IdentityPropertiesUserAssignedIdentities |
IdentityPropertiesUserAssignedIdentities
名字 | 描述 | 價值 |
---|
Microsoft.ContainerRegistry/registries/taskRuns
名字 | 描述 | 價值 |
---|---|---|
身份 | 資源的身分識別。 | IdentityProperties |
位置 | 資源的位置 | 字串 |
名字 | 資源名稱 | 字串 約束: 最小長度 = 5 最大長度 = 5 模式 = ^[a-zA-Z0-9-]*$ (必要) |
parent_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' |
操作系統 | 執行所需的作業系統類型。 | 'Linux' 'Windows' (必要) |
變體 | CPU 的變體。 | 'v6' 'v7' 'v8' |
RunRequest
名字 | 描述 | 價值 |
---|---|---|
agentPoolName | 執行的專用代理程式集區。 | 字串 |
isArchiveEnabled | 值,指出是否為執行啟用封存。 | bool |
logTemplate | 範本,描述執行記錄成品的存放庫和標記資訊。 | 字串 |
類型 | 針對 dockerBuildRequest 類型設定為 'DockerBuildRequest',。 針對 type EncodedTaskRunRequest,設定為 'EncodedTaskRunRequest'。 針對 fileTaskRunRequest 類型設定為 'FileTaskRunRequest',。 針對TaskRunRequest 類型設定為 'TaskRunRequest',。 | 'DockerBuildRequest' 'EncodedTaskRunRequest' 'FileTaskRunRequest' 'TaskRunRequest' (必要) |
SecretObject
名字 | 描述 | 價值 |
---|---|---|
類型 | 秘密物件的型別,決定秘密物件的值必須如何 解釋。 |
'不透明' 'Vaultsecret' |
價值 | 秘密的值。 將決定此值的格式 根據秘密物件的類型。 如果類型為不透明,則值會是 使用 為 ,而不需要任何修改。 |
字串 |
SetValue
名字 | 描述 | 價值 |
---|---|---|
isSecret | 指出值是否代表秘密的旗標。 | bool |
名字 | 可覆寫值的名稱。 | 字串 (必要) |
價值 | 可覆寫的值。 | 字串 (必要) |
SourceRegistryCredentials
名字 | 描述 | 價值 |
---|---|---|
loginMode | 決定來源登錄登入範圍的驗證模式。 來源登錄的認證 將會使用指定的範圍產生。 這些認證將用來登入 執行期間的來源登錄。 |
'Default' 'None' |
TaskRunProperties
名字 | 描述 | 價值 |
---|---|---|
forceUpdateTag | 即使執行要求設定未變更,也應該強制重新執行執行的方式 | 字串 |
runRequest | 執行的要求(參數) | RunRequest |
TaskRunRequest
名字 | 描述 | 價值 |
---|---|---|
overrideTaskStepProperties | 執行 Task 時可傳遞的可覆寫參數集。 | OverrideTaskStepProperties |
taskId | 必須排入佇列之工作的資源標識碼。 | 字串 (必要) |
類型 | 執行要求的型別。 | 'TaskRunRequest' (必要) |
UserIdentityProperties
名字 | 描述 | 價值 |
---|---|---|
clientId | 使用者指派身分識別的用戶端標識碼。 | 字串 |
principalId | 使用者指派身分識別的主體標識碼。 | 字串 |