Tasks - Get Details

Referenz

Dienst:: Container Registry

API-Version:: 2019-04-01

Gibt eine Aufgabe mit erweiterten Informationen zurück, die alle geheimen Schlüssel enthalten.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
registryName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9]*$	Der Name der Containerregistrierung.
resourceGroupName	path	True	string minLength: 1	Der Name der Ressourcengruppe, zu der die Containerregistrierung gehört.
subscriptionId	path	True	string	Die Microsoft Azure-Abonnement-ID.
taskName	path	True	string minLength: 5 maxLength: 50 pattern: ^[a-zA-Z0-9-_]*$	Der Name der Containerregistrierungsaufgabe.
api-version	query	True	string	Die Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	Task	Die Anforderung war erfolgreich; die Anforderung war wohlgeformt und richtig empfangen.
Other Status Codes		Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. Wenn die Registrierung nicht vorhanden ist, wird 404 (Nicht gefunden) zurückgegeben.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Tasks_GetDetails

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AgentProperties	Die Eigenschaften, die die Ausführungs-Agent-Konfiguration bestimmen.
Architecture	Die Betriebssystemarchitektur.
Argument	Die Eigenschaften eines Run-Arguments.
AuthInfo	Die Autorisierungseigenschaften für den Zugriff auf das Quellcode-Repository.
BaseImageDependency	Eigenschaften, die eine Basisbildabhängigkeit beschreiben.
BaseImageDependencyType	Der Typ der Basisbildabhängigkeit.
BaseImageTrigger	Der Auslöser basierend auf der Abhängigkeit von Basisimages.
BaseImageTriggerType	Der Typ des automatischen Triggers für Basisimageabhängigkeitsupdates.
Credentials	Die Parameter, die einen Satz von Anmeldeinformationen beschreiben, die verwendet werden, wenn eine Ausführung aufgerufen wird.
CustomRegistryCredentials	Beschreibt die Anmeldeinformationen, die während einer Ausführung für den Zugriff auf eine benutzerdefinierte Registrierung verwendet werden.
DockerBuildStep	Der Docker-Buildschritt.
EncodedTaskStep	Die Eigenschaften eines codierten Vorgangsschritts.
FileTaskStep	Die Eigenschaften eines Vorgangsschritts.
IdentityProperties	Verwaltete Identität für die Ressource.
OS	Der betriebssystemtyp, der für die Ausführung erforderlich ist.
PlatformProperties	Die Plattformeigenschaften, für die die Ausführung ausgeführt werden muss.
ProvisioningState	Der Bereitstellungsstatus einer Ausführung.
ResourceIdentityType	Der Identitätstyp.
SecretObject	Beschreibt die Eigenschaften eines geheimen Objektwerts.
SecretObjectType	Der Typ des geheimen Objekts, der bestimmt, wie der Wert des geheimen Objekts interpretiert werden muss.
SetValue	Die Eigenschaften eines überschreibbaren Werts, der an eine Aufgabenvorlage übergeben werden kann.
SourceControlType	Der Typ des Quellcodeverwaltungsdiensts.
SourceProperties	Die Eigenschaften des Quellcode-Repositorys.
SourceRegistryCredentials	Beschreibt die Anmeldeinformationsparameter für den Zugriff auf die Quellregistrierung.
SourceRegistryLoginMode	Der Authentifizierungsmodus, der den Anmeldebereich der Quellregistrierung bestimmt. Die Anmeldeinformationen für die Quellregistrierung werden mithilfe des angegebenen Bereichs generiert. Diese Anmeldeinformationen werden verwendet, um sich während der Ausführung bei der Quellregistrierung anzumelden.
SourceTrigger	Die Eigenschaften eines quellbasierten Triggers.
SourceTriggerEvent	Das Quellereignis, das dem Trigger entspricht.
Task	Der Vorgang mit den ARM-Ressourcen- und Vorgangseigenschaften. Der Vorgang enthält alle Informationen, um eine Ausführung dafür zu planen.
TaskStatus	Der aktuelle Status der Aufgabe.
TimerTrigger	Die Eigenschaften eines Timertriggers.
TokenType	Der Typ des Authentifizierungstokens.
TriggerProperties	Die Eigenschaften eines Triggers.
TriggerStatus	Der aktuelle Status des Triggers.
UserIdentityProperties
Variant	Variante der CPU.

