Tasks - Get Details

Riferimento

Servizio:: Container Registry

Versione API:: 2019-04-01

Restituisce un'attività con informazioni estese che includono tutti i segreti.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Nome del registro contenitori.
resourceGroupName	path	True	string minLength: 1	Nome del gruppo di risorse a cui appartiene il registro contenitori.
subscriptionId	path	True	string	ID sottoscrizione di Microsoft Azure.
taskName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9-_]*$	Nome dell'attività del registro contenitori.
api-version	query	True	string	Versione dell'API client.

Risposte

Nome	Tipo	Descrizione
200 OK	Task	La richiesta ha avuto esito positivo; la richiesta è stata ben formata e ricevuta correttamente.
Other Status Codes		Risposta di errore che descrive il motivo per cui l'operazione non è riuscita. Se il Registro di sistema non esiste, viene restituito 404 (Non trovato).

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Tasks_GetDetails

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
AgentProperties	Proprietà che determinano la configurazione dell'agente di esecuzione.
Architecture	Architettura del sistema operativo.
Argument	Proprietà di un argomento di esecuzione.
AuthInfo	Proprietà di autorizzazione per l'accesso al repository del codice sorgente.
BaseImageDependency	Proprietà che descrivono una dipendenza dell'immagine di base.
BaseImageDependencyType	Tipo della dipendenza dell'immagine di base.
BaseImageTrigger	Trigger basato sulla dipendenza dell'immagine di base.
BaseImageTriggerType	Tipo di trigger automatico per gli aggiornamenti delle dipendenze dell'immagine di base.
Credentials	Parametri che descrivono un set di credenziali che verranno usate quando viene richiamata un'esecuzione.
CustomRegistryCredentials	Descrive le credenziali che verranno usate per accedere a un registro personalizzato durante un'esecuzione.
DockerBuildStep	Passaggio di compilazione di Docker.
EncodedTaskStep	Proprietà di un passaggio attività codificato.
FileTaskStep	Proprietà di un passaggio dell'attività.
IdentityProperties	Identità gestita per la risorsa.
OS	Tipo di sistema operativo necessario per l'esecuzione.
PlatformProperties	Proprietà della piattaforma in cui deve verificarsi l'esecuzione.
ProvisioningState	Stato di provisioning di un'esecuzione.
ResourceIdentityType	Tipo di identità.
SecretObject	Descrive le proprietà di un valore dell'oggetto segreto.
SecretObjectType	Tipo dell'oggetto segreto che determina come deve essere interpretato il valore dell'oggetto segreto.
SetValue	Proprietà di un valore sostituibile che può essere passato a un modello di attività.
SourceControlType	Tipo di servizio di controllo del codice sorgente.
SourceProperties	Proprietà del repository del codice sorgente.
SourceRegistryCredentials	Descrive i parametri delle credenziali per l'accesso al Registro di sistema di origine.
SourceRegistryLoginMode	Modalità di autenticazione che determina l'ambito di accesso del Registro di sistema di origine. Le credenziali per il Registro di sistema di origine verranno generate usando l'ambito specificato. Queste credenziali verranno usate per accedere al Registro di sistema di origine durante l'esecuzione.
SourceTrigger	Proprietà di un trigger basato su origine.
SourceTriggerEvent	Evento di origine corrispondente al trigger.
Task	Attività con le proprietà della risorsa e dell'attività arm. L'attività avrà tutte le informazioni per pianificare un'esecuzione su di essa.
TaskStatus	Stato corrente dell'attività.
TimerTrigger	Proprietà di un trigger timer.
TokenType	Tipo di token di autenticazione.
TriggerProperties	Proprietà di un trigger.
TriggerStatus	Stato corrente del trigger.
UserIdentityProperties
Variant	Variante della CPU.

AgentProperties

Object

Proprietà che determinano la configurazione dell'agente di esecuzione.

Nome	Tipo	Descrizione
cpu	integer (int32)	La configurazione della CPU in termini di numero di core necessari per l'esecuzione.

Architecture

Enumerazione

Architettura del sistema operativo.

Valore	Descrizione
amd64
arm
x86

Argument

Object

Proprietà di un argomento di esecuzione.

Nome	Tipo	Valore predefinito	Descrizione
isSecret	boolean	False	Flag per indicare se l'argomento rappresenta un segreto e vuole essere rimosso dai log di compilazione.
name	string		Nome dell'argomento.
value	string		Valore dell'argomento.

