Tasks - Get Details

Retourneert een taak met uitgebreide informatie die alle geheimen bevat.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{registryName}/tasks/{taskName}/listDetails?api-version=2019-04-01

URI-parameters

Name In Required Type Description
registryName
path True
  • string

De naam van het containerregister.

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

resourceGroupName
path True
  • string

De naam van de resourcegroep waar het containerregister bij hoort.

subscriptionId
path True
  • string

De Microsoft Azure-abonnements-id.

taskName
path True
  • string

De naam van de containerregistertaak.

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

api-version
query True
  • string

De client-API-versie.

Antwoorden

Name Type Description
200 OK

De aanvraag is geslaagd; de aanvraag is goed gevormd en correct ontvangen.

Other Status Codes

Foutbericht waarin wordt beschreven waarom de bewerking is mislukt. Als het register niet bestaat, wordt 404 (Niet gevonden) geretourneerd.

Beveiliging

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 uw gebruikersaccount imiteren

Voorbeelden

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"
  }
}

Definities

AgentProperties

De eigenschappen die de configuratie van de runagent bepalen.

Architecture

De architectuur van het besturingssysteem.

Argument

De eigenschappen van een run-argument.

AuthInfo

De autorisatie-eigenschappen voor toegang tot de broncodeopslagplaats.

BaseImageDependency

Eigenschappen die de afhankelijkheid van een basisafbeelding beschrijven.

BaseImageDependencyType

Het type afhankelijkheid van de basisafbeelding.

BaseImageTrigger

De trigger op basis van afhankelijkheid van basisafbeeldingen.

BaseImageTriggerType

Het type van de automatische trigger voor updates voor afhankelijkheid van basisafbeeldingen.

Credentials

De parameters die een set referenties beschrijven die worden gebruikt wanneer een run wordt aangeroepen.

CustomRegistryCredentials

Beschrijft de referenties die worden gebruikt voor toegang tot een aangepast register tijdens een run.

DockerBuildStep

De docker-build-stap.

EncodedTaskStep

De eigenschappen van een gecodeerde taakstap.

FileTaskStep

De eigenschappen van een taakstap.

IdentityProperties

Beheerde identiteit voor de resource.

OS

Het besturingssysteemtype dat is vereist voor de run.

PlatformProperties

De platformeigenschappen waarop de run moet plaatsvinden.

ProvisioningState

De inrichtingstoestand van een run.

ResourceIdentityType

Het identiteitstype.

SecretObject

Beschrijft de eigenschappen van een geheime objectwaarde.

SecretObjectType

Het type van het geheime object dat bepaalt hoe de waarde van het geheime object moet worden geïnterpreteerd.

SetValue

De eigenschappen van een overschrijvende waarde die kunnen worden doorgegeven aan een taaksjabloon.

SourceControlType

Het type broncodebeheerservice.

SourceProperties

De eigenschappen van de broncodeopslagplaats.

SourceRegistryCredentials

Beschrijft de referentieparameters voor toegang tot het bronregister.

SourceRegistryLoginMode

De verificatiemodus waarmee het aanmeldingsbereik van het bronregister wordt bepaald. De referenties voor het bronregister worden gegenereerd met behulp van het opgegeven bereik. Deze referenties worden tijdens de run gebruikt om u aan te melden bij het bronregister.

SourceTrigger

De eigenschappen van een trigger op basis van een bron.

Task

De taak die de eigenschappen van de ARM-resource en -taak heeft. De taak heeft alle informatie om een run op deze taak te plannen.

TaskStatus

De huidige status van de taak.

TimerTrigger

De eigenschappen van een timertrigger.

TokenType

Het type auth-token.

TriggerProperties

De eigenschappen van een trigger.

TriggerStatus

De huidige status van de trigger.

UserIdentityProperties
Variant

Variant van de CPU.

AgentProperties

De eigenschappen die de configuratie van de runagent bepalen.

Name Type Description
cpu
  • integer

