Tasks - Get Details
傳回包含所有秘密之擴充資訊的工作。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}/listDetails?api-version=2019-04-01
URI 參數
Name | In | Required | Type | Description |
---|---|---|---|---|
registry
|
path | True |
|
容器登錄的名稱。 Regex pattern: |
resource
|
path | True |
|
容器登錄所屬的資源群組名稱。 |
subscription
|
path | True |
|
Microsoft Azure訂用帳戶識別碼。 |
task
|
path | True |
|
容器登錄工作的名稱。 Regex pattern: |
api-version
|
query | True |
|
用戶端 API 版本。 |
回應
Name | Type | Description |
---|---|---|
200 OK |
要求成功;要求格式正確,且已正確接收。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 如果登錄不存在,則會傳回找不到 404 () 。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | 模擬您的使用者帳戶 |
範例
Tasks_GetDetails
Sample Request
POST https://management.azure.com/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/myResourceGroup/providers/Microsoft.ContainerRegistry/registries/myRegistry/tasks/myTask/listDetails?api-version=2019-04-01
Sample Response
{
"properties": {
"status": "Enabled",
"platform": {
"os": "Linux",
"architecture": "amd64"
},
"agentConfiguration": {
"cpu": 2
},
"step": {
"type": "Docker",
"imageNames": [
"azurerest:testtag"
],
"dockerFilePath": "src/DockerFile",
"contextPath": "src",
"isPushEnabled": true,
"noCache": false,
"arguments": [
{
"name": "mytestargument",
"value": "mytestvalue",
"isSecret": false
},
{
"name": "mysecrettestargument",
"value": "mysecrettestvalue",
"isSecret": true
}
]
},
"trigger": {
"timerTriggers": [
{
"name": "myTimerTrigger",
"status": "Enabled",
"schedule": "30 9 * * 1-5"
}
],
"sourceTriggers": [
{
"name": "mySourceTrigger",
"status": "Enabled",
"sourceRepository": {
"sourceControlType": "Github",
"repositoryUrl": "https://github.com/Azure/azure-rest-api-specs",
"branch": "master",
"sourceControlAuthProperties": {
"tokenType": "PAT",
"token": "xxxxx"
}
},
"sourceTriggerEvents": [
"commit"
]
}
],
"baseImageTrigger": {
"name": "myBaseImageTrigger",
"status": "Enabled",
"baseImageTriggerType": "Runtime"
}
},
"credentials": {
"customRegistries": {
"myregistry.azure-test.io": {
"userName": {
"type": "Opaque",
"value": "username"
},
"password": {
"type": "Vaultsecret",
"value": "https://myacbvault.vault.azure.net/secrets/username"
},
"identity": "[system]"
}
},
"sourceRegistry": null
}
},
"location": "eastus",
"identity": {
"principalId": "fa153151-b9fd-46f4-9088-5e6600f2689v",
"tenantId": "f686d426-8d16-42db-81b7-abu4gm510ccd",
"type": "SystemAssigned"
},
"tags": {
"testkey": "value"
}
}
定義
Agent |
決定執行代理程式組態的屬性。 |
Architecture |
OS 架構。 |
Argument |
run 引數的屬性。 |
Auth |
用來存取原始程式碼存放庫的授權屬性。 |
Base |
描述基底映射相依性的屬性。 |
Base |
基底映射相依性的類型。 |
Base |
以基底映射相依性為基礎的觸發程式。 |
Base |
基底映射相依性更新的自動觸發程式類型。 |
Credentials |
參數,描述叫用執行時將使用的一組認證。 |
Custom |
描述將在執行期間用來存取自訂登錄的認證。 |
Docker |
Docker 建置步驟。 |
Encoded |
編碼工作步驟的屬性。 |
File |
工作步驟的屬性。 |
Identity |
資源的受控識別。 |
OS |
執行所需的作業系統類型。 |
Platform |
執行所針對的平臺屬性。 |
Provisioning |
執行的布建狀態。 |
Resource |
識別類型。 |
Secret |
描述秘密物件值的屬性。 |
Secret |
秘密物件的型別,決定秘密物件的值必須如何解譯。 |
Set |
可覆寫值的屬性,可傳遞至工作範本。 |
Source |
原始檔控制服務的類型。 |
Source |
原始程式碼存放庫的屬性。 |
Source |
描述用來存取來源登錄的認證參數。 |
Source |
決定來源登錄登入範圍的驗證模式。 來源登錄的認證將會使用指定的範圍產生。 這些認證會在執行期間用來登入來源登錄。 |
Source |
來源型觸發程式的屬性。 |
Task |
具有 ARM 資源和工作屬性的工作。 此工作將具有排程對其執行的所有資訊。 |
Task |
工作的目前狀態。 |
Timer |
計時器觸發程式的屬性。 |
Token |
驗證權杖的類型。 |
Trigger |
觸發程式的屬性。 |
Trigger |
觸發程式的目前狀態。 |
User |
|
Variant |
CPU 的變體。 |
AgentProperties
決定執行代理程式組態的屬性。
Name | Type | Description |
---|---|---|
cpu |
|
CPU 組態,以執行所需的核心數目來表示。 |
Architecture
OS 架構。
Name | Type | Description |
---|---|---|
amd64 |
|
|
arm |
|
|
x86 |
|
Argument
run 引數的屬性。
Name | Type | Default Value | Description |
---|---|---|---|
isSecret |
|
False |
旗標,指出引數是否代表秘密,而且想要從組建記錄中移除。 |
name |
|
引數的名稱。 |
|
value |
|
引數的值。 |
AuthInfo
用來存取原始程式碼存放庫的授權屬性。
Name | Type | Description |
---|---|---|
expiresIn |
|
權杖維持有效秒的時間 |
refreshToken |
|
用來重新整理存取權杖的重新整理權杖。 |
scope |
|
存取權杖的範圍。 |
token |
|
用來存取原始檔控制提供者的存取權杖。 |
tokenType |
驗證權杖的類型。 |
BaseImageDependency
描述基底映射相依性的屬性。
Name | Type | Description |
---|---|---|
digest |
|
映射資訊清單的 sha256 型摘要。 |
registry |
|
登錄登入伺服器。 |
repository |
|
存放庫名稱。 |
tag |
|
標記名稱。 |
type |
基底映射相依性的類型。 |
BaseImageDependencyType
基底映射相依性的類型。
Name | Type | Description |
---|---|---|
BuildTime |
|
|
RunTime |
|
BaseImageTrigger
以基底映射相依性為基礎的觸發程式。
Name | Type | Default Value | Description |
---|---|---|---|
baseImageTriggerType |
基底映射相依性更新的自動觸發程式類型。 |
||
name |
|
觸發程序的名稱。 |
|
status | Enabled |
觸發程式的目前狀態。 |
BaseImageTriggerType
基底映射相依性更新的自動觸發程式類型。
Name | Type | Description |
---|---|---|
All |
|
|
Runtime |
|
Credentials
參數,描述叫用執行時將使用的一組認證。
Name | Type | Description |
---|---|---|
customRegistries |
|
描述用來存取其他自訂登錄的認證參數。 字典專案的機碼會是登錄登入伺服器 (myregistry.azurecr.io) ,而專案的值將會是用來存取登錄的登錄認證。 |
sourceRegistry |
描述用來存取來源登錄的認證參數。 |
CustomRegistryCredentials
描述將在執行期間用來存取自訂登錄的認證。
Name | Type | Description |
---|---|---|
identity |
|
指出指派給自訂認證的受控識別。 如果使用者指派的身分識別,此值就是用戶端識別碼。 如果系統指派的身分識別,此值會是 |
password |
登入自訂登錄的密碼。 密碼是一種秘密物件,允許提供其值的多種方式。 |
|
userName |
登入自訂登錄的使用者名稱。 |
DockerBuildStep
Docker 建置步驟。
Name | Type | Default Value | Description |
---|---|---|---|
arguments |
|
執行這個建置步驟時要使用的覆寫引數集合。 |
|
baseImageDependencies |
步驟的基底映射相依性清單。 |
||
contextAccessToken |
|
與步驟內容相關聯的儲存體帳戶 Blob 的權杖 (git PAT 或 SAS 權杖) 。 |
|
contextPath |
|
URL (工作步驟來源內容的絕對或相對) 。 |
|
dockerFilePath |
|
相對於來源內容的 Docker 檔案路徑。 |
|
imageNames |
|
完整的映射名稱,包括存放庫和標記。 |
|
isPushEnabled |
|
True |
這個屬性的值表示是否應該將建置的映射推送至登錄。 |
noCache |
|
False |
這個屬性的值表示是否啟用映射快取。 |
target |
|
Docker 組建的目標建置階段名稱。 |
|
type |
string:
|
步驟的類型。 |
EncodedTaskStep
編碼工作步驟的屬性。
Name | Type | Description |
---|---|---|
baseImageDependencies |
步驟的基底映射相依性清單。 |
|
contextAccessToken |
|
與步驟內容相關聯的儲存體帳戶 Blob 的權杖 (git PAT 或 SAS 權杖) 。 |
contextPath |
|
URL (工作步驟來源內容的絕對或相對) 。 |
encodedTaskContent |
|
範本/定義檔案內容的 Base64 編碼值。 |
encodedValuesContent |
|
參數/值檔案內容的 Base64 編碼值。 |
type |
string:
|
步驟的類型。 |
values |
|
執行工作時可傳遞之可覆寫值的集合。 |
FileTaskStep
工作步驟的屬性。
Name | Type | Description |
---|---|---|
baseImageDependencies |
步驟的基底映射相依性清單。 |
|
contextAccessToken |
|
與步驟內容相關聯的儲存體帳戶 Blob 的權杖 (git PAT 或 SAS 權杖) 。 |
contextPath |
|
URL (工作步驟來源內容的絕對或相對) 。 |
taskFilePath |
|
相對於來源內容的工作範本/定義檔案路徑。 |
type |
string:
|
步驟的類型。 |
values |
|
執行工作時可傳遞之可覆寫值的集合。 |
valuesFilePath |
|
相對於來源內容的工作值/參數檔案路徑。 |
IdentityProperties
資源的受控識別。
Name | Type | Description |
---|---|---|
principalId |
|
資源識別的主要識別碼。 |
tenantId |
|
資源的租使用者識別碼。 |
type |
識別類型。 |
|
userAssignedIdentities |
|
與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源識別碼:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
OS
執行所需的作業系統類型。
Name | Type | Description |
---|---|---|
Linux |
|
|
Windows |
|
PlatformProperties
執行所針對的平臺屬性。
Name | Type | Description |
---|---|---|
architecture |
OS 架構。 |
|
os |
執行所需的作業系統類型。 |
|
variant |
CPU 的變體。 |
ProvisioningState
執行的布建狀態。
Name | Type | Description |
---|---|---|
Canceled |
|
|
Creating |
|
|
Deleting |
|
|
Failed |
|
|
Succeeded |
|
|
Updating |
|
ResourceIdentityType
識別類型。
Name | Type | Description |
---|---|---|
None |
|
|
SystemAssigned |
|
|
SystemAssigned, UserAssigned |
|
|
UserAssigned |
|
SecretObject
描述秘密物件值的屬性。
Name | Type | Description |
---|---|---|
type |
秘密物件的型別,決定秘密物件的值必須如何解譯。 |
|
value |
|
密碼的值。 此值的格式會根據秘密物件的類型來決定。 如果類型為不透明,則值會依原樣使用,而不需要進行任何修改。 |
SecretObjectType
秘密物件的型別,決定秘密物件的值必須如何解譯。
Name | Type | Description |
---|---|---|
Opaque |
|
|
Vaultsecret |
|
SetValue
可覆寫值的屬性,可傳遞至工作範本。
Name | Type | Default Value | Description |
---|---|---|---|
isSecret |
|
False |
指出值是否代表秘密的旗標。 |
name |
|
可覆寫值的名稱。 |
|
value |
|
可覆寫的值。 |
SourceControlType
原始檔控制服務的類型。
Name | Type | Description |
---|---|---|
Github |
|
|
VisualStudioTeamService |
|
SourceProperties
原始程式碼存放庫的屬性。
Name | Type | Description |
---|---|---|
branch |
|
原始程式碼的分支名稱。 |
repositoryUrl |
|
原始程式碼存放庫的完整 URL |
sourceControlAuthProperties |
用來存取原始程式碼存放庫的授權屬性,以及設定通知的 Webhook。 |
|
sourceControlType |
原始檔控制服務的類型。 |
SourceRegistryCredentials
描述用來存取來源登錄的認證參數。
Name | Type | Description |
---|---|---|
loginMode |
決定來源登錄登入範圍的驗證模式。 來源登錄的認證將會使用指定的範圍產生。 在執行期間,這些認證將用來登入來源登錄。 |
SourceRegistryLoginMode
決定來源登錄登入範圍的驗證模式。 來源登錄的認證將會使用指定的範圍產生。 這些認證會在執行期間用來登入來源登錄。
Name | Type | Description |
---|---|---|
Default |
|
|
None |
|
SourceTrigger
來源型觸發程式的屬性。
Name | Type | Default Value | Description |
---|---|---|---|
name |
|
觸發程序的名稱。 |
|
sourceRepository |
描述工作來源 (程式碼) 的屬性。 |
||
sourceTriggerEvents |
|
對應至觸發程式的來源事件。 |
|
status | Enabled |
觸發程式的目前狀態。 |
Task
具有 ARM 資源和工作屬性的工作。 此工作將具有排程對其執行的所有資訊。
Name | Type | Default Value | Description |
---|---|---|---|
id |
|
資源識別碼。 |
|
identity |
資源的身分識別。 |
||
location |
|
資源的位置。 建立資源之後,就無法變更此專案。 |
|
name |
|
資源名稱。 |
|
properties.agentConfiguration |
執行代理程式的機器組態。 |
||
properties.creationDate |
|
工作的建立日期。 |
|
properties.credentials |
屬性,描述叫用此執行時將使用的一組認證。 |
||
properties.platform |
執行所針對的平臺屬性。 |
||
properties.provisioningState |
工作的布建狀態。 |
||
properties.status |
工作的目前狀態。 |
||
properties.step | TaskStepProperties: |
工作步驟的屬性。 |
|
properties.timeout |
|
3600 |
以秒為單位執行逾時。 |
properties.trigger |
描述工作之所有觸發程式的屬性。 |
||
tags |
|
資源的標記。 |
|
type |
|
資源類型。 |
TaskStatus
工作的目前狀態。
Name | Type | Description |
---|---|---|
Disabled |
|
|
Enabled |
|
TimerTrigger
計時器觸發程式的屬性。
Name | Type | Default Value | Description |
---|---|---|---|
name |
|
觸發程序的名稱。 |
|
schedule |
|
工作排程的 CRON 運算式 |
|
status | Enabled |
觸發程式的目前狀態。 |
TokenType
驗證權杖的類型。
Name | Type | Description |
---|---|---|
OAuth |
|
|
PAT |
|
TriggerProperties
觸發程式的屬性。
Name | Type | Description |
---|---|---|
baseImageTrigger |
根據基底映射相依性的觸發程式。 |
|
sourceTriggers |
根據原始程式碼存放庫的觸發程式集合。 |
|
timerTriggers |
計時器觸發程式的集合。 |
TriggerStatus
觸發程式的目前狀態。
Name | Type | Description |
---|---|---|
Disabled |
|
|
Enabled |
|
UserIdentityProperties
Name | Type | Description |
---|---|---|
clientId |
|
使用者指派身分識別的用戶端識別碼。 |
principalId |
|
使用者指派身分識別的主體識別碼。 |
Variant
CPU 的變體。
Name | Type | Description |
---|---|---|
v6 |
|
|
v7 |
|
|
v8 |
|