AgentProperties

Objekt

Die Eigenschaften, die die Ausführungs-Agent-Konfiguration bestimmen.

Name	Typ	Beschreibung
cpu	integer (int32)	Die CPU-Konfiguration in Bezug auf die Anzahl der für die Ausführung erforderlichen Kerne.

Architecture

Enumeration

Die Betriebssystemarchitektur.

Wert	Beschreibung
amd64
arm
x86

Argument

Objekt

Die Eigenschaften eines Run-Arguments.

Name	Typ	Standardwert	Beschreibung
isSecret	boolean	False	Kennzeichnen, um anzugeben, ob das Argument einen geheimen Schlüssel darstellt und aus Buildprotokollen entfernt werden soll.
name	string		Der Name des Arguments.
value	string		Der Wert des Arguments.

AuthInfo

Objekt

Die Autorisierungseigenschaften für den Zugriff auf das Quellcode-Repository.

Name	Typ	Beschreibung
expiresIn	integer (int32)	Zeit in Sekunden, die das Token gültig bleibt
refreshToken	string	Das Aktualisierungstoken, das zum Aktualisieren des Zugriffstokens verwendet wird.
scope	string	Der Bereich des Zugriffstokens.
token	string	Das Zugriffstoken, das für den Zugriff auf den Quellcodeverwaltungsanbieter verwendet wird.
tokenType	TokenType	Der Typ des Authentifizierungstokens.

BaseImageDependency

Objekt

Eigenschaften, die eine Basisbildabhängigkeit beschreiben.

Name	Typ	Beschreibung
digest	string	Der sha256-basierte Digest des Bildmanifests.
registry	string	Der Registrierungsanmeldungsserver.
repository	string	Der Repositoryname.
tag	string	Der Tagname.
type	BaseImageDependencyType	Der Typ der Basisbildabhängigkeit.

BaseImageDependencyType

Enumeration

Der Typ der Basisbildabhängigkeit.

Wert	Beschreibung
BuildTime
RunTime

BaseImageTrigger

Objekt

Der Auslöser basierend auf der Abhängigkeit von Basisimages.

Name	Typ	Standardwert	Beschreibung
baseImageTriggerType	BaseImageTriggerType		Der Typ des automatischen Triggers für Basisimageabhängigkeitsupdates.
name	string		Der Name des Triggers.
status	TriggerStatus	Enabled	Der aktuelle Status des Triggers.

BaseImageTriggerType

Enumeration

Der Typ des automatischen Triggers für Basisimageabhängigkeitsupdates.

Wert	Beschreibung
All
Runtime

Credentials

Objekt

Die Parameter, die einen Satz von Anmeldeinformationen beschreiben, die verwendet werden, wenn eine Ausführung aufgerufen wird.

Name	Typ	Beschreibung
customRegistries	<string, CustomRegistryCredentials>	Beschreibt die Anmeldeinformationsparameter für den Zugriff auf andere benutzerdefinierte Registrierungen. Der Schlüssel für das Wörterbuchelement ist der Registrierungsanmeldeserver (myregistry.azurecr.io), und der Wert des Elements ist die Registrierungsanmeldeinformationen für den Zugriff auf die Registrierung.
sourceRegistry	SourceRegistryCredentials	Beschreibt die Anmeldeinformationsparameter für den Zugriff auf die Quellregistrierung.

CustomRegistryCredentials

Objekt

Beschreibt die Anmeldeinformationen, die während einer Ausführung für den Zugriff auf eine benutzerdefinierte Registrierung verwendet werden.

