REST API'Defender for Cloud Apps

Makale
11/28/2024

Bu makalede HTTPS üzerinden Defender for Cloud Apps ile nasıl etkileşim kurulacak açıklanır.

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

Bulut bulma 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ı

Defender for Cloud 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 Defender for Cloud Apps API URL'sini almak için aşağıdaki adımları uygulayın:

Microsoft Defender Portalı'nda Ayarlar'ı seçin. Ardından Cloud Apps'i seçin. Sistem'in altında Hakkında'yı seçin.
hakkında Defender for Cloud Apps ekranında API URL'sini görebilirsiniz.

API URL'sini aldıktan sonra, API URL'nizi almak için 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

Defender for Cloud Apps, sunucuya yapılan 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 desteklenir?

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

Kaynak	HTTP fiilleri	URI yolları
Faaliyetleri	GET veya POST	/api/v1/activities/
Uyarılar	GET veya POST	/api/v1/alerts/
Veri Zenginleştirme	GET, POST veya DELETE	/api/subnet/
Varlık	GET veya POST	/api/v1/entities/
Dosyalar	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
tam sayı	32 bit imzalı tamsayı
Zaman damgası	Dönemlerden bu yana milisaniyeler

Zaman damga -ları

Defender for Cloud Apps API'sindeki zaman damgalarından bahsetmeler unix zaman damgasına milisaniye cinsinden başvurur. Bu zaman damgası, 1970-01-01 0:00:00 tarihinden itibaren 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ır -ları

İstekte bir sınır 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 bilgi ile 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

Sınır sağlanmazsa varsayılan olarak 100 ayarlanır.
API belirteci ile yapılan tüm istekler için 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 sonucunuz olduğunda, filtreleri kullanarak isteklerde ince ayar yapmak yararlı olacaktır. Bu bölümde filtrelerle birlikte kullanılabilecek ve işleçlerinin yapısı açıklanmaktadır.

Yapı

BAZı API uç noktalarımız 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
}'

Işleç

Not

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

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

Operatör	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
endswith	dize listesi	Sağlanan dizelerden biriyle biten tüm ilgili kayıtları döndürür
Eq	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	sayı	N gün öncesinden 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	sayı	N gün öncesinden ö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ğerlerle veya alt öğelerle 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
Metin	dize	Tüm kayıtlarda tam metin araması gerçekleştirir

Sonraki adımlar

API kimlik doğrulaması

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.

Aracılığıyla paylaş