Esportare la valutazione dell'inventario software per dispositivo

Articolo
04/26/2024

Si applica a:

Se si desidera provare Microsoft Defender per endpoint, iscriversi a una versione di valutazione gratuita.

Questa API restituisce tutti i dati per il software installato con common platform enumeration (CPE) per ogni dispositivo.

Chiamate API diverse ottengono tipi diversi di dati. Poiché la quantità di dati può essere elevata, è possibile recuperarli in due modi:

Esportare la risposta JSON per la valutazione dell'inventario software L'API esegue il pull di tutti i dati nell'organizzazione come risposte Json. Questo metodo è ideale per le organizzazioni di piccole dimensioni con meno di 100 K dispositivi. La risposta viene impaginata, quindi è possibile usare il campo @odata.nextLink dalla risposta per recuperare i risultati successivi.
Esportare la valutazione dell'inventario software tramite file Questa soluzione API consente di eseguire il pull di grandi quantità di dati in modo più rapido e affidabile. È quindi consigliabile per le organizzazioni di grandi dimensioni, con più di 100.000 dispositivi. Questa API esegue il pull di tutti i dati nell'organizzazione come file di download. La risposta contiene URL per scaricare tutti i dati da Archiviazione di Azure. Questa API consente di scaricare tutti i dati da Archiviazione di Azure come indicato di seguito:
- Chiamare l'API per ottenere un elenco di URL di download con tutti i dati dell'organizzazione.
- Scaricare tutti i file usando gli URL di download ed elaborare i dati come si desidera.

I dati raccolti (usando la risposta Json o tramite file) sono lo snapshot corrente dello stato corrente. Non contiene dati cronologici. Per raccogliere dati cronologici, i clienti devono salvare i dati nei propri archivi dati.

Nota

Se non diversamente indicato, tutti i metodi di valutazione dell'esportazione elencati sono l'esportazione completa e per dispositivo (detto anche per dispositivo).

1. Esportare la valutazione dell'inventario software (risposta JSON)

Descrizione del metodo API 1.1

Questa risposta API contiene tutti i dati del software installato con un'enumerazione common platform (CPE) per dispositivo. Restituisce una tabella con una voce per ogni combinazione univoca di DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.

1.1.1 Limitazioni

La dimensione massima della pagina è 200.000.
Le limitazioni di frequenza per questa API sono 30 chiamate al minuto e 1000 chiamate all'ora.

1.2 Autorizzazioni

Per chiamare questa API è necessaria una delle autorizzazioni seguenti. Per altre informazioni, inclusa la scelta delle autorizzazioni, vedere Usare le API Microsoft Defender per endpoint per informazioni dettagliate.

Tipo di autorizzazione	Autorizzazione	Nome visualizzato autorizzazioni
Applicazione	Software.Read.All	'Leggere le informazioni sul software di gestione delle minacce e delle vulnerabilità'
Delegato (account aziendale o dell'istituto di istruzione)	Software.Read	'Leggere le informazioni sul software di gestione delle minacce e delle vulnerabilità'

1.3 URL

GET /api/machines/SoftwareInventoryByMachine

1.4 Parametri

pageSize (valore predefinito = 50.000): numero di risultati in risposta.
$top: numero di risultati da restituire (non restituisce @odata.nextLink e pertanto non esegue il pull di tutti i dati)

1.5 Proprietà

Nota

Ogni record è di circa 0,5 KB di dati. È consigliabile portarlo in considerazione quando si sceglie il parametro pageSize corretto.
Le proprietà definite nella tabella seguente sono elencate in ordine alfabetico, in base all'ID proprietà. Quando si esegue questa API, l'output risultante non verrà necessariamente restituito nello stesso ordine elencato in questa tabella.
Nella risposta potrebbero essere restituite alcune colonne aggiuntive. Queste colonne sono temporanee e potrebbero essere rimosse. Usare solo le colonne documentate.

Proprietà (ID)	Tipo di dati	Descrizione	Esempio di valore restituito
DeviceId	stringa	Identificatore univoco per il dispositivo nel servizio.	9eaf3a8b5962e0e6b1af9ec756664a9b823df2d1
DeviceName	stringa	Nome di dominio completo (FQDN) del dispositivo.	johnlaptop.europe.contoso.com
DiskPaths	Array[string]	Prova su disco che il prodotto è installato nel dispositivo.	["C:\Programmi (x86)\Microsoft\Silverlight\Application\silverlight.exe"]
EndOfSupportDate	stringa	Data in cui il supporto per questo software ha o terminerà.	2020-12-30
EndOfSupportStatus	stringa	Fine dello stato del supporto. Può contenere questi valori possibili: Nessuno, Versione EOS, Prossima versione di EOS, Software EOS, Software EOS imminente.	EOS imminente
NumberOfWeaknesses	int	Numero di punti deboli in questo software in questo dispositivo	3
OSPlatform	stringa	Piattaforma del sistema operativo in esecuzione nel dispositivo. Si tratta di sistemi operativi specifici con variazioni all'interno della stessa famiglia, ad esempio Windows 10 e Windows 11. Per informazioni dettagliate, vedere Gestione delle vulnerabilità di Microsoft Defender sistemi operativi e piattaforme supportati.	Windows10 e Windows 11
RbacGroupName	stringa	Gruppo di controllo degli accessi in base al ruolo. Se questo dispositivo non è assegnato ad alcun gruppo di controllo degli accessi in base al ruolo, il valore sarà "Non assegnato". Se l'organizzazione non contiene gruppi di controllo degli accessi in base al ruolo, il valore sarà "Nessuno".	Server
RegistryPaths	Array[string]	Il Registro di sistema dimostra che il prodotto è installato nel dispositivo.	["HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\Microsoft Silverlight"]
SoftwareFirstSeenTimestamp	stringa	La prima volta che questo software è stato visto sul dispositivo.	2019-04-07 02:06:47
SoftwareName	stringa	Nome del prodotto software.	Silverlight
SoftwareVendor	stringa	Nome del fornitore del software.	Microsoft
SoftwareVersion	stringa	Numero di versione del prodotto software.	81.0.4044.138

Esempi 1.6

1.6.1 Esempio di richiesta

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

Esempio di risposta 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"
}

