Tasks - Get Details

Referens

Tjänst:: Container Registry

API-version:: 2019-04-01

Returnerar en uppgift med utökad information som innehåller alla hemligheter.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Namnet på containerregistret.
resourceGroupName	path	True	string minLength: 1	Namnet på resursgruppen som containerregistret tillhör.
subscriptionId	path	True	string	Prenumerations-ID för Microsoft Azure.
taskName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9-_]*$	Namnet på containerregisteraktiviteten.
api-version	query	True	string	Klient-API-versionen.

Svar

Name	Typ	Description
200 OK	Task	Begäran lyckades. begäran var väl utformad och mottogs korrekt.
Other Status Codes		Felsvar som beskriver varför åtgärden misslyckades. Om registret inte finns returneras 404 (hittades inte).

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Tasks_GetDetails

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
AgentProperties	De egenskaper som avgör körningsagentkonfigurationen.
Architecture	OS-arkitekturen.
Argument	Egenskaperna för ett körningsargument.
AuthInfo	Auktoriseringsegenskaperna för åtkomst till källkodslagringsplatsen.
BaseImageDependency	Egenskaper som beskriver ett basavbildningsberoende.
BaseImageDependencyType	Typen av basavbildningsberoende.
BaseImageTrigger	Utlösaren baserat på basavbildningsberoende.
BaseImageTriggerType	Typ av automatisk utlösare för uppdateringar av basavbildningsberoende.
Credentials	Parametrarna som beskriver en uppsättning autentiseringsuppgifter som ska användas när en körning anropas.
CustomRegistryCredentials	Beskriver de autentiseringsuppgifter som ska användas för att komma åt ett anpassat register under en körning.
DockerBuildStep	Docker-byggsteget.
EncodedTaskStep	Egenskaperna för ett kodat aktivitetssteg.
FileTaskStep	Egenskaperna för ett aktivitetssteg.
IdentityProperties	Hanterad identitet för resursen.
OS	Den operativsystemtyp som krävs för körningen.
PlatformProperties	De plattformsegenskaper som körningen måste ske mot.
ProvisioningState	Etableringstillståndet för en körning.
ResourceIdentityType	Identitetstypen.
SecretObject	Beskriver egenskaperna för ett hemligt objektvärde.
SecretObjectType	Typen av det hemliga objektet som avgör hur värdet för det hemliga objektet måste tolkas.
SetValue	Egenskaperna för ett åsidosättbart värde som kan skickas till en uppgiftsmall.
SourceControlType	Typ av källkontrolltjänst.
SourceProperties	Egenskaperna för källkodslagringsplatsen.
SourceRegistryCredentials	Beskriver parametrarna för autentiseringsuppgifter för åtkomst till källregistret.
SourceRegistryLoginMode	Autentiseringsläget som avgör källregistrets inloggningsomfång. Autentiseringsuppgifterna för källregistret genereras med det angivna omfånget. Dessa autentiseringsuppgifter används för att logga in på källregistret under körningen.
SourceTrigger	Egenskaperna för en källbaserad utlösare.
SourceTriggerEvent	Källhändelsen som motsvarar utlösaren.
Task	Den uppgift som har ARM-resursen och uppgiftsegenskaperna. Uppgiften har all information för att schemalägga en körning mot den.
TaskStatus	Aktivitetens aktuella status.
TimerTrigger	Egenskaperna för en timerutlösare.
TokenType	Typ av autentiseringstoken.
TriggerProperties	Egenskaperna för en utlösare.
TriggerStatus	Utlösarens aktuella status.
UserIdentityProperties
Variant	Variant av processorn.

AgentProperties

Objekt

De egenskaper som avgör körningsagentkonfigurationen.

Name	Typ	Description
cpu	integer (int32)	Cpu-konfigurationen när det gäller antalet kärnor som krävs för körningen.

Architecture

Uppräkning

OS-arkitekturen.

Värde	Description
amd64
arm
x86

Argument

Objekt

Egenskaperna för ett körningsargument.

Name	Typ	Standardvärde	Description
isSecret	boolean	False	Flagga för att ange om argumentet representerar en hemlighet och vill tas bort från byggloggarna.
name	string		Namnet på argumentet.
value	string		Argumentets värde.

AuthInfo

Objekt

