Audit Log - Query

Başvuru

Service:: Audit

API Version:: 7.1-preview.1

Denetim günlüğü girdilerini sorgular

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path		string	Azure DevOps kuruluşunun adı.
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '7.1-preview.1' olarak ayarlanmalıdır.
batchSize	query		integer int32	Döndürülecek en fazla sonuç sayısı. İsteğe Bağlı
continuationToken	query		string	Önceki sorgudan sonraki sonuç kümesini döndürmek için kullanılan belirteç. İsteğe Bağlı
endTime	query		string date-time	İndirme penceresinin bitiş saati. İsteğe Bağlı
skipAggregation	query		boolean	Olayları toplamayı atlar ve bunları tek tek girdiler olarak bırakır. Varsayılan olarak olaylar toplanır. Toplanan olay türleri: AuditLog.AccessLog.
startTime	query		string date-time	İndirme penceresinin başlangıç saati. İsteğe Bağlı

Yanıtlar

Name	Tür	Description
200 OK	AuditLogQueryResult	başarılı işlem

Güvenlik

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

Name	Description
vso.auditlog	Kullanıcılara denetim günlüğünü ve denetim akışlarını okuma olanağı verir

Örnekler

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

Tanımlar

Name	Description
AuditActionCategory	Yürütülen eylem türü
AuditLogQueryResult	Denetim günlüğü sorgulandığında döndürülen nesne. Günlüğü ve daha fazla denetim girdisini sorgulamak için gereken bilgileri içerir.
AuditScopeType	Kapsamın türü (Kuruluş yalnızca şu anda desteklenen kapsamdır)
DecoratedAuditLogEntry

AuditActionCategory

Yürütülen eylem türü

Name	Tür	Description
access	string	Bir yapıta erişildi
create	string	Yapıt oluşturuldu
execute	string	Bir yapıt Yürütüldü
modify	string	Bir yapıt Değiştirildi
remove	string	Yapıt kaldırıldı
unknown	string	Kategori bilinmiyor

AuditLogQueryResult

Denetim günlüğü sorgulandığında döndürülen nesne. Günlüğü ve daha fazla denetim girdisini sorgulamak için gereken bilgileri içerir.

Name	Tür	Description
continuationToken	string	Sonraki sonuç kümesini almak için geçirilmesi gereken devamlılık belirteci
decoratedAuditLogEntries	DecoratedAuditLogEntry[]	Denetim günlüğü girdilerinin listesi
hasMore	boolean	Getirilecek daha fazla eşleşen sonuç olduğunda true, aksi takdirde false olur.

AuditScopeType

Kapsamın türü (Kuruluş yalnızca şu anda desteklenen kapsamdır)

Name	Tür	Description
deployment	string	Dağıtım
enterprise	string	Kurumsal
organization	string	Kuruluş
project	string	Project
unknown	string	Kapsam bilinmiyor veya ayarlanmadı

DecoratedAuditLogEntry

Name	Tür	Description
actionId	string	Olayın eylem kimliği, örneğin Git.CreateRepo, Project.RenameProject
activityId	string	ActivityId
actorCUID	string	Aktörün CUID'i
actorClientId	string	Aktörün İstemci Kimliği (aktör bir hizmet sorumlusuysa)
actorDisplayName	string	Eylemi başlatan kullanıcının DisplayName'i
actorImageUrl	string	Aktör Profili görüntüsünün URL'si
actorUPN	string	Aktörün UPN'i
actorUserId	string	Aktörün Kullanıcı Kimliği (aktör bir kullanıcıysa)
area	string	Eylemin gerçekleştiği Azure DevOps alanı
authenticationMechanism	string	Aktör tarafından kullanılan kimlik doğrulama türü
category	AuditActionCategory	Yürütülen eylem türü
categoryDisplayName	string	Kategorinin DisplayName'i
correlationId	string	Bu, ilgili denetim girişlerinin birlikte gruplandırılmasına olanak tanır. Bu genellikle tek bir eylem denetim girdilerinin art arda oluşmasına neden olduğunda oluşur. Örneğin, proje oluşturma.
data	object	CUID'ler, öğe adları gibi dış veriler.
details	string	Süslü ayrıntılar
id	string	EventId - Hizmet başına benzersiz olması gerekir
ipAddress	string	Olayın kaynaklandığı IP Adresi
projectId	string	Belirtildiğinde, bu olayın ilişkili olduğu projenin kimliği
projectName	string	Belirtildiğinde, bu olayın ilişkili olduğu projenin adı
scopeDisplayName	string	Kapsamın DisplayName'i
scopeId	string	Kuruluş Kimliği (Kuruluş şu anda desteklenen tek kapsamdır)
scopeType	AuditScopeType	Kapsamın türü (Kuruluş yalnızca şu anda desteklenen kapsamdır)
timestamp	string	Olayın UTC olarak gerçekleştiği saat
userAgent	string	İstekten kullanıcı aracısı

Aracılığıyla paylaş