Audit Log - Query

Odwołanie

Service:: Audit

API Version:: 7.1-preview.1

Zapytania dotyczące wpisów dziennika inspekcji

GET https://auditservice.dev.azure.com/{organization}/_apis/audit/auditlog?api-version=7.1-preview.1

With optional parameters:

GET https://auditservice.dev.azure.com/{organization}/_apis/audit/auditlog?startTime={startTime}&endTime={endTime}&batchSize={batchSize}&continuationToken={continuationToken}&skipAggregation={skipAggregation}&api-version=7.1-preview.1

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path		string	Nazwa organizacji usługi Azure DevOps.
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.
batchSize	query		integer int32	Maksymalna liczba wyników do zwrócenia. Opcjonalne
continuationToken	query		string	Token używany do zwracania następnego zestawu wyników z poprzedniego zapytania. Opcjonalne
endTime	query		string date-time	Godzina zakończenia okna pobierania. Opcjonalne
skipAggregation	query		boolean	Pomija agregowanie zdarzeń i pozostawia je jako pojedyncze wpisy. Domyślnie zdarzenia są agregowane. Typy zdarzeń agregowane: AuditLog.AccessLog.
startTime	query		string date-time	Godzina rozpoczęcia okna pobierania. Opcjonalne

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AuditLogQueryResult	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nazwa	Opis
vso.auditlog	Umożliwia odczytywanie dzienników inspekcji i strumieni inspekcji użytkownikom

Przykłady

By date

Sample Request

HTTP

GET https://auditservice.dev.azure.com/_apis/audit/auditlog?startTime=2019-03-04T14:05:59.928Z&endTime=2019-03-05T14:05:59.928Z&batchSize=2&api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "value": {
    "decoratedAuditLogEntries": [
      {
        "id": "2518505060978539161;00000064-0000-8888-8000-000000000000;86fbe369-3f5d-4f52-9ab0-3be7db271948",
        "correlationId": "86fbe369-3f5d-4f52-9ab0-3be7db271948",
        "activityId": "033fde68-f713-4984-b24f-8d7a73d1ade6",
        "actorCUID": "a718550e-4777-4058-8298-bff88d0cb524",
        "actorUserId": "d6a98b6c-6932-485c-a986-aea9fc981df0",
        "authenticationMechanism": "FedAuth",
        "timestamp": "2019-03-05T14:05:02.1460838+00:00",
        "scopeType": "organization",
        "scopeDisplayName": "fabrikam (Organization)",
        "scopeId": "73638cd5-0dda-4128-9fd6-48c16d4e4de3",
        "ipAddress": "167.220.148.131",
        "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.119 Safari/537.36",
        "actionId": "AuditLog.AccessLog",
        "data": {
          "Filter": {
            "StartTime": "2019-03-04T14:05:59.928Z",
            "EndTime": "2019-03-05T14:05:59.928Z",
            "ContinuationToken": null,
            "BatchSize": 2,
            "HasMore": true
          },
          "EventSummary": [
            "2019-03-05T14:05:02.1460838+00:00",
            "2019-03-05T13:59:40.4899467+00:00",
            "2019-03-05T13:58:13.159128+00:00"
          ]
        },
        "details": "Accessed the audit log 3 times",
        "area": "Auditing",
        "category": "access",
        "categoryDisplayName": "Access",
        "actorDisplayName": "Norman Paulk",
        "actorImageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.NzdhMTNiN2MtYjIxNy03NDc4LWIxMjItYTlhMTU5YTFlNWQw"
      },
      {
        "id": "2518505063644965580;00000002-0000-8888-8000-000000000000;198b13cf-5201-48e8-acef-0d8bb2d9e815",
        "correlationId": "57f825b4-a940-44a3-a3cc-25cdb9871107",
        "activityId": "01abe2fd-deee-4a47-b35f-dff3edc059a4",
        "actorCUID": "00000000-0000-0000-0000-000000000000",
        "actorUserId": "00000002-0000-8888-8000-000000000000",
        "authenticationMechanism": "",
        "timestamp": "2019-03-05T14:00:35.5034419+00:00",
        "scopeType": "organization",
        "scopeDisplayName": "fabrikam (Organization)",
        "scopeId": "73638cd5-0dda-4128-9fd6-48c16d4e4de3",
        "ipAddress": null,
        "userAgent": "",
        "actionId": "Project.CreateCompleted",
        "data": {
          "ProjectId": "2e0ffea5-d693-4711-862c-94393bacadcb",
          "ProjectName": "fabrikam-fiber-git",
          "ProcessTemplate": "Agile",
          "ProjectVisibility": "Private"
        },
        "details": "fabrikam-fiber-git project was created successfully",
        "area": "Project",
        "category": "create",
        "categoryDisplayName": "Create",
        "actorDisplayName": "Azure DevOps Service",
        "actorImageUrl": null
      }
    ],
    "continuationToken": "2518505063644965580;00000002-0000-8888-8000-000000000000;198b13cf-5201-48e8-acef-0d8bb2d9e815",
    "hasMore": false
  }
}