Nota

Le informazioni restituite da questa API, insieme alle informazioni restituite dall'API export non product code software inventory assessment per il software che non dispone di un CPE, offrono visibilità completa sul software installato nell'organizzazione e sui dispositivi in cui è installato.

2. Esportare la valutazione dell'inventario software (tramite file)

Descrizione del metodo API 2.1

Questa risposta API contiene tutti i dati del software installato per ogni dispositivo. Restituisce una tabella con una voce per ogni combinazione univoca di DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion.

2.1.1 Limitazioni

Le limitazioni di frequenza per questa API sono 5 chiamate al minuto e 20 chiamate all'ora.

2.2 Autorizzazioni

Tipo di autorizzazione	Autorizzazione	Nome visualizzato autorizzazioni
Applicazione	Software.Read.All	'Leggere le informazioni sul software di gestione delle minacce e delle vulnerabilità'
Delegato (account aziendale o dell'istituto di istruzione)	Software.Read	'Leggere le informazioni sul software di gestione delle minacce e delle vulnerabilità'

URL 2.3

GET /api/machines/SoftwareInventoryExport

Parametri

sasValidHours: numero di ore per cui gli URL di download saranno validi (massimo 24 ore)

2.5 Proprietà

Nota

I file sono compressi in gzip & in formato JSON multilinea.
Gli URL di download sono validi solo per 3 ore. In caso contrario, è possibile usare il parametro .
Per la massima velocità di download dei dati, è possibile assicurarsi di scaricare dalla stessa area di Azure in cui si trovano i dati.

Proprietà (ID)	Tipo di dati	Descrizione	Esempio di valore restituito
Esportare file	array[string]	Elenco di URL di download per i file che contengono lo snapshot corrente dell'organizzazione	"[Https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...1", "https://tvmexportstrstgeus.blob.core.windows.net/tvm-export...2"]
GeneratedTime	stringa	Ora in cui è stata generata l'esportazione.	2021-05-20T08:00:00Z

Esempi 2.6

2.6.1 Esempio di richiesta

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

Esempio di risposta 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"
}

Vedere anche

Altri elementi correlati

Consiglio

Per saperne di più, Engage con la community Microsoft Security nella community tech: Microsoft Defender per endpoint Tech Community.

Condividi tramite

Esportare la valutazione dell'inventario software per dispositivo

1. Esportare la valutazione dell'inventario software (risposta JSON)

Descrizione del metodo API 1.1

1.1.1 Limitazioni

1.2 Autorizzazioni

1.3 URL

1.4 Parametri

1.5 Proprietà

Esempi 1.6

1.6.1 Esempio di richiesta

Esempio di risposta 1.6.2

2. Esportare la valutazione dell'inventario software (tramite file)

Descrizione del metodo API 2.1

2.1.1 Limitazioni

2.2 Autorizzazioni

URL 2.3

Parametri

2.5 Proprietà

Esempi 2.6

2.6.1 Esempio di richiesta

Esempio di risposta 2.6.2

Vedere anche

Commenti e suggerimenti

Risorse aggiuntive