AuthInfo

Object

Proprietà di autorizzazione per l'accesso al repository del codice sorgente.

Nome	Tipo	Descrizione
expiresIn	integer (int32)	Tempo in secondi in cui il token rimane valido
refreshToken	string	Token di aggiornamento usato per aggiornare il token di accesso.
scope	string	Ambito del token di accesso.
token	string	Token di accesso usato per accedere al provider di controllo del codice sorgente.
tokenType	TokenType	Tipo di token di autenticazione.

BaseImageDependency

Object

Proprietà che descrivono una dipendenza dell'immagine di base.

Nome	Tipo	Descrizione
digest	string	Digest basato su sha256 del manifesto dell'immagine.
registry	string	Server di accesso del Registro di sistema.
repository	string	Nome del repository.
tag	string	Nome del tag.
type	BaseImageDependencyType	Tipo della dipendenza dell'immagine di base.

BaseImageDependencyType

Enumerazione

Tipo della dipendenza dell'immagine di base.

Valore	Descrizione
BuildTime
RunTime

BaseImageTrigger

Object

Trigger basato sulla dipendenza dell'immagine di base.

Nome	Tipo	Valore predefinito	Descrizione
baseImageTriggerType	BaseImageTriggerType		Tipo di trigger automatico per gli aggiornamenti delle dipendenze dell'immagine di base.
name	string		Nome del trigger.
status	TriggerStatus	Enabled	Stato corrente del trigger.

BaseImageTriggerType

Enumerazione

Tipo di trigger automatico per gli aggiornamenti delle dipendenze dell'immagine di base.

Valore	Descrizione
All
Runtime

Credentials

Object

Parametri che descrivono un set di credenziali che verranno usate quando viene richiamata un'esecuzione.

Nome	Tipo	Descrizione
customRegistries	<string, CustomRegistryCredentials>	Descrive i parametri delle credenziali per l'accesso ad altri registri personalizzati. La chiave per l'elemento del dizionario sarà il server di accesso del Registro di sistema (myregistry.azurecr.io) e il valore dell'elemento sarà le credenziali del Registro di sistema per l'accesso al Registro di sistema.
sourceRegistry	SourceRegistryCredentials	Descrive i parametri delle credenziali per l'accesso al Registro di sistema di origine.

CustomRegistryCredentials

Object

Descrive le credenziali che verranno usate per accedere a un registro personalizzato durante un'esecuzione.

Nome	Tipo	Descrizione
identity	string	Indica l'identità gestita assegnata alle credenziali personalizzate. Se un'identità assegnata dall'utente questo valore è l'ID client. Se un'identità assegnata dal sistema, il valore verrà `system`. Nel caso di un'identità assegnata dal sistema, l'ID client verrà determinato dallo strumento di esecuzione. Questa identità può essere usata per eseguire l'autenticazione all'insieme di credenziali delle chiavi per recuperare le credenziali oppure può essere l'unica origine di autenticazione usata per accedere al Registro di sistema.
password	SecretObject	Password per l'accesso al Registro di sistema personalizzato. La password è un oggetto segreto che consente più modi di fornire il valore.
userName	SecretObject	Nome utente per l'accesso al Registro di sistema personalizzato.

DockerBuildStep

Object

Passaggio di compilazione di Docker.