Definicje

Nazwa	Opis
AuditActionCategory	Typ wykonanej akcji
AuditLogQueryResult	Obiekt zwracany po wysłaniu zapytania do dziennika inspekcji. Zawiera dziennik i informacje potrzebne do wykonywania zapytań dotyczących większej liczby wpisów inspekcji.
AuditScopeType	Typ zakresu (Organizacja jest obecnie obsługiwany tylko w zakresie)
DecoratedAuditLogEntry

AuditActionCategory

Typ wykonanej akcji

Nazwa	Typ	Opis
access	string	Dostęp do artefaktu
create	string	Utworzono artefakt
execute	string	Artefakt został wykonany
modify	string	Artefakt został zmodyfikowany
remove	string	Artefakt został usunięty
unknown	string	Kategoria nie jest znana

AuditLogQueryResult

Obiekt zwracany po wysłaniu zapytania do dziennika inspekcji. Zawiera dziennik i informacje potrzebne do wykonywania zapytań dotyczących większej liczby wpisów inspekcji.

Nazwa	Typ	Opis
continuationToken	string	Token kontynuacji do przekazania w celu uzyskania następnego zestawu wyników
decoratedAuditLogEntries	DecoratedAuditLogEntry[]	Lista wpisów dziennika inspekcji
hasMore	boolean	Wartość true, jeśli istnieje więcej pasujących wyników do pobrania, w przeciwnym razie fałsz.

AuditScopeType

Typ zakresu (Organizacja jest obecnie obsługiwany tylko w zakresie)

Nazwa	Typ	Opis
deployment	string	Wdrożenie
enterprise	string	Przedsiębiorstwa
organization	string	Organizacja
project	string	Project
unknown	string	Zakres nie jest znany lub nie został ustawiony

DecoratedAuditLogEntry

Nazwa	Typ	Opis
actionId	string	Identyfikator akcji zdarzenia, tj. Git.CreateRepo, Project.RenameProject
activityId	string	ActivityId
actorCUID	string	CuID aktora
actorClientId	string	Identyfikator klienta aktora (jeśli aktor jest jednostką usługi)
actorDisplayName	string	DisplayName użytkownika, który zainicjował akcję
actorImageUrl	string	Adres URL obrazu profilu aktora
actorUPN	string	Nazwa UPN aktora
actorUserId	string	Identyfikator użytkownika aktora (jeśli aktor jest użytkownikiem)
area	string	Obszar usługi Azure DevOps, w ramach którego wystąpiła akcja
authenticationMechanism	string	Typ uwierzytelniania używanego przez aktora
category	AuditActionCategory	Typ wykonanej akcji
categoryDisplayName	string	DisplayName kategorii
correlationId	string	Umożliwia to grupowanie powiązanych wpisów inspekcji. Zazwyczaj dzieje się tak, gdy pojedyncza akcja powoduje kaskadę wpisów inspekcji. Na przykład tworzenie projektu.
data	object	Dane zewnętrzne, takie jak identyfikatory CUID, nazwy elementów itp.
details	string	Szczegóły ozdobione
id	string	EventId — musi być unikatowa dla każdej usługi
ipAddress	string	Adres IP, w którym pochodzi zdarzenie
projectId	string	Po określeniu identyfikator projektu, z tym zdarzeniem jest skojarzone
projectName	string	Po określeniu nazwa projektu, z tym zdarzeniem jest skojarzone
scopeDisplayName	string	DisplayName zakresu
scopeId	string	Identyfikator organizacji (organizacja jest jedynym obecnie obsługiwanym zakresem)
scopeType	AuditScopeType	Typ zakresu (Organizacja jest obecnie obsługiwany tylko w zakresie)
timestamp	string	Godzina wystąpienia zdarzenia w formacie UTC
userAgent	string	Agent użytkownika z żądania

Udostępnij za pośrednictwem