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
registryName
path True
  • string

容器登錄的名稱。

Regex pattern: ^[a-zA-Z0-9]*$

resourceGroupName
path True
  • string

容器登錄所屬的資源群組名稱。

subscriptionId
path True
  • string

Microsoft Azure訂用帳戶識別碼。

taskName
path True
  • string

容器登錄工作的名稱。

Regex pattern: ^[a-zA-Z0-9-_]*$

api-version
query True
  • string

用戶端 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"
  }
}

定義

AgentProperties

決定執行代理程式組態的屬性。

Architecture

OS 架構。

Argument

run 引數的屬性。

AuthInfo

用來存取原始程式碼存放庫的授權屬性。

BaseImageDependency

描述基底映射相依性的屬性。

BaseImageDependencyType

基底映射相依性的類型。

BaseImageTrigger

以基底映射相依性為基礎的觸發程式。

BaseImageTriggerType

基底映射相依性更新的自動觸發程式類型。

Credentials

參數,描述叫用執行時將使用的一組認證。

CustomRegistryCredentials

描述將在執行期間用來存取自訂登錄的認證。

DockerBuildStep

Docker 建置步驟。

EncodedTaskStep

編碼工作步驟的屬性。

FileTaskStep

工作步驟的屬性。

IdentityProperties

資源的受控識別。

OS

執行所需的作業系統類型。

PlatformProperties

執行所針對的平臺屬性。

ProvisioningState

執行的布建狀態。

ResourceIdentityType

識別類型。

SecretObject

描述秘密物件值的屬性。

SecretObjectType

秘密物件的型別,決定秘密物件的值必須如何解譯。

SetValue

可覆寫值的屬性,可傳遞至工作範本。

SourceControlType

原始檔控制服務的類型。

SourceProperties

原始程式碼存放庫的屬性。

SourceRegistryCredentials

描述用來存取來源登錄的認證參數。

SourceRegistryLoginMode

決定來源登錄登入範圍的驗證模式。 來源登錄的認證將會使用指定的範圍產生。 這些認證會在執行期間用來登入來源登錄。

SourceTrigger

來源型觸發程式的屬性。

Task

具有 ARM 資源和工作屬性的工作。 此工作將具有排程對其執行的所有資訊。

TaskStatus

工作的目前狀態。

TimerTrigger

計時器觸發程式的屬性。

TokenType

驗證權杖的類型。

TriggerProperties

觸發程式的屬性。

TriggerStatus

觸發程式的目前狀態。

UserIdentityProperties
Variant

CPU 的變體。

AgentProperties

決定執行代理程式組態的屬性。

Name Type Description
cpu
  • integer

CPU 組態,以執行所需的核心數目來表示。

Architecture

OS 架構。

Name Type Description
amd64
  • string
arm
  • string
x86
  • string

Argument

run 引數的屬性。

Name Type Default Value Description
isSecret
  • boolean
False

旗標,指出引數是否代表秘密,而且想要從組建記錄中移除。

name
  • string

引數的名稱。

value
  • string

引數的值。

AuthInfo

用來存取原始程式碼存放庫的授權屬性。

Name Type Description
expiresIn
  • integer

權杖維持有效秒的時間

refreshToken
  • string

用來重新整理存取權杖的重新整理權杖。

scope
  • string

存取權杖的範圍。

token
  • string

用來存取原始檔控制提供者的存取權杖。

tokenType

驗證權杖的類型。

BaseImageDependency

描述基底映射相依性的屬性。

Name Type Description
digest
  • string

映射資訊清單的 sha256 型摘要。

registry
  • string

登錄登入伺服器。

repository
  • string

存放庫名稱。

tag
  • string

標記名稱。

type

基底映射相依性的類型。

BaseImageDependencyType

基底映射相依性的類型。

Name Type Description
BuildTime
  • string
RunTime
  • string

BaseImageTrigger

以基底映射相依性為基礎的觸發程式。

Name Type Default Value Description
baseImageTriggerType

基底映射相依性更新的自動觸發程式類型。