Name	Typ	Beschreibung
identity	string	Gibt die verwaltete Identität an, die den benutzerdefinierten Anmeldeinformationen zugewiesen ist. Wenn eine vom Benutzer zugewiesene Identität dieser Wert die Client-ID ist. Wenn eine vom System zugewiesene Identität, wird der Wert `system`. Bei einer vom System zugewiesenen Identität wird die Client-ID vom Läufer bestimmt. Diese Identität kann verwendet werden, um sich beim Schlüsseltresor zu authentifizieren, um Anmeldeinformationen abzurufen, oder es kann die einzige Quelle der Authentifizierung sein, die für den Zugriff auf die Registrierung verwendet wird.
password	SecretObject	Das Kennwort für die Anmeldung bei der benutzerdefinierten Registrierung. Das Kennwort ist ein geheimes Objekt, das mehrere Möglichkeiten ermöglicht, den Wert dafür bereitzustellen.
userName	SecretObject	Der Benutzername für die Anmeldung bei der benutzerdefinierten Registrierung.

DockerBuildStep

Objekt

Der Docker-Buildschritt.

Name	Typ	Standardwert	Beschreibung
arguments	Argument[]		Die Auflistung der Außerkraftsetzungsargumente, die beim Ausführen dieses Buildschritts verwendet werden sollen.
baseImageDependencies	BaseImageDependency[]		Liste der Basisbildabhängigkeiten für einen Schritt.
contextAccessToken	string		Das Token (Git PAT oder SAS-Token des Speicherkonto-Blobs), das dem Kontext für einen Schritt zugeordnet ist.
contextPath	string		Die URL(absolut oder relativ) des Quellkontexts für den Vorgangsschritt.
dockerFilePath	string		Der Docker-Dateipfad relativ zum Quellkontext.
imageNames	string[]		Die vollqualifizierten Bildnamen einschließlich Repository und Tag.
isPushEnabled	boolean	True	Der Wert dieser Eigenschaft gibt an, ob das erstellte Image an die Registrierung übertragen werden soll.
noCache	boolean	False	Der Wert dieser Eigenschaft gibt an, ob der Bildcache aktiviert ist oder nicht.
target	string		Der Name der Zielbuildstufe für den Docker-Build.
type	string: Docker		Der Typ des Schritts.

EncodedTaskStep

Objekt

Die Eigenschaften eines codierten Vorgangsschritts.

Name	Typ	Beschreibung
baseImageDependencies	BaseImageDependency[]	Liste der Basisbildabhängigkeiten für einen Schritt.
contextAccessToken	string	Das Token (Git PAT oder SAS-Token des Speicherkonto-Blobs), das dem Kontext für einen Schritt zugeordnet ist.
contextPath	string	Die URL(absolut oder relativ) des Quellkontexts für den Vorgangsschritt.
encodedTaskContent	string	Base64-codierter Wert des Vorlagen-/Definitionsdateiinhalts.
encodedValuesContent	string	Base64-codierter Wert der Parameter/Werte-Dateiinhalte.
type	string: EncodedTask	Der Typ des Schritts.
values	SetValue[]	Die Sammlung überschreibbarer Werte, die beim Ausführen einer Aufgabe übergeben werden können.

FileTaskStep

Objekt

Die Eigenschaften eines Vorgangsschritts.

Name	Typ	Beschreibung
baseImageDependencies	BaseImageDependency[]	Liste der Basisbildabhängigkeiten für einen Schritt.
contextAccessToken	string	Das Token (Git PAT oder SAS-Token des Speicherkonto-Blobs), das dem Kontext für einen Schritt zugeordnet ist.
contextPath	string	Die URL(absolut oder relativ) des Quellkontexts für den Vorgangsschritt.
taskFilePath	string	Der Dateipfad der Aufgabenvorlage/Definition relativ zum Quellkontext.
type	string: FileTask	Der Typ des Schritts.
values	SetValue[]	Die Sammlung überschreibbarer Werte, die beim Ausführen einer Aufgabe übergeben werden können.
valuesFilePath	string	Der Dateipfad für Vorgangswerte/Parameter relativ zum Quellkontext.