De CPU-configuratie in termen van het aantal kernen dat is vereist voor de uitvoering.

Architecture

De architectuur van het besturingssysteem.

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

Argument

De eigenschappen van een run-argument.

Name Type Description
isSecret
  • boolean

Vlag om aan te geven of het argument een geheim vertegenwoordigt en uit buildlogboeken wilt worden verwijderd.

name
  • string

De naam van het argument.

value
  • string

De waarde van het argument .

AuthInfo

De autorisatie-eigenschappen voor toegang tot de broncodeopslagplaats.

Name Type Description
expiresIn
  • integer

Tijd in seconden dat het token geldig blijft

refreshToken
  • string

Het vernieuwings token dat wordt gebruikt om het toegangsken te vernieuwen.

scope
  • string

Het bereik van het toegangs token.

token
  • string

Het toegangs token dat wordt gebruikt voor toegang tot de broncodebeheerprovider.

tokenType

Het type auth-token.

BaseImageDependency

Eigenschappen die de afhankelijkheid van een basisafbeelding beschrijven.

Name Type Description
digest
  • string

De sha256-samenvatting van het afbeeldingsmanifest.

registry
  • string

De aanmeldingsserver voor het register.

repository
  • string

De naam van de opslagplaats.

tag
  • string

De tagnaam.

type

Het type afhankelijkheid van de basisafbeelding.

BaseImageDependencyType

Het type afhankelijkheid van de basisafbeelding.

Name Type Description
BuildTime
  • string
RunTime
  • string

BaseImageTrigger

De trigger op basis van afhankelijkheid van basisafbeeldingen.

Name Type Description
baseImageTriggerType

Het type van de automatische trigger voor updates voor afhankelijkheid van basisafbeeldingen.

name
  • string

De naam van de trigger.

status

De huidige status van de trigger.

BaseImageTriggerType

Het type van de automatische trigger voor updates voor afhankelijkheid van basisafbeeldingen.

Name Type Description
All
  • string
Runtime
  • string

Credentials

De parameters die een set referenties beschrijven die worden gebruikt wanneer een run wordt aangeroepen.

Name Type Description
customRegistries

Beschrijft de referentieparameters voor toegang tot andere aangepaste registers. De sleutel voor het woordenlijstitem is de register-aanmeldingsserver (myregistry.azurecr.io) en de waarde van het item zijn de registerreferenties voor toegang tot het register.

sourceRegistry

Beschrijft de referentieparameters voor toegang tot het bronregister.

CustomRegistryCredentials

Beschrijft de referenties die worden gebruikt voor toegang tot een aangepast register tijdens een run.

Name Type Description
identity
  • string

Geeft de beheerde identiteit aan die is toegewezen aan de aangepaste referentie. Als een door de gebruiker toegewezen identiteit deze waarde de client-id is. Als een door het systeem toegewezen identiteit de waarde system is. In het geval van een door het systeem toegewezen identiteit wordt de client-id bepaald door de runner. Deze identiteit kan worden gebruikt voor verificatie bij de sleutelkluis om referenties op te halen of kan de enige verificatiebron zijn die wordt gebruikt voor toegang tot het register.

password

Het wachtwoord voor het aanmelden bij het aangepaste register. Het wachtwoord is een geheim object waarmee u op meerdere manieren de waarde voor het wachtwoord kunt opgeven.

userName

De gebruikersnaam voor het aanmelden bij het aangepaste register.

DockerBuildStep

De docker-build-stap.

Name Type Description
arguments

De verzameling overschrijvenargumenten die moeten worden gebruikt bij het uitvoeren van deze buildstap.

baseImageDependencies

Lijst met basisafbeeldingsafhankelijkheden voor een stap.

contextAccessToken
  • string

Het token (git PAT of SAS-token van de blob van het opslagaccount) dat is gekoppeld aan de context voor een stap.

contextPath
  • string

De URL (absoluut of relatief) van de broncontext voor de taakstap.

dockerFilePath
  • string

Het Pad naar het Docker-bestand ten opzichte van de broncontext.