name
  • string

觸發程序的名稱。

status Enabled

觸發程式的目前狀態。

BaseImageTriggerType

基底映射相依性更新的自動觸發程式類型。

Name Type Description
All
  • string
Runtime
  • string

Credentials

參數,描述叫用執行時將使用的一組認證。

Name Type Description
customRegistries

描述用來存取其他自訂登錄的認證參數。 字典專案的機碼會是登錄登入伺服器 (myregistry.azurecr.io) ,而專案的值將會是用來存取登錄的登錄認證。

sourceRegistry

描述用來存取來源登錄的認證參數。

CustomRegistryCredentials

描述將在執行期間用來存取自訂登錄的認證。

Name Type Description
identity
  • string

指出指派給自訂認證的受控識別。 如果使用者指派的身分識別,此值就是用戶端識別碼。 如果系統指派的身分識別,此值會是 system 。 如果是系統指派的身分識別,用戶端識別碼將由執行器決定。 此身分識別可用來向金鑰保存庫進行驗證以擷取認證,或可能是用來存取登錄的唯一驗證來源。

password

登入自訂登錄的密碼。 密碼是一種秘密物件,允許提供其值的多種方式。

userName

登入自訂登錄的使用者名稱。

DockerBuildStep

Docker 建置步驟。

Name Type Default Value Description
arguments

執行這個建置步驟時要使用的覆寫引數集合。

baseImageDependencies

步驟的基底映射相依性清單。

contextAccessToken
  • string

與步驟內容相關聯的儲存體帳戶 Blob 的權杖 (git PAT 或 SAS 權杖) 。

contextPath
  • string

URL (工作步驟來源內容的絕對或相對) 。

dockerFilePath
  • string

相對於來源內容的 Docker 檔案路徑。

imageNames
  • string[]

完整的映射名稱,包括存放庫和標記。

isPushEnabled
  • boolean
True

這個屬性的值表示是否應該將建置的映射推送至登錄。

noCache
  • boolean
False

這個屬性的值表示是否啟用映射快取。

target
  • string

Docker 組建的目標建置階段名稱。

type string:
  • Docker

步驟的類型。

EncodedTaskStep

編碼工作步驟的屬性。

Name Type Description
baseImageDependencies

步驟的基底映射相依性清單。

contextAccessToken
  • string

與步驟內容相關聯的儲存體帳戶 Blob 的權杖 (git PAT 或 SAS 權杖) 。

contextPath
  • string

URL (工作步驟來源內容的絕對或相對) 。

encodedTaskContent
  • string

範本/定義檔案內容的 Base64 編碼值。

encodedValuesContent
  • string

參數/值檔案內容的 Base64 編碼值。

type string:
  • EncodedTask

步驟的類型。

values

執行工作時可傳遞之可覆寫值的集合。

FileTaskStep

工作步驟的屬性。

Name Type Description
baseImageDependencies

步驟的基底映射相依性清單。

contextAccessToken
  • string

與步驟內容相關聯的儲存體帳戶 Blob 的權杖 (git PAT 或 SAS 權杖) 。

contextPath
  • string

URL (工作步驟來源內容的絕對或相對) 。

taskFilePath
  • string

相對於來源內容的工作範本/定義檔案路徑。

type string:
  • FileTask

步驟的類型。

values

執行工作時可傳遞之可覆寫值的集合。

valuesFilePath
  • string

相對於來源內容的工作值/參數檔案路徑。

IdentityProperties

資源的受控識別。

Name Type Description
principalId
  • string

資源識別的主要識別碼。

tenantId
  • string

資源的租使用者識別碼。

type

識別類型。

userAssignedIdentities

與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源識別碼:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。

OS

執行所需的作業系統類型。

Name Type Description
Linux
  • string
Windows
  • string

PlatformProperties

執行所針對的平臺屬性。

Name Type Description
architecture

OS 架構。

os

執行所需的作業系統類型。

variant

CPU 的變體。

ProvisioningState

執行的布建狀態。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

ResourceIdentityType

識別類型。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