Auktoriseringsegenskaperna för åtkomst till källkodslagringsplatsen.

Name	Typ	Description
expiresIn	integer (int32)	Tid i sekunder som token förblir giltig
refreshToken	string	Uppdateringstoken som används för att uppdatera åtkomsttoken.
scope	string	Omfånget för åtkomsttoken.
token	string	Åtkomsttoken som används för att komma åt källkontrollprovidern.
tokenType	TokenType	Typ av autentiseringstoken.

BaseImageDependency

Objekt

Egenskaper som beskriver ett basavbildningsberoende.

Name	Typ	Description
digest	string	Den sha256-baserade sammanfattningen av bildmanifestet.
registry	string	Registerinloggningsservern.
repository	string	Lagringsplatsens namn.
tag	string	Taggnamnet.
type	BaseImageDependencyType	Typen av basavbildningsberoende.

BaseImageDependencyType

Uppräkning

Typen av basavbildningsberoende.

Värde	Description
BuildTime
RunTime

BaseImageTrigger

Objekt

Utlösaren baserat på basavbildningsberoende.

Name	Typ	Standardvärde	Description
baseImageTriggerType	BaseImageTriggerType		Typ av automatisk utlösare för uppdateringar av basavbildningsberoende.
name	string		Namnet på utlösaren.
status	TriggerStatus	Enabled	Utlösarens aktuella status.

BaseImageTriggerType

Uppräkning

Typ av automatisk utlösare för uppdateringar av basavbildningsberoende.

Värde	Description
All
Runtime

Credentials

Objekt

Parametrarna som beskriver en uppsättning autentiseringsuppgifter som ska användas när en körning anropas.

Name	Typ	Description
customRegistries	<string, CustomRegistryCredentials>	Beskriver parametrarna för autentiseringsuppgifter för åtkomst till andra anpassade register. Nyckeln för ordlisteobjektet är registerinloggningsservern (myregistry.azurecr.io) och objektets värde är registerautentiseringsuppgifterna för åtkomst till registret.
sourceRegistry	SourceRegistryCredentials	Beskriver parametrarna för autentiseringsuppgifter för åtkomst till källregistret.

CustomRegistryCredentials

Objekt

Beskriver de autentiseringsuppgifter som ska användas för att komma åt ett anpassat register under en körning.

Name	Typ	Description
identity	string	Anger den hanterade identitet som tilldelats till den anpassade autentiseringsuppgiften. Om en användartilldelad identitet är det här värdet klient-ID:t. Om en systemtilldelad identitet blir värdet `system`. När det gäller en systemtilldelad identitet bestäms klient-ID:t av löparen. Den här identiteten kan användas för att autentisera till nyckelvalvet för att hämta autentiseringsuppgifter, eller så kan den vara den enda autentiseringskällan som används för åtkomst till registret.
password	SecretObject	Lösenordet för att logga in i det anpassade registret. Lösenordet är ett hemligt objekt som tillåter flera sätt att ange värdet för det.
userName	SecretObject	Användarnamnet för att logga in i det anpassade registret.

DockerBuildStep

Objekt

Docker-byggsteget.

Name	Typ	Standardvärde	Description
arguments	Argument[]		Samlingen med åsidosättningsargument som ska användas när du kör det här byggsteget.
baseImageDependencies	BaseImageDependency[]		Lista över basavbildningsberoenden för ett steg.
contextAccessToken	string		Token (git PAT eller SAS-token för lagringskontoblob) som är associerad med kontexten för ett steg.
contextPath	string		URL:en (absolut eller relativ) för källkontexten för aktivitetssteget.
dockerFilePath	string		Docker-filsökvägen i förhållande till källkontexten.
imageNames	string[]		De fullständigt kvalificerade avbildningsnamnen, inklusive lagringsplatsen och taggen.
isPushEnabled	boolean	True	Värdet för den här egenskapen anger om avbildningen som skapats ska push-överföras till registret eller inte.
noCache	boolean	False	Värdet för den här egenskapen anger om avbildningscachen är aktiverad eller inte.
target	string		Namnet på målversionssteget för docker-versionen.
type	string: Docker		Typ av steg.

EncodedTaskStep

Objekt

Egenskaperna för ett kodat aktivitetssteg.

