Tasks - List

Service:

Defender EASM (preview)

API Version:

2023-03-01-preview

Ruft eine Liste von Aufgaben für die bereitgestellten Suchparameter ab.

GET https://{endpoint}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks?api-version=2023-03-01-preview

With optional parameters:

GET https://{endpoint}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}/tasks?filter={filter}&orderby={orderby}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-03-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Der Endpunkt, der die angeforderte Ressource hostt. Beispiel: {region}.easm.defender.microsoft.com.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
workspaceName	path	True	string	Der Name des Arbeitsbereichs.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
filter	query		string	Ein Ausdruck für den Ressourcentyp, der die zurückzugebenden Ressourcen auswählt.
maxpagesize	query		integer int32	Die maximale Anzahl von Elementen, die in eine einzelne Antwort eingeschlossen werden sollen.
orderby	query		string	Eine Liste von Ausdrücken, die die Reihenfolge der zurückgegebenen Ressourcen angeben.
skip	query		integer int32	Ein Offset in die Auflistung des ersten zurückgegebenen Elements.

Antworten

Name	Typ	Beschreibung
200 OK	TaskPageResponse	OK
Other Status Codes	ErrorResponse	Fehler Headers x-ms-error-code: string

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Annehmen der Identität Ihres Benutzerkontos

Beispiele

Tasks

Sample Request

HTTP

GET https://{endpoint}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/workspaces/ThisisaWorkspace/tasks?api-version=2023-03-01-preview

Sample Response

Status code:

200

{
  "totalElements": 2,
  "value": [
    {
      "id": "ThisisaTaskId",
      "startedAt": "2022-05-02T19:30:14.432+00:00",
      "completedAt": "2022-05-02T19:30:54.432+00:00",
      "lastPolledAt": "2022-05-02T19:30:19.432+00:00",
      "state": "complete",
      "phase": "complete",
      "reason": "This is a Task id"
    },
    {
      "id": "ThisisaTaskId2",
      "startedAt": "2022-05-02T19:30:14.432+00:00",
      "completedAt": "2022-05-02T19:30:54.432+00:00",
      "lastPolledAt": "2022-05-02T19:30:19.432+00:00",
      "state": "complete",
      "phase": "complete",
      "reason": "This is a Task id"
    }
  ]
}

Definitionen

Name	Beschreibung
ErrorDetail	Dies ist das Fehlerobjekt der obersten Ebene, dessen Code mit dem Antwortheader x-ms-error-code übereinstimmt.
ErrorResponse
InnerError	Dies ist ein Objekt, das spezifischere Informationen als das aktuelle Objekt über den Fehler enthält.
TaskPageResponse
TaskResponse
TaskResponsePhase	Die Phase, in der sich die Aufgabe befindet.
TaskResponseState	Der Zustand, in dem sich die Aufgabe befindet.

ErrorDetail

Dies ist das Fehlerobjekt der obersten Ebene, dessen Code mit dem Antwortheader x-ms-error-code übereinstimmt.

Name	Typ	Beschreibung
code	string	Dies ist einer der vom Server definierten Fehlercodes.
details	ErrorDetail[]	Dies ist ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerError	Dies ist ein Objekt, das spezifischere Informationen als das aktuelle Objekt über den Fehler enthält.
message	string	Dies ist eine für Menschen lesbare Darstellung des Fehlers.
target	string	Dies ist das Fehlerziel.

ErrorResponse

Name	Typ	Beschreibung
error	ErrorDetail	Dies ist das Fehlerobjekt der obersten Ebene, dessen Code mit dem Antwortheader x-ms-error-code übereinstimmt.

InnerError

Dies ist ein Objekt, das spezifischere Informationen als das aktuelle Objekt über den Fehler enthält.

Name	Typ	Beschreibung
code	string	Dies ist ein spezifischerer Fehlercode als der enthaltende Fehler.
value	object	Dies ist ein zusätzliches Feld, das den Wert darstellt, der den Fehler verursacht hat, um beim Debuggen zu helfen.

TaskPageResponse

Name	Typ	Beschreibung
nextLink	string	Der Link, um auf die nächste Ergebnisseite zuzugreifen. Nicht festgelegt, wenn am Ende des Resultsets.
totalElements	integer	Die Gesamtanzahl der im vollständigen Resultset verfügbaren Elemente.
value	TaskResponse[]	Die Elemente auf der aktuellen Ergebnisseite.

TaskResponse

Name	Typ	Beschreibung
completedAt	string	Der Zeitpunkt, zu dem die Aufgabe abgeschlossen wurde.
id	string	Der eindeutige Bezeichner der Aufgabe.
lastPolledAt	string	Das letzte Mal, wenn die status der Aufgabe aktualisiert wurde.
metadata		Attribute, die für die Aufgabe eindeutig sind. Dies unterscheidet sich je nach Aufgabentyp.
phase	TaskResponsePhase	Die Phase, in der sich die Aufgabe befindet.
reason	string	Der Grund, warum die Aufgabe in den aktuellen Zustand versetzt wurde, wenn die Aufgabe nicht abgeschlossen wurde.
startedAt	string	Der Zeitpunkt, zu dem die Aufgabe gestartet wurde.
state	TaskResponseState	Der Zustand, in dem sich die Aufgabe befindet.

TaskResponsePhase

Die Phase, in der sich die Aufgabe befindet.

Name	Typ	Beschreibung
complete	string
polling	string
running	string

TaskResponseState

Der Zustand, in dem sich die Aufgabe befindet.

Name	Typ	Beschreibung
complete	string
failed	string
incomplete	string
paused	string
pending	string
running	string
warning	string