שתף באמצעות

ייצוא הערכת מלאי תוכנה לכל מכשיר

  • מאמר

חל על:

רוצה להתנסות ב- Microsoft Defender עבור נקודת קצה? הירשם לקבלת גירסת ניסיון ללא תשלום.

API זה מחזיר את כל הנתונים עבור תוכנה מותקנת בעלת ספירת פלטפורמה נפוצה (CPE), על בסיס כל מכשיר.

קריאות API שונות מקבלות סוגים שונים של נתונים. מאחר שכמות הנתונים יכולה להיות גדולה, ניתן לאחזר שתי דרכים:

  • תגובת JSON להערכת מלאי תוכנה ייצוא ה- API מושך את כל הנתונים בארגון שלך כתגובות ל- Json. שיטה זו מומלצת עבור ארגונים קטנים בעלי פחות מ- 100 K מכשירים. התגובה חלוקה לעמודים, כך שתוכל להשתמש בשדה @odata.nextLink מהתגובה כדי להביא את התוצאות הבאה.

  • ייצוא הערכת מלאי תוכנה באמצעות קבצים פתרון API זה מאפשר משיכת כמויות גדולות יותר של נתונים למהירים ומהימנים יותר. לכן, מומלץ עבור ארגונים גדולים, עם יותר מ- 100 K מכשירים. API זה מושך את כל הנתונים בארגון שלך כהורדת קבצים. התגובה מכילה כתובות URL להורדת כל הנתונים מ- Azure Storage. API זה מאפשר לך להוריד את כל הנתונים שלך מ- Azure Storage באופן הבא:

    • התקשר ל- API כדי לקבל רשימה של כתובות URL להורדה עם כל נתוני הארגון שלך.
    • הורד את כל הקבצים באמצעות כתובות ה- URL להורדה ועבד את הנתונים כרצונך.

הנתונים הנאספים (באמצעות תגובת Json או באמצעות קבצים) הם התמונה הנוכחית של המצב הנוכחי. הוא אינו מכיל נתונים היסטוריים. כדי לאסוף נתונים היסטוריים, על הלקוחות לשמור את הנתונים באחסון הנתונים שלהם.

הערה

אלא אם צוין אחרת, כל שיטות הערכת הייצוא המפורטות הן ייצוא מלא ועל-ידי מכשיר (המכונה גם לכל מכשיר).

1. ייצוא הערכת מלאי תוכנה (תגובת JSON)

תיאור שיטת API 1.1

תגובת API זו מכילה את כל הנתונים של תוכנה מותקנת הכוללת ספירת פלטפורמה נפוצה (CPE), לכל מכשיר. מחזירה טבלה עם ערך עבור כל שילוב ייחודי של DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.

1.1.1 מגבלות

  • גודל העמוד המרבי הוא 200,000.
  • דרג מגבלות עבור API זה הן 30 שיחות בדקה ו- 1000 שיחות בשעה.

1.2 הרשאות

אחת מההרשאות הבאות נדרשת כדי לקרוא ל- API זה. לקבלת מידע נוסף, כולל אופן בחירת הרשאות, ראה שימוש בממשקי MICROSOFT DEFENDER עבור נקודת קצה API לקבלת פרטים.

סוג הרשאה הרשאה שם תצוגה של הרשאה
יישום Software.Read.All 'קרא מידע אודות תוכנה לניהול איומים ופגיעות'
מוסמך (חשבון בעבודה או בבית ספר) Software.Read 'קרא מידע אודות תוכנה לניהול איומים ופגיעות'

1.3 כתובת URL

GET /api/machines/SoftwareInventoryByMachine

1.4 פרמטרים

  • pageSize (ברירת מחדל = 50,000): מספר התוצאות בתגובה.
  • $top: מספר התוצאות להחזרה (לא מוחזר @odata.nextLink ולכן אינו מושך את כל הנתונים)

1.5 מקומות אירוח

הערה

  • כל רשומה היא כ- 0.5KB של נתונים. עליך לקחת זאת בחשבון בעת בחירת הפרמטר pageSize הנכון עבורך.
  • המאפיינים המוגדרים בטבלה הבאה מפורטים בסדר אלפביתי, לפי מזהה מאפיין. בעת הפעלת API זה, הפלט המתוצא לא יוחזר בהכרח בסדר זהה המפורט בטבלה זו.
  • ייתכן שעמודות נוספות מסוימות יוחזרו בתגובה. עמודות אלה הן זמניות וייתכן שיוסרו, נא השתמש בעמודות לתיוכם בלבד.