Name	Typ	Description
baseImageDependencies	BaseImageDependency[]	Lista över basavbildningsberoenden för ett steg.
contextAccessToken	string	Token (git PAT eller SAS-token för lagringskontoblob) som är associerad med kontexten för ett steg.
contextPath	string	URL:en (absolut eller relativ) för källkontexten för aktivitetssteget.
encodedTaskContent	string	Base64-kodat värde för mall-/definitionsfilinnehållet.
encodedValuesContent	string	Base64-kodat värde för filinnehållet parametrar/värden.
type	string: EncodedTask	Typ av steg.
values	SetValue[]	Samlingen med åsidosättbara värden som kan skickas när en uppgift körs.

FileTaskStep

Objekt

Egenskaperna för ett aktivitetssteg.

Name	Typ	Description
baseImageDependencies	BaseImageDependency[]	Lista över basavbildningsberoenden för ett steg.
contextAccessToken	string	Token (git PAT eller SAS-token för lagringskontoblob) som är associerad med kontexten för ett steg.
contextPath	string	URL:en (absolut eller relativ) för källkontexten för aktivitetssteget.
taskFilePath	string	Sökvägen för aktivitetsmallen/definitionsfilen i förhållande till källkontexten.
type	string: FileTask	Typ av steg.
values	SetValue[]	Samlingen med åsidosättbara värden som kan skickas när en uppgift körs.
valuesFilePath	string	Filsökvägen för aktivitetsvärden/parametrar i förhållande till källkontexten.

IdentityProperties

Objekt

Hanterad identitet för resursen.

Name	Typ	Description
principalId	string	Huvud-ID för resursidentitet.
tenantId	string	Resursens klientorganisations-ID.
type	ResourceIdentityType	Identitetstypen.
userAssignedIdentities	<string, UserIdentityProperties>	Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

OS

Uppräkning

Den operativsystemtyp som krävs för körningen.

Värde	Description
Linux
Windows

PlatformProperties

Objekt

De plattformsegenskaper som körningen måste ske mot.

Name	Typ	Description
architecture	Architecture	OS-arkitekturen.
os	OS	Den operativsystemtyp som krävs för körningen.
variant	Variant	Variant av processorn.

ProvisioningState

Uppräkning

Etableringstillståndet för en körning.

Värde	Description
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

Uppräkning

Identitetstypen.

Värde	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SecretObject

Objekt

Beskriver egenskaperna för ett hemligt objektvärde.

Name	Typ	Description
type	SecretObjectType	Typen av det hemliga objektet som avgör hur värdet för det hemliga objektet måste tolkas.
value	string	Hemlighetens värde. Formatet för det här värdet bestäms baserat på typen av det hemliga objektet. Om typen är Ogenomskinlig används värdet som det är utan någon ändring.

SecretObjectType

Uppräkning

Typen av det hemliga objektet som avgör hur värdet för det hemliga objektet måste tolkas.

Värde	Description
Opaque
Vaultsecret

SetValue

Objekt

Egenskaperna för ett åsidosättbart värde som kan skickas till en uppgiftsmall.

Name	Typ	Standardvärde	Description
isSecret	boolean	False	Flagga för att ange om värdet representerar en hemlighet eller inte.
name	string		Namnet på det åsidosättande värdet.
value	string		Det övergripande värdet.

SourceControlType

Uppräkning

Typ av källkontrolltjänst.

Värde	Description
Github
VisualStudioTeamService

SourceProperties

Objekt

Egenskaperna för källkodslagringsplatsen.

Name	Typ	Description
branch	string	Källkodens grennamn.
repositoryUrl	string	Den fullständiga URL:en till källkodslagringsplatsen
sourceControlAuthProperties	AuthInfo	Auktoriseringsegenskaperna för åtkomst till källkodslagringsplatsen och för att konfigurera webhooks för meddelanden.
sourceControlType	SourceControlType	Typ av källkontrolltjänst.

SourceRegistryCredentials

Objekt

Beskriver parametrarna för autentiseringsuppgifter för åtkomst till källregistret.

Name	Typ	Description
loginMode	SourceRegistryLoginMode	Autentiseringsläget som avgör källregistrets inloggningsomfång. Autentiseringsuppgifterna för källregistret genereras med det angivna omfånget. Dessa autentiseringsuppgifter används för att logga in på källregistret under körningen.

SourceRegistryLoginMode