SecretObject

描述秘密物件值的屬性。

Name Type Description
type

秘密物件的型別,決定秘密物件的值必須如何解譯。

value
  • string

密碼的值。 此值的格式會根據秘密物件的類型來決定。 如果類型為不透明,則值會依原樣使用,而不需要進行任何修改。

SecretObjectType

秘密物件的型別,決定秘密物件的值必須如何解譯。

Name Type Description
Opaque
  • string
Vaultsecret
  • string

SetValue

可覆寫值的屬性,可傳遞至工作範本。

Name Type Default Value Description
isSecret
  • boolean
False

指出值是否代表秘密的旗標。

name
  • string

可覆寫值的名稱。

value
  • string

可覆寫的值。

SourceControlType

原始檔控制服務的類型。

Name Type Description
Github
  • string
VisualStudioTeamService
  • string

SourceProperties

原始程式碼存放庫的屬性。

Name Type Description
branch
  • string

原始程式碼的分支名稱。

repositoryUrl
  • string

原始程式碼存放庫的完整 URL

sourceControlAuthProperties

用來存取原始程式碼存放庫的授權屬性,以及設定通知的 Webhook。

sourceControlType

原始檔控制服務的類型。

SourceRegistryCredentials

描述用來存取來源登錄的認證參數。

Name Type Description
loginMode

決定來源登錄登入範圍的驗證模式。 來源登錄的認證將會使用指定的範圍產生。 在執行期間,這些認證將用來登入來源登錄。

SourceRegistryLoginMode

決定來源登錄登入範圍的驗證模式。 來源登錄的認證將會使用指定的範圍產生。 這些認證會在執行期間用來登入來源登錄。

Name Type Description
Default
  • string
None
  • string

SourceTrigger

來源型觸發程式的屬性。

Name Type Default Value Description
name
  • string

觸發程序的名稱。

sourceRepository

描述工作來源 (程式碼) 的屬性。

sourceTriggerEvents
  • string[]

對應至觸發程式的來源事件。

status Enabled

觸發程式的目前狀態。

Task

具有 ARM 資源和工作屬性的工作。 此工作將具有排程對其執行的所有資訊。

Name Type Default Value Description
id
  • string

資源識別碼。

identity

資源的身分識別。

location
  • string

資源的位置。 建立資源之後,就無法變更此專案。

name
  • string

資源名稱。

properties.agentConfiguration

執行代理程式的機器組態。

properties.creationDate
  • string

工作的建立日期。

properties.credentials

屬性,描述叫用此執行時將使用的一組認證。

properties.platform

執行所針對的平臺屬性。

properties.provisioningState

工作的布建狀態。

properties.status

工作的目前狀態。

properties.step TaskStepProperties:

工作步驟的屬性。

properties.timeout
  • integer
3600

以秒為單位執行逾時。

properties.trigger

描述工作之所有觸發程式的屬性。

tags
  • object

資源的標記。

type
  • string

資源類型。

TaskStatus

工作的目前狀態。

Name Type Description
Disabled
  • string
Enabled
  • string

TimerTrigger

計時器觸發程式的屬性。

Name Type Default Value Description
name
  • string

觸發程序的名稱。

schedule
  • string

工作排程的 CRON 運算式

status Enabled

觸發程式的目前狀態。

TokenType

驗證權杖的類型。

Name Type Description
OAuth
  • string
PAT
  • string

TriggerProperties

觸發程式的屬性。

Name Type Description
baseImageTrigger

根據基底映射相依性的觸發程式。

sourceTriggers

根據原始程式碼存放庫的觸發程式集合。

timerTriggers

計時器觸發程式的集合。

TriggerStatus

觸發程式的目前狀態。

Name Type Description
Disabled
  • string
Enabled
  • string

UserIdentityProperties

Name Type Description
clientId
  • string

使用者指派身分識別的用戶端識別碼。

principalId
  • string

使用者指派身分識別的主體識別碼。

Variant

CPU 的變體。

Name Type Description
v6
  • string
v7
  • string
v8
  • string