Nome	Tipo	Valore predefinito	Descrizione
arguments	Argument[]		Raccolta di argomenti di override da usare durante l'esecuzione di questo passaggio di compilazione.
baseImageDependencies	BaseImageDependency[]		Elenco delle dipendenze dell'immagine di base per un passaggio.
contextAccessToken	string		Token (token GIT PAT o token di firma di accesso condiviso del BLOB dell'account di archiviazione) associato al contesto per un passaggio.
contextPath	string		URL(assoluto o relativo) del contesto di origine per il passaggio dell'attività.
dockerFilePath	string		Percorso del file Docker relativo al contesto di origine.
imageNames	string[]		Nomi di immagine completi, inclusi il repository e il tag.
isPushEnabled	boolean	True	Il valore di questa proprietà indica se l'immagine compilata deve essere inserita nel Registro di sistema o meno.
noCache	boolean	False	Il valore di questa proprietà indica se la cache delle immagini è abilitata o meno.
target	string		Nome della fase di compilazione di destinazione per la compilazione docker.
type	string: Docker		Tipo del passaggio.

EncodedTaskStep

Object

Proprietà di un passaggio attività codificato.

Nome	Tipo	Descrizione
baseImageDependencies	BaseImageDependency[]	Elenco delle dipendenze dell'immagine di base per un passaggio.
contextAccessToken	string	Token (token GIT PAT o token di firma di accesso condiviso del BLOB dell'account di archiviazione) associato al contesto per un passaggio.
contextPath	string	URL(assoluto o relativo) del contesto di origine per il passaggio dell'attività.
encodedTaskContent	string	Valore con codifica Base64 del contenuto del file di modello/definizione.
encodedValuesContent	string	Valore con codifica Base64 del contenuto del file parameters/values.
type	string: EncodedTask	Tipo del passaggio.
values	SetValue[]	Raccolta di valori sostituibili che possono essere passati durante l'esecuzione di un'attività.

FileTaskStep

Object

Proprietà di un passaggio dell'attività.

Nome	Tipo	Descrizione
baseImageDependencies	BaseImageDependency[]	Elenco delle dipendenze dell'immagine di base per un passaggio.
contextAccessToken	string	Token (token GIT PAT o token di firma di accesso condiviso del BLOB dell'account di archiviazione) associato al contesto per un passaggio.
contextPath	string	URL(assoluto o relativo) del contesto di origine per il passaggio dell'attività.
taskFilePath	string	Percorso del file modello/definizione dell'attività relativo al contesto di origine.
type	string: FileTask	Tipo del passaggio.
values	SetValue[]	Raccolta di valori sostituibili che possono essere passati durante l'esecuzione di un'attività.
valuesFilePath	string	Percorso del file valori/parametri dell'attività relativo al contesto di origine.

IdentityProperties

Object

Identità gestita per la risorsa.

Nome	Tipo	Descrizione
principalId	string	ID principale dell'identità della risorsa.
tenantId	string	ID tenant della risorsa.
type	ResourceIdentityType	Tipo di identità.
userAssignedIdentities	<string, UserIdentityProperties>	Elenco di identità utente associate alla risorsa. I riferimenti alla chiave del dizionario delle identità utente saranno id risorsa ARM nel formato :'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

OS

Enumerazione

Tipo di sistema operativo necessario per l'esecuzione.

Valore	Descrizione
Linux
Windows

PlatformProperties

Object

Proprietà della piattaforma in cui deve verificarsi l'esecuzione.

Nome	Tipo	Descrizione
architecture	Architecture	Architettura del sistema operativo.
os	OS	Tipo di sistema operativo necessario per l'esecuzione.
variant	Variant	Variante della CPU.

ProvisioningState

Enumerazione

Stato di provisioning di un'esecuzione.

Valore	Descrizione
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

Enumerazione

Tipo di identità.

Valore	Descrizione
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SecretObject

Object

Descrive le proprietà di un valore dell'oggetto segreto.

Nome	Tipo	Descrizione
type	SecretObjectType	Tipo dell'oggetto segreto che determina come deve essere interpretato il valore dell'oggetto segreto.
value	string	Valore del segreto. Il formato di questo valore verrà determinato in base al tipo dell'oggetto segreto. Se il tipo è opaco, il valore verrà usato così come è senza alcuna modifica.

SecretObjectType

Enumerazione

Tipo dell'oggetto segreto che determina come deve essere interpretato il valore dell'oggetto segreto.

Valore	Descrizione
Opaque
Vaultsecret

SetValue

Object

Proprietà di un valore sostituibile che può essere passato a un modello di attività.

Nome	Tipo	Valore predefinito	Descrizione
isSecret	boolean	False	Flag per indicare se il valore rappresenta o meno un segreto.
name	string		Nome del valore di cui è possibile eseguire l'override.
value	string		Valore sostituibile.

SourceControlType

Enumerazione

Tipo di servizio di controllo del codice sorgente.

Valore	Descrizione
Github
VisualStudioTeamService

SourceProperties

Object

Proprietà del repository del codice sorgente.

Nome	Tipo	Descrizione
branch	string	Nome del ramo del codice sorgente.
repositoryUrl	string	URL completo del repository del codice sorgente
sourceControlAuthProperties	AuthInfo	Proprietà di autorizzazione per l'accesso al repository del codice sorgente e per configurare webhook per le notifiche.
sourceControlType	SourceControlType	Tipo di servizio di controllo del codice sorgente.

SourceRegistryCredentials

Object

Descrive i parametri delle credenziali per l'accesso al Registro di sistema di origine.

Nome	Tipo	Descrizione
loginMode	SourceRegistryLoginMode	Modalità di autenticazione che determina l'ambito di accesso del Registro di sistema di origine. Le credenziali per il Registro di sistema di origine verranno generate usando l'ambito specificato. Queste credenziali verranno usate per accedere al Registro di sistema di origine durante l'esecuzione.

SourceRegistryLoginMode

Enumerazione

Modalità di autenticazione che determina l'ambito di accesso del Registro di sistema di origine. Le credenziali per il Registro di sistema di origine verranno generate usando l'ambito specificato. Queste credenziali verranno usate per accedere al Registro di sistema di origine durante l'esecuzione.

Valore	Descrizione
Default
None

SourceTrigger

Object

Proprietà di un trigger basato su origine.

Nome	Tipo	Valore predefinito	Descrizione
name	string		Nome del trigger.
sourceRepository	SourceProperties		Proprietà che descrivono il codice sorgente (codice) per l'attività.
sourceTriggerEvents	SourceTriggerEvent[]		Evento di origine corrispondente al trigger.
status	TriggerStatus	Enabled	Stato corrente del trigger.

SourceTriggerEvent

Enumerazione

Evento di origine corrispondente al trigger.

Valore	Descrizione
commit
pullrequest

Task

Object

Attività con le proprietà della risorsa e dell'attività arm. L'attività avrà tutte le informazioni per pianificare un'esecuzione su di essa.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID risorsa.
identity	IdentityProperties		Identità per la risorsa.
location	string		Posizione della risorsa. Questa operazione non può essere modificata dopo la creazione della risorsa.
name	string		Nome della risorsa.
properties.agentConfiguration	AgentProperties		Configurazione del computer dell'agente di esecuzione.
properties.creationDate	string (date-time)		Data di creazione dell'attività.
properties.credentials	Credentials		Proprietà che descrivono un set di credenziali che verranno usate quando viene richiamata questa esecuzione.
properties.platform	PlatformProperties		Proprietà della piattaforma in cui deve verificarsi l'esecuzione.
properties.provisioningState	ProvisioningState		Stato di provisioning dell'attività.
properties.status	TaskStatus		Stato corrente dell'attività.
properties.step	TaskStepProperties: DockerBuildStep EncodedTaskStep FileTaskStep		Proprietà di un passaggio dell'attività.
properties.timeout	integer (int32) minimum: 300 maximum: 28800	3600	Timeout di esecuzione in secondi.
properties.trigger	TriggerProperties		Proprietà che descrivono tutti i trigger per l'attività.
tags	object		Tag della risorsa.
type	string		Tipo della risorsa.

TaskStatus

Enumerazione

Stato corrente dell'attività.

Valore	Descrizione
Disabled
Enabled

TimerTrigger

Object

Proprietà di un trigger timer.

Nome	Tipo	Valore predefinito	Descrizione
name	string		Nome del trigger.
schedule	string		Espressione CRON per la pianificazione delle attività
status	TriggerStatus	Enabled	Stato corrente del trigger.

TokenType

Enumerazione

Tipo di token di autenticazione.

Valore	Descrizione
OAuth
PAT

TriggerProperties

Object

Proprietà di un trigger.

Nome	Tipo	Descrizione
baseImageTrigger	BaseImageTrigger	Trigger basato sulle dipendenze dell'immagine di base.
sourceTriggers	SourceTrigger[]	Raccolta di trigger basati sul repository del codice sorgente.
timerTriggers	TimerTrigger[]	Raccolta di trigger timer.

TriggerStatus

Enumerazione

Stato corrente del trigger.

Valore	Descrizione
Disabled
Enabled

UserIdentityProperties

Object

Nome	Tipo	Descrizione
clientId	string	ID client dell'identità assegnata dall'utente.
principalId	string	ID principale dell'identità assegnata dall'utente.

Variant

Enumerazione

Variante della CPU.

Valore	Descrizione
v6
v7
v8

Condividi tramite

Tasks - Get Details

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Tasks_GetDetails

Esempio di richiesta

Risposta di esempio

Definizioni

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

Risorse aggiuntive