Uppräkning

Autentiseringsläget som avgör källregistrets inloggningsomfång. Autentiseringsuppgifterna för källregistret genereras med det angivna omfånget. Dessa autentiseringsuppgifter används för att logga in på källregistret under körningen.

Värde	Description
Default
None

SourceTrigger

Objekt

Egenskaperna för en källbaserad utlösare.

Name	Typ	Standardvärde	Description
name	string		Namnet på utlösaren.
sourceRepository	SourceProperties		De egenskaper som beskriver källan (koden) för uppgiften.
sourceTriggerEvents	SourceTriggerEvent[]		Källhändelsen som motsvarar utlösaren.
status	TriggerStatus	Enabled	Utlösarens aktuella status.

SourceTriggerEvent

Uppräkning

Källhändelsen som motsvarar utlösaren.

Värde	Description
commit
pullrequest

Task

Objekt

Den uppgift som har ARM-resursen och uppgiftsegenskaperna. Uppgiften har all information för att schemalägga en körning mot den.

Name	Typ	Standardvärde	Description
id	string		Resurs-ID:t.
identity	IdentityProperties		Identitet för resursen.
location	string		Platsen för resursen. Detta kan inte ändras när resursen har skapats.
name	string		Namnet på resursen.
properties.agentConfiguration	AgentProperties		Datorkonfigurationen för körningsagenten.
properties.creationDate	string (date-time)		Skapandedatum för aktiviteten.
properties.credentials	Credentials		De egenskaper som beskriver en uppsättning autentiseringsuppgifter som ska användas när den här körningen anropas.
properties.platform	PlatformProperties		De plattformsegenskaper som körningen måste ske mot.
properties.provisioningState	ProvisioningState		Uppgiftens etableringstillstånd.
properties.status	TaskStatus		Aktivitetens aktuella status.
properties.step	TaskStepProperties: DockerBuildStep EncodedTaskStep FileTaskStep		Egenskaperna för ett aktivitetssteg.
properties.timeout	integer (int32) minimum: 300 maximum: 28800	3600	Tidsgräns för körning i sekunder.
properties.trigger	TriggerProperties		De egenskaper som beskriver alla utlösare för aktiviteten.
tags	object		Taggarna för resursen.
type	string		Resurstypen.

TaskStatus

Uppräkning

Aktivitetens aktuella status.

Värde	Description
Disabled
Enabled

TimerTrigger

Objekt

Egenskaperna för en timerutlösare.

Name	Typ	Standardvärde	Description
name	string		Namnet på utlösaren.
schedule	string		CRON-uttrycket för aktivitetsschemat
status	TriggerStatus	Enabled	Utlösarens aktuella status.

TokenType

Uppräkning

Typ av autentiseringstoken.

Värde	Description
OAuth
PAT

TriggerProperties

Objekt

Egenskaperna för en utlösare.

Name	Typ	Description
baseImageTrigger	BaseImageTrigger	Utlösaren baserat på basavbildningsberoenden.
sourceTriggers	SourceTrigger[]	Insamlingen av utlösare baserat på källkodslagringsplatsen.
timerTriggers	TimerTrigger[]	Samlingen med timerutlösare.

TriggerStatus

Uppräkning

Utlösarens aktuella status.

Värde	Description
Disabled
Enabled

UserIdentityProperties

Objekt

Name	Typ	Description
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.

Variant

Uppräkning

Variant av processorn.

Värde	Description
v6
v7
v8

Dela via

Tasks - Get Details

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Tasks_GetDetails

Exempelbegäran

Exempelsvar

Definitioner

AgentProperties

Architecture

Argument

AuthInfo

BaseImageDependency

BaseImageDependencyType

BaseImageTrigger

BaseImageTriggerType

Credentials

CustomRegistryCredentials

DockerBuildStep

EncodedTaskStep

FileTaskStep

IdentityProperties

OS

PlatformProperties

ProvisioningState

ResourceIdentityType

SecretObject

SecretObjectType

SetValue

SourceControlType

SourceProperties

SourceRegistryCredentials

SourceRegistryLoginMode

SourceTrigger

SourceTriggerEvent

Task

TaskStatus

TimerTrigger

TokenType

TriggerProperties

TriggerStatus

UserIdentityProperties

Variant

Ytterligare resurser