Bulut için Defender Uygulamaları REST API'sini

Bu makalede, HTTPS üzerinden Bulut için Defender Uygulamalarıyla nasıl etkileşim kurulacak açıklanır.

Bulut için Microsoft Defender Apps API'si, REST API uç noktaları aracılığıyla Bulut için Defender Uygulamalarına programlı erişim sağlar. Uygulamalar, Bulut için Defender Apps verileri ve nesneleri üzerinde okuma ve güncelleştirme işlemleri gerçekleştirmek için API'yi kullanabilir. Örneğin, Bulut için Defender Uygulamaları API'si bir kullanıcı nesnesi için aşağıdaki yaygın işlemleri destekler:

  • Cloud Discovery için günlük dosyalarını karşıya yükleme
  • Blok betikleri oluşturma
  • Etkinlikleri ve uyarıları listeleme
  • Uyarıları kapatma veya çözme

API URL yapısı

Bulut için Defender Apps API'sini kullanmak için önce kiracınızdan API URL'sini almanız gerekir. API URL'si şu biçimi kullanır: https://<portal_url>/api/<endpoint>.

Kiracınızın Bulut için Defender Uygulamalar API'si URL'sini almak için aşağıdaki adımları uygulayın:

  1. Microsoft Defender Portalı'nda Ayarlar'ı seçin. Ardından Cloud Apps'i seçin. Sistem'in altında Hakkında'yı seçin.

  2. Bulut için Defender Uygulamalar hakkında ekranında API URL'sini görebilirsiniz.

    View your data center.

API URL'sini aldıktan sonra, API URL'nizi almak için buna son eki ekleyin /api . Örneğin, portalınızın URL'si ise https://mytenant.us2.contoso.comAPI URL'niz olur https://mytenant.us2.portal.cloudappsecurity.com/api.

API belirteçleri

Bulut için Defender Uygulamaları, sunucuya yönelik tüm API isteklerinin üst bilgisinde aşağıdaki gibi bir API belirteci gerektirir:

Authorization: Token <your_token_key>

Kişisel API belirteciniz nerededir <your_token_key> ?

API belirteçleri hakkında daha fazla bilgi için bkz . API belirteçlerini yönetme.

API belirteçleri - örnek

curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint"

Hangi eylemler destekleniyor?

Aşağıdaki tabloda desteklenen eylemler açıklanmaktadır:

Kaynak HTTP fiilleri URI yolları
Aktiviteler GET veya POST /api/v1/activities/
Uyarılar GET veya POST /api/v1/alerts/
Veri Zenginleştirme GET, POST veya DELETE /api/subnet/
Varlıklar GET veya POST /api/v1/entities/
Files GET veya POST /api/v1/files/

Burada Kaynak , bir grup ilgili varlığı temsil eder.

Hangi alan türleri desteklenir?

Aşağıdaki tabloda desteklenen alan türleri açıklanmaktadır:

Alan Açıklama
Dize Metin dizesi
boolean True/false değerini temsil eden boole değeri
integer 32 bit imzalı tamsayı
timestamp Dönemlerden bu yana milisaniyeler

Zaman damgaları

Bulut için Defender Uygulamaları API'sindeki zaman damgalarından bahsedilenler, Milisaniye cinsinden Unix zaman damgasına başvurur. Bu zaman damgası, 1970-01-01 0:00:00'dan bu yana geçen milisaniye sayısına göre belirlenir. Tarihleri zaman damgalarına dönüştürmek için get-date PowerShell cmdlet'ini kullanabilirsiniz.

Sınırlar

İstekte bir limit parametresi sağlayarak isteklerinizi sınırlamayı seçebilirsiniz.

Limit parametresini sağlamak için aşağıdaki yöntemler desteklenir:

  • URL ile kodlanmış (üst bilgiyle Content-Type: application/x-www-form-urlencoded )
  • Form verileri
  • JSON gövdesi (ve uygun bir sınır üst bilgisi ile Content-Type: multipart/form-data )