imageNames
  • string[]

De volledig gekwalificeerde namen van de afbeeldingen, inclusief de opslagplaats en de tag.

isPushEnabled
  • boolean

De waarde van deze eigenschap geeft aan of de gebouwde afbeelding al dan niet naar het register moet worden pushen.

noCache
  • boolean

De waarde van deze eigenschap geeft aan of de cache van de afbeelding is ingeschakeld of niet.

target
  • string

De naam van de doel-buildfase voor de docker-build.

type string:
  • Docker

Het type van de stap.

EncodedTaskStep

De eigenschappen van een gecodeerde taakstap.

Name Type Description
baseImageDependencies

Lijst met basisafbeeldingsafhankelijkheden voor een stap.

contextAccessToken
  • string

Het token (git PAT of SAS-token van de blob van het opslagaccount) dat is gekoppeld aan de context voor een stap.

contextPath
  • string

De URL (absoluut of relatief) van de broncontext voor de taakstap.

encodedTaskContent
  • string

Base64-gecodeerde waarde van de inhoud van het sjabloon-/definitiebestand.

encodedValuesContent
  • string

Base64-gecodeerde waarde van de bestandsinhoud parameters/waarden.

type string:
  • EncodedTask

Het type van de stap.

values

De verzameling overschrijvende waarden die kunnen worden doorgegeven bij het uitvoeren van een taak.

FileTaskStep

De eigenschappen van een taakstap.

Name Type Description
baseImageDependencies

Lijst met basisafbeeldingsafhankelijkheden voor een stap.

contextAccessToken
  • string

Het token (git PAT of SAS-token van de blob van het opslagaccount) dat is gekoppeld aan de context voor een stap.

contextPath
  • string

De URL (absoluut of relatief) van de broncontext voor de taakstap.

taskFilePath
  • string

Het pad naar het taaksjabloon-/definitiebestand ten opzichte van de broncontext.

type string:
  • FileTask

Het type van de stap.

values

De verzameling overschrijvende waarden die kunnen worden doorgegeven bij het uitvoeren van een taak.

valuesFilePath
  • string

Het bestandspad van de taakwaarden/parameters ten opzichte van de broncontext.

IdentityProperties

Beheerde identiteit voor de resource.

Name Type Description
principalId
  • string

De principal-id van de resource-id.

tenantId
  • string

De tenant-id van de resource.

type

Het identiteitstype.

userAssignedIdentities

De lijst met gebruikersidentiteiten die aan de resource zijn gekoppeld. De sleutelverwijzingen in de woordenlijst met gebruikersidentiteiten zijn ARM-resource-id's in de vorm: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

OS

Het besturingssysteemtype dat is vereist voor de run.

Name Type Description
Linux
  • string
Windows
  • string

PlatformProperties

De platformeigenschappen waarop de run moet plaatsvinden.

Name Type Description
architecture

De architectuur van het besturingssysteem.

os

Het besturingssysteemtype dat is vereist voor de run.

variant

Variant van de CPU.

ProvisioningState

De inrichtingstoestand van een run.

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

ResourceIdentityType

Het identiteitstype.

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

SecretObject

Beschrijft de eigenschappen van een geheime objectwaarde.

Name Type Description
type

Het type van het geheime object dat bepaalt hoe de waarde van het geheime object moet worden geïnterpreteerd.

value
  • string

De waarde van het geheim. De indeling van deze waarde wordt bepaald op basis van het type van het geheime object. Als het type Ondoorzichtig is, wordt de waarde zonder enige wijziging gebruikt.

SecretObjectType

Het type van het geheime object dat bepaalt hoe de waarde van het geheime object moet worden geïnterpreteerd.

Name Type Description
Opaque
  • string
Vaultsecret
  • string

SetValue

De eigenschappen van een overschrijvende waarde die kunnen worden doorgegeven aan een taaksjabloon.

Name Type Description
isSecret
  • boolean

Vlag om aan te geven of de waarde een geheim vertegenwoordigt of niet.