IdentityProperties

Objekt

Verwaltete Identität für die Ressource.

Name	Typ	Beschreibung
principalId	string	Die Prinzipal-ID der Ressourcenidentität.
tenantId	string	Die Mandanten-ID der Ressource.
type	ResourceIdentityType	Der Identitätstyp.
userAssignedIdentities	<string, UserIdentityProperties>	Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

OS

Enumeration

Der betriebssystemtyp, der für die Ausführung erforderlich ist.

Wert	Beschreibung
Linux
Windows

PlatformProperties

Objekt

Die Plattformeigenschaften, für die die Ausführung ausgeführt werden muss.

Name	Typ	Beschreibung
architecture	Architecture	Die Betriebssystemarchitektur.
os	OS	Der betriebssystemtyp, der für die Ausführung erforderlich ist.
variant	Variant	Variante der CPU.

ProvisioningState

Enumeration

Der Bereitstellungsstatus einer Ausführung.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded
Updating

ResourceIdentityType

Enumeration

Der Identitätstyp.

Wert	Beschreibung
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

SecretObject

Objekt

Beschreibt die Eigenschaften eines geheimen Objektwerts.

Name	Typ	Beschreibung
type	SecretObjectType	Der Typ des geheimen Objekts, der bestimmt, wie der Wert des geheimen Objekts interpretiert werden muss.
value	string	Der Wert des geheimen Schlüssels. Das Format dieses Werts wird basierend auf dem Typ des geheimen Objekts bestimmt. Wenn der Typ undurchsichtig ist, wird der Wert ohne Änderung verwendet.

SecretObjectType

Enumeration

Der Typ des geheimen Objekts, der bestimmt, wie der Wert des geheimen Objekts interpretiert werden muss.

Wert	Beschreibung
Opaque
Vaultsecret

SetValue

Objekt

Die Eigenschaften eines überschreibbaren Werts, der an eine Aufgabenvorlage übergeben werden kann.

Name	Typ	Standardwert	Beschreibung
isSecret	boolean	False	Kennzeichnen, um anzugeben, ob der Wert einen geheimen Schlüssel darstellt oder nicht.
name	string		Der Name des überschreibbaren Werts.
value	string		Der überschreibbare Wert.

SourceControlType

Enumeration

Der Typ des Quellcodeverwaltungsdiensts.

Wert	Beschreibung
Github
VisualStudioTeamService

SourceProperties

Objekt

Die Eigenschaften des Quellcode-Repositorys.

Name	Typ	Beschreibung
branch	string	Der Verzweigungsname des Quellcodes.
repositoryUrl	string	Die vollständige URL zum Quellcode-Repository
sourceControlAuthProperties	AuthInfo	Die Autorisierungseigenschaften für den Zugriff auf das Quellcode-Repository und das Einrichten von Webhooks für Benachrichtigungen.
sourceControlType	SourceControlType	Der Typ des Quellcodeverwaltungsdiensts.

SourceRegistryCredentials

Objekt

Beschreibt die Anmeldeinformationsparameter für den Zugriff auf die Quellregistrierung.

Name	Typ	Beschreibung
loginMode	SourceRegistryLoginMode	Der Authentifizierungsmodus, der den Anmeldebereich der Quellregistrierung bestimmt. Die Anmeldeinformationen für die Quellregistrierung werden mithilfe des angegebenen Bereichs generiert. Diese Anmeldeinformationen werden verwendet, um sich während der Ausführung bei der Quellregistrierung anzumelden.

SourceRegistryLoginMode

Enumeration

Der Authentifizierungsmodus, der den Anmeldebereich der Quellregistrierung bestimmt. Die Anmeldeinformationen für die Quellregistrierung werden mithilfe des angegebenen Bereichs generiert. Diese Anmeldeinformationen werden verwendet, um sich während der Ausführung bei der Quellregistrierung anzumelden.