מאפיין (מזהה) סוג נתונים תיאור דוגמה של ערך מוחזר
מזהה מכשיר מחרוזת מזהה ייחודי עבור המכשיר בשירות. 9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1
שם התקן מחרוזת שם תחום מלא (FQDN) של המכשיר. johnlaptop.europe.contoso.com
נתיבי דיסק Array[string] דיסק מציין כי המוצר מותקן במכשיר. ["C:\Program Files (x86)\Microsoft\Silverlight\Application\silverlight.exe"]
EndOfSupportDate מחרוזת התאריך שבו התמיכה בתוכנה זו תסתיים או תסתיים. 2020-12-30
EndOfSupportStatus מחרוזת מצב סיום התמיכה. יכול להכיל ערכים אפשריים אלה: None, EOS Version, Upcoming EOS Version, EOS Software, Upcoming EOS Software. EOS הקרוב
מספר אפשרויות Int מספר החולשות בתוכנה זו במכשיר זה 3
טופס OSPlatform מחרוזת פלטפורמת מערכת ההפעלה הפועלת במכשיר. אלה הן מערכות הפעלה ספציפיות עם וריאציות בתוך אותה משפחה, כגון Windows 10 ו- Windows 11. ראה ניהול פגיעויות של Microsoft Defender ופלטפורמות הפעלה נתמכות לקבלת פרטים. Windows 10 ו- Windows 11
RbacGroupName מחרוזת הקבוצה בקרת גישה מבוססת תפקיד (RBAC). אם מכשיר זה אינו מוקצה לאף קבוצת RBAC, הערך יהיה "לא מוקצה". אם הארגון אינו מכיל קבוצות RBAC, הערך יהיה 'ללא'. שרתים
נתיבי רישום Array[string] הרישום מציין כי המוצר מותקן במכשיר. ["HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Microsoft Silverlight"]
תוכנותFirstSeenTimestamp מחרוזת בפעם הראשונה שבה תוכנה זו הונראתה במכשיר. 2019-04-07 02:06:47
שם תוכנה מחרוזת שם מוצר התוכנה. Silverlight
תוכנה ודור מחרוזת שם ספק התוכנה. Microsoft
SoftwareVersion מחרוזת מספר הגירסה של מוצר התוכנה. 81.0.4044.138

1.6 דוגמאות

1.6.1 דוגמה לבקשה

GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryByMachine?pageSize=5  &sinceTime=2021-05-19T18%3A35%3A49.924Z