Not

  • Herhangi bir sınır sağlanmazsa, varsayılan olarak 100 ayarlanır.
  • API belirteci ile yapılan tüm isteklerin yanıtları en fazla 100 öğeyle sınırlıdır.
  • Tüm API istekleri için kısıtlama sınırı, kiracı başına dakikada 30 istektir.

Filtreler

Çok sayıda sonuç elde ettiğinizde, filtreleri kullanarak isteklerde ince ayar yapmak yararlı olur. Bu bölümde, filtrelerle kullanılabilen ve işleçlerinin yapısı açıklanmaktadır.

Yapı

API uç noktalarımızdan bazıları sorgu gerçekleştirirken filtreleri destekler. İlgili bölümlerinde, söz konusu kaynak için tüm kullanılabilir filtrelenebilir alanları ve desteklenen işleçleri listeleyen bir başvuru bulacaksınız.

Çoğu filtre, size güçlü sorgular sağlamak için birden çok değeri destekler. Filtreleri ve işleçleri birleştirirken, filtreler arasında mantıksal işleç olarak AND kullanırız.

Filtreler - örnek

curl -XGET -H "Authorization:Token <your_token_key>" "https://<tenant_id>.<tenant_region>.portal.cloudappsecurity.com/api/example-endpoint" -d '{
  "filters": {
    "some.field": {
      "eq": ["value1", "value2"],
      "isset": true
    },
    "some.field2": {
      "gte": 5
    }
  },
  "skip": 5,
  "limit": 10
}'

İşleçler

Not

Tüm işleçler tüm filtrelerle uyumlu değildir.

Aşağıdaki tabloda desteklenen işleçler açıklanmaktadır:

İşleç Yanıt türü Açıklama
içerir dize listesi Sağlanan dizelerden birini içeren tüm ilgili kayıtları döndürür
Deq değer listesi Sağlanan değerlere eşit olmayan bir değer içeren tüm kayıtları döndürür
descendantof değer listesi Değerleri veya alt öğeleriyle eşleşen tüm ilgili kayıtları döndürür
doesnotstartwith dize listesi Sağlanan dizelerin her biriyle başlanmayan tüm ilgili kayıtları döndürür
ilebiter dize listesi Sağlanan dizelerden biriyle biten tüm ilgili kayıtları döndürür
eşittir değer listesi Sağlanan değerlerden birini içeren tüm ilgili kayıtları döndürür
gt tek değer Değeri sağlanan değerden büyük olan tüm kayıtları döndürür
gte tek değer Değeri sağlanan değerden büyük veya buna eşit olan tüm kayıtları döndürür
gte_ndays Numara N günden sonraki tarihe sahip tüm kayıtları döndürür
isnotset boolean "true" olarak ayarlandığında, belirtilen alanda değeri olmayan tüm ilgili kayıtları döndürür
Isset boolean "true" olarak ayarlandığında, belirtilen alanda değeri olan tüm ilgili kayıtları döndürür
lt tek değer Değeri sağlanan değerden küçük olan tüm kayıtları döndürür
lte tek değer Değeri sağlanan değerden küçük veya buna eşit olan tüm kayıtları döndürür
lte_ndays Numara N günden önceki tarihe sahip tüm kayıtları döndürür
ncontains dize listesi Sağlanan dizelerden birini içermeyen tüm ilgili kayıtları döndürür
ndescendantof değer listesi Değerleri veya alt öğeleriyle eşleşmeyen tüm ilgili kayıtları döndürür
Neq değer listesi Sağlanan tüm değerleri içermeyen tüm ilgili kayıtları döndürür
aralık "start" ve "end" alanlarını içeren nesnelerin listesi Sağlanan aralıklardan biri içindeki tüm kayıtları döndürür
startswith dize listesi Sağlanan dizelerden biriyle başlayan tüm ilgili kayıtları döndürür
startswithsingle Dize Sağlanan dizeyle başlayan tüm ilgili kayıtları döndürür
text Dize Tüm kayıtlar için tam metin araması yapar

Sonraki adımlar

Herhangi bir sorunla karşılaşırsanız size yardımcı olmak için buradayız. Ürün sorununuzla ilgili yardım veya destek almak için lütfen bir destek bileti açın.