Wert	Beschreibung
Default
None

SourceTrigger

Objekt

Die Eigenschaften eines quellbasierten Triggers.

Name	Typ	Standardwert	Beschreibung
name	string		Der Name des Triggers.
sourceRepository	SourceProperties		Die Eigenschaften, die den Quellcode für die Aufgabe beschreiben.
sourceTriggerEvents	SourceTriggerEvent[]		Das Quellereignis, das dem Trigger entspricht.
status	TriggerStatus	Enabled	Der aktuelle Status des Triggers.

SourceTriggerEvent

Enumeration

Das Quellereignis, das dem Trigger entspricht.

Wert	Beschreibung
commit
pullrequest

Task

Objekt

Der Vorgang mit den ARM-Ressourcen- und Vorgangseigenschaften. Der Vorgang enthält alle Informationen, um eine Ausführung dafür zu planen.

Name	Typ	Standardwert	Beschreibung
id	string		Die Ressourcen-ID.
identity	IdentityProperties		Identität für die Ressource.
location	string		Der Standort der Ressource. Dies kann nicht geändert werden, nachdem die Ressource erstellt wurde.
name	string		Der Name der Ressource.
properties.agentConfiguration	AgentProperties		Die Computerkonfiguration des Ausführungs-Agents.
properties.creationDate	string (date-time)		Das Erstellungsdatum der Aufgabe.
properties.credentials	Credentials		Die Eigenschaften, die einen Satz von Anmeldeinformationen beschreiben, die verwendet werden, wenn diese Ausführung aufgerufen wird.
properties.platform	PlatformProperties		Die Plattformeigenschaften, für die die Ausführung ausgeführt werden muss.
properties.provisioningState	ProvisioningState		Der Bereitstellungsstatus der Aufgabe.
properties.status	TaskStatus		Der aktuelle Status der Aufgabe.
properties.step	TaskStepProperties: DockerBuildStep EncodedTaskStep FileTaskStep		Die Eigenschaften eines Vorgangsschritts.
properties.timeout	integer (int32) minimum: 300 maximum: 28800	3600	Laufzeittimeout in Sekunden.
properties.trigger	TriggerProperties		Die Eigenschaften, die alle Trigger für den Vorgang beschreiben.
tags	object		Die Tags der Ressource.
type	string		Der Typ der Ressource.

TaskStatus

Enumeration

Der aktuelle Status der Aufgabe.

Wert	Beschreibung
Disabled
Enabled

TimerTrigger

Objekt

Die Eigenschaften eines Timertriggers.

Name	Typ	Standardwert	Beschreibung
name	string		Der Name des Triggers.
schedule	string		Der CRON-Ausdruck für den Vorgangszeitplan
status	TriggerStatus	Enabled	Der aktuelle Status des Triggers.

TokenType

Enumeration

Der Typ des Authentifizierungstokens.

Wert	Beschreibung
OAuth
PAT

TriggerProperties

Objekt

Die Eigenschaften eines Triggers.

Name	Typ	Beschreibung
baseImageTrigger	BaseImageTrigger	Der Trigger basierend auf Basisbildabhängigkeiten.
sourceTriggers	SourceTrigger[]	Die Sammlung von Triggern basierend auf dem Quellcode-Repository.
timerTriggers	TimerTrigger[]	Die Sammlung von Timertriggern.

TriggerStatus

Enumeration

Der aktuelle Status des Triggers.

Wert	Beschreibung
Disabled
Enabled

UserIdentityProperties

Objekt

Name	Typ	Beschreibung
clientId	string	Die Client-ID der vom Benutzer zugewiesenen Identität.
principalId	string	Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.

Variant

Enumeration

Variante der CPU.

Wert	Beschreibung
v6
v7
v8

Freigeben über

Tasks - Get Details

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Tasks_GetDetails

Beispielanforderung

Beispiel für eine Antwort

Definitionen

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

Zusätzliche Ressourcen