1.6.2 דוגמה לתגובה

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#Collection(contoso.windowsDefenderATP.api.AssetSoftware)",
    "value": [
        {
            "deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "windows_10" "Windows_11",
            "softwareVersion": "10.0.17763.1637",
            "numberOfWeaknesses": 58,
            "diskPaths": [],
            "registryPaths": [],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "Upcoming EOS Version",
            "endOfSupportDate": "2021-05-11T00:00:00+00:00"
        },
        {
            "deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": ".net_framework",
            "softwareVersion": "4.0.0.0",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "SOFTWARE\\Microsoft\\NET Framework Setup\\NDP\\v4.0\\Client\\Install"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        },
        {
            "deviceId": "00044f68765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eed80d086e79bdfa178eadfa25e8de9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "system_center_2012_endpoint_protection",
            "softwareVersion": "4.7.214.0",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Microsoft Security Client"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        },
        {
            "deviceId": "00044f68765ddaf71234bde6bd733d6a9c59ad4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2be2f5ea3142726e63f16a.DomainPII_21eeb80d086e79dbfa178aedfa25e8be9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "configuration_manager",
            "softwareVersion": "5.0.8634.1000",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\{B7D3A842-E826-4542-B39B-1D883264B279}"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        },
        {
            "deviceId": "00044f38765bbaf712342dbe6db733b6a9c59ab4",
            "rbacGroupName": "hhh",
            "deviceName": "ComputerPII_18993b45912eeb224b2de2f5ea3142726e63f16a.DomainPII_21eeb80d086e79bdfa178eadfa25e8be9acfa346.corp.contoso.com",
            "osPlatform": "Windows10" "Windows11",
            "softwareVendor": "microsoft",
            "softwareName": "system_center_2012_endpoint_protection",
            "softwareVersion": "4.10.209.0",
            "numberOfWeaknesses": 0,
            "diskPaths": [],
            "registryPaths": [
                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Microsoft Security Client"
            ],
            "softwareFirstSeenTimestamp": "2020-12-30 11:07:15",
            "endOfSupportStatus": "None",
            "endOfSupportDate": null
        }
    ],
    "@odata.nextLink": "https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryByMachine?pagesize=5&$skiptoken=eyJFeHBvcnREZWZpbml0aW9uIjp7IlRpbWVQYXRoIjoiMjAyMS0wMS0yNS8wMjAwLyJ9LCJFeHBvcnRGaWxlSW5kZXgiOjAsIkxpbmVTdG9wcGVkQXQiOjV9"
}

הערה

המידע שהחזיר API זה, יחד עם המידע שהוחזר על-ידי ה - API להערכת מלאי תוכנה שאינו של קוד מוצר, עבור תוכנה שאינה כוללת CPE, מעניקים לך ניראות מלאה של התוכנה המותקנת ברחבי הארגון והמכשירים שבהם הוא מותקן.

2. ייצוא הערכת מלאי תוכנה (באמצעות קבצים)

תיאור שיטת API 2.1

תגובת API זו מכילה את כל הנתונים של תוכנה מותקנת לכל מכשיר. מחזירה טבלה עם ערך עבור כל שילוב ייחודי של DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.

2.1.1 מגבלות

דרג מגבלות עבור API זה הן 5 שיחות בדקה ו- 20 שיחות בשעה.

2.2 הרשאות

אחת מההרשאות הבאות נדרשת כדי לקרוא ל- API זה. לקבלת מידע נוסף, כולל אופן בחירת הרשאות, ראה שימוש בממשקי MICROSOFT DEFENDER עבור נקודת קצה API לקבלת פרטים.

סוג הרשאה הרשאה שם תצוגה של הרשאה
יישום Software.Read.All 'קרא מידע אודות תוכנה לניהול איומים ופגיעות'
מוסמך (חשבון בעבודה או בבית ספר) Software.Read 'קרא מידע אודות תוכנה לניהול איומים ופגיעות'

2.3 כתובת URL

GET /api/machines/SoftwareInventoryExport

פרמטרים

  • sasValidHours: מספר השעות שכתובות ה- URL להורדה יהיו חוקיות למשך (24 שעות לכל היותר)

2.5 מקומות אירוח

הערה

  • הקבצים הם gzip דחוסים & בתבנית JSON מרובת שורות.
  • כתובות ה- URL להורדה חוקיות למשך 3 שעות בלבד. אחרת, באפשרותך להשתמש בפרמטר.
  • לקבלת מהירות הורדה מרבית של הנתונים שלך, באפשרותך לוודא שאתה מוריד מאותו אזור Azure שבו שוכנים הנתונים שלך.

מאפיין (מזהה) סוג נתונים תיאור דוגמה של ערך מוחזר
ייצוא קבצים array[string] רשימה של כתובות URL להורדה עבור קבצים המחזיקים בתמונה הנוכחית של הארגון "[Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime מחרוזת הזמן שבו הייצוא נוצר. 2021-05-20T08:00:00Z

2.6 דוגמאות

2.6.1 דוגמה לבקשה

GET https://api.securitycenter.microsoft.com/api/machines/SoftwareInventoryExport

2.6.2 דוגמה לתגובה

{
    "@odata.context": "https://api.securitycenter.microsoft.com/api/$metadata#microsoft.windowsDefenderATP.api.ExportFilesResponse",
    "exportFiles": [
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00393-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c000.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=...",
        "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export/2021-01-11/1101/SoftwareInventory/json/OrgId=12345678-195f-4223-9c7a-99fb420fd000/part-00394-e423630d-4c69-4490-8769-a4f5468c4f25.c001.json.gz?sv=2019-12-12&st=2021-01-11T11%3A55%3A51Z&se=2021-01-11T14%3A55%3A51Z&sr=b&sp=r&sig=..."
    ],
    "generatedTime": "2021-01-11T11:01:00Z"
}

למידע נוסף

נושאים קשורים אחרים

עצה

האם ברצונך לקבל מידע נוסף? Engage עם קהילת האבטחה של Microsoft בקהילת הטכנולוגיה שלנו: Microsoft Defender עבור נקודת קצה Tech Community.