name
  • string

De naam van de overschrijvende waarde.

value
  • string

De overschrijvende waarde.

SourceControlType

Het type broncodebeheerservice.

Name Type Description
Github
  • string
VisualStudioTeamService
  • string

SourceProperties

De eigenschappen van de broncodeopslagplaats.

Name Type Description
branch
  • string

De vertakkingsnaam van de broncode.

repositoryUrl
  • string

De volledige URL naar de opslagplaats voor de broncode

sourceControlAuthProperties

De autorisatie-eigenschappen voor toegang tot de broncodeopslagplaats en voor het instellen van webhooks voor meldingen.

sourceControlType

Het type broncodebeheerservice.

SourceRegistryCredentials

Beschrijft de referentieparameters voor toegang tot het bronregister.

Name Type Description
loginMode

De verificatiemodus waarmee het aanmeldingsbereik van het bronregister wordt bepaald. De referenties voor het bronregister worden gegenereerd met behulp van het opgegeven bereik. Deze referenties worden tijdens de run gebruikt om u aan te melden bij het bronregister.

SourceRegistryLoginMode

De verificatiemodus waarmee het aanmeldingsbereik van het bronregister wordt bepaald. De referenties voor het bronregister worden gegenereerd met behulp van het opgegeven bereik. Deze referenties worden tijdens de run gebruikt om u aan te melden bij het bronregister.

Name Type Description
Default
  • string
None
  • string

SourceTrigger

De eigenschappen van een trigger op basis van een bron.

Name Type Description
name
  • string

De naam van de trigger.

sourceRepository

De eigenschappen die de bron(code) voor de taak beschrijven.

sourceTriggerEvents
  • string[]

De brongebeurtenis die overeenkomt met de trigger.

status

De huidige status van de trigger.

Task

De taak die de eigenschappen van de ARM-resource en -taak heeft. De taak heeft alle informatie om een run op deze taak te plannen.

Name Type Description
id
  • string

De resource-id.

identity

Identiteit voor de resource.

location
  • string

De locatie van de resource. Dit kan niet worden gewijzigd nadat de resource is gemaakt.

name
  • string

De naam van de resource.

properties.agentConfiguration

De computerconfiguratie van de runagent.

properties.creationDate
  • string

De aanmaakdatum van de taak.

properties.credentials

De eigenschappen die een set referenties beschrijven die worden gebruikt wanneer deze run wordt aangeroepen.

properties.platform

De platformeigenschappen waarop de run moet plaatsvinden.

properties.provisioningState

De inrichtingstoestand van de taak.

properties.status

De huidige status van de taak.

properties.step TaskStepProperties:

De eigenschappen van een taakstap.

properties.timeout
  • integer

Time-out van run in seconden.

properties.trigger

De eigenschappen die alle triggers voor de taak beschrijven.

tags
  • object

De tags van de resource.

type
  • string

Het type resource.

TaskStatus

De huidige status van de taak.

Name Type Description
Disabled
  • string
Enabled
  • string

TimerTrigger

De eigenschappen van een timertrigger.

Name Type Description
name
  • string

De naam van de trigger.

schedule
  • string

De CRON-expressie voor het taakschema

status

De huidige status van de trigger.

TokenType

Het type auth-token.

Name Type Description
OAuth
  • string
PAT
  • string

TriggerProperties

De eigenschappen van een trigger.

Name Type Description
baseImageTrigger

De trigger op basis van afhankelijkheden van basisafbeeldingen.

sourceTriggers

De verzameling triggers op basis van de broncodeopslagplaats.

timerTriggers

De verzameling timertriggers.

TriggerStatus

De huidige status van de trigger.

Name Type Description
Disabled
  • string
Enabled
  • string

UserIdentityProperties

Name Type Description
clientId
  • string

De client-id van de door de gebruiker toegewezen identiteit.

principalId
  • string

De principal-id van de door de gebruiker toegewezen identiteit.

Variant

Variant van de CPU.

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