Skip to content

Commit 7777a35

Browse files
authored
Merge pull request #2355 from MicrosoftDocs/diannegali-mdeupdates
updated parameters info
2 parents 9a380a8 + b47b0fd commit 7777a35

9 files changed

+106
-146
lines changed

defender-endpoint/api/export-firmware-hardware-assessment.md

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
ms.date: 11/24/2022
18+
ms.date: 01/08/2025
1919
---
2020

2121
# Export Hardware and firmware assessment inventory per device
@@ -153,39 +153,31 @@ Delegated (work or school account)|Software.Read|'Read Threat and Vulnerability
153153
GET /api/machines/HardwareFirmwareInventoryExport
154154
```
155155

156-
### 2.4 Parameters
157-
158-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours).
159-
160-
### 2.5 Properties (JSON response)
156+
### 2.4 Properties (JSON response)
161157

162158
> [!NOTE]
163-
> The files are gzip compressed & in multiline Json format.
164-
>
165-
> The download URLs are only valid for 3 hours; otherwise, you can use the parameter.
166-
>
167-
> To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
168159
>
169-
> Each record is approximately 1KB of data. You should take this into account when choosing the pageSize parameter that works for you.
170-
>
171-
> Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
160+
> - The files are gzip compressed & in multiline Json format.
161+
> - The download URLs are only valid for 1 hour.
162+
> - To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
163+
> - Each record is approximately 1KB of data. You should take this into account when choosing the pageSize parameter that works for you.
164+
> - Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
172165
173166
Property (ID)|Data type|Description
174167
:---|:---|:---
175168
|Export files|String[array]|A list of download URLs for files holding the current snapshot of the organization.
176169
|GeneratedTime|DateTime|The time the export was generated.
177170

178171

172+
## 2.5 Examples
179173

180-
## 2.6 Example
181-
182-
### 2.6.1 Request example
174+
### 2.5.1 Request example
183175

184176
```http
185177
GET https://api.security.microsoft.com/api/machines/HardwareFirmwareInventoryExport
186178
```
187179

188-
### 2.6.2 Response example
180+
### 2.5.2 Response example
189181

190182
```json
191183
{

defender-endpoint/api/export-security-baseline-assessment.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
ms.date: 05/02/2022
18+
ms.date: 01/08/2025
1919
---
2020

2121
# Export security baselines assessment per device
@@ -158,35 +158,29 @@ Returns all security baselines assessments for all devices, on a per-device basi
158158
GET /api/machines/BaselineComplianceAssessmentExport
159159
```
160160

161-
### 2.4 Parameters
162-
163-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours).
164-
165-
### 2.5 Properties (via files)
161+
### 2.4 Properties (via files)
166162

167163
> [!NOTE]
168-
> The files are gzip compressed & in multiline Json format.
169-
>
170-
> The download URLs are only valid for 3 hours; otherwise you can use the parameter.
171-
>
172-
> To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
173-
>
174-
> Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
164+
>
165+
> - The files are gzip compressed & in multiline Json format.
166+
> - The download URLs are only valid for 1 hours.
167+
> - To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
168+
> - Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
175169

176170
Property (ID)|Data type|Description
177171
:---|:---|:---
178172
|Export files|array[string]|A list of download URLs for files holding the current snapshot of the organization.
179173
|GeneratedTime|String|The time that the export was generated.
180174

181-
## 2.6 Example
175+
## 2.5 Examples
182176

183-
### 2.6.1 Request example
177+
### 2.5.1 Request example
184178

185179
```http
186180
GET https://api.securitycenter.microsoft.com/api/machines/BaselineComplianceAssessmentExport
187181
```
188182

189-
### 2.6.2 Response example
183+
### 2.5.2 Response example
190184

191185
```json
192186
{

defender-endpoint/api/get-assessment-browser-extensions.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
ms.date: 06/01/2022
18+
ms.date: 01/08/2025
1919
---
2020

2121
# Export browser extensions assessment per device
@@ -39,7 +39,7 @@ Different API calls get different types of data. Because the amount of data can
3939

4040
- [Export browser extensions assessment **JSON response**](#1-export-browser-extensions-assessment-json-response) The API pulls all data in your organization as Json responses. This method is best for _small organizations with less than 100-K devices_. The response is paginated, so you can use the \@odata.nextLink field from the response to fetch the next results.
4141

42-
- [Export browser extensions assessment **via files**](#2-export-browser-extension-assessment-via-files) This API solution enables pulling larger amounts of data faster and more reliably. So, it's recommended for large organizations, with more than 100-K devices. This API pulls all data in your organization as download files. The response contains URLs to download all the data from Azure Storage. This API enables you to download all your data from Azure Storage as follows:
42+
- [Export browser extensions assessment **via files**](#2-export-browser-extension-assessment-via-files) This API solution enables pulling larger amounts of data faster and more reliably. This is recommended for large organizations with more than 100-K devices. This API pulls all data in your organization as download files. The response contains URLs to download all the data from Azure Storage. This API enables you to download all your data from Azure Storage as follows:
4343
- Call the API to get a list of download URLs with all your organization data.
4444
- Download all the files using the download URLs and process the data as you like.
4545

@@ -57,7 +57,7 @@ This API response contains all the data for installed browser extensions per dev
5757
#### 1.1.1 Limitations
5858

5959
- Maximum page size is 200,000.
60-
- Rate limitations for this API are 30 calls per minute and 1000 calls per hour.
60+
- Rate limitations for this API are 30 calls per minute and 1,000 calls per hour.
6161

6262
### 1.2 Permissions
6363

@@ -83,11 +83,11 @@ GET /api/Machines/BrowserExtensionsInventoryByMachine
8383

8484
> [!NOTE]
8585
>
86-
> - Each record is approximately 0.5KB of data. You should take this into account when choosing the correct pageSize parameter for you.
87-
> - The properties defined in the following table are listed alphabetically, by property ID. When running this API, the resulting output will not necessarily be returned in the same order listed in this table.
88-
> - Some additional columns might be returned in the response. These columns are temporary and might be removed, please use only the documented columns.
86+
> - Each record is 0.5KB of data. You should take this size into account when choosing the correct pageSize parameter for you.
87+
> - The properties defined in the following table are listed alphabetically, by property ID. When running this API, the resulting output isn't necessarily returned in the same order listed in this table.
88+
> - Some other columns might be returned in the response. These columns are temporary and might be removed so use only the documented columns.
8989
90-
<br>
90+
</br>
9191

9292
****
9393

@@ -103,7 +103,7 @@ ExtensionRisk|string|The highest risk level generated by the browser extension.
103103
ExtensionVersion|string|Version number of a specific browser extension.
104104
IsActivated|Boolean|Indicates whether a browser extension is active.
105105
RbacGroupId|integer|The role-based access control (RBAC) group ID.
106-
RbacGroupName|string|The role-based access control (RBAC) group. If this device is not assigned to any RBAC group, the value will be "Unassigned." If the organization doesn't contain any RBAC groups, the value will be "None."
106+
RbacGroupName|string|The role-based access control (RBAC) group. If this device is not assigned to any RBAC group, the value is "Unassigned." If the organization doesn't contain any RBAC groups, the value is "None."
107107
InstallationTime|string|The time the browser extension was installed.
108108
Permissions|Array[string]|The set of permissions requested by a specific browser extension.
109109

@@ -182,17 +182,13 @@ Delegated (work or school account)|Software.Read|'Read Threat and Vulnerability
182182
GET /api/machines/browserextensionsinventoryExport
183183
```
184184

185-
### 2.4 Parameters
186-
187-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours)
188-
189-
### 2.5 Properties
185+
### 2.4 Properties
190186

191187
> [!NOTE]
192188
>
193189
> - The files are gzip compressed & in multiline JSON format.
194-
> - The download URLs are only valid for 3 hours. Otherwise you can use the parameter.
195-
> - For maximum download speed of your data, you can make sure you are downloading from the same Azure region that your data resides.
190+
> - The download URLs are only valid for 1 hour.
191+
> - For maximum download speed of your data, you can make sure you're downloading from the same Azure region that your data resides.
196192
197193
<br>
198194

defender-endpoint/api/get-assessment-information-gathering.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ ms.topic: reference
1515
ms.subservice: reference
1616
ms.custom: api
1717
search.appverid: met150
18-
19-
ms.date: 07/26/2022
18+
ms.date: 01/08/2025
2019
---
2120

2221
# Information gathering assessment per device
@@ -70,35 +69,29 @@ Delegated (work or school account)|Vulnerability.Read|\'Read Threat and Vulnerab
7069
GET /api/Machines/InfoGatheringExport
7170
```
7271

73-
### 1.4 Parameters
74-
75-
- sasValidHours: The number of hours that the download URLs will be valid for (Maximum 24 hours)
76-
77-
### 1.5 Properties
72+
### 1.4 Properties
7873

7974
> [!NOTE]
80-
> The files are gzip compressed & in multiline Json format.
81-
>
82-
> The download URLs are only valid for 3 hours; otherwise, you can use the parameter.
83-
>
84-
> To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
85-
>
86-
> Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
75+
>
76+
> - The files are gzip compressed & in multiline Json format.
77+
> - The download URLs are only valid for 1 hour.
78+
> - To maximize download speeds, make sure you are downloading the data from the same Azure region where your data resides.
79+
> - Some additional columns might be returned in the response. These columns are temporary and might be removed. Only use the documented columns.
8780
8881
Property (ID)|Data type|Description
8982
:---|:---|:---
9083
|Export files|String[array]|A list of download URLs for files holding the current snapshot of the organization.
9184
|GeneratedTime|DateTime|The time the export was generated.
9285

93-
### 1.6 Examples
86+
### 1.5 Examples
9487

95-
#### 1.6.1 Request example
88+
#### 1.5.1 Request example
9689

9790
```http
9891
GET https://api.securitycenter.microsoft.com/api/machines/InfoGatheringExport?$sasValidHours=1
9992
```
10093

101-
#### 1.6.2 Response example
94+
#### 1.5.2 Response example
10295

10396
```json
10497
{

defender-endpoint/api/get-assessment-methods-properties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Returns all of the installed software and their details on each device.
105105
|Method|Data type|Description|
106106
|:---|:---|:---|
107107
|Export software inventory assessment **(JSON response)**|Software inventory by device collection. See: [2.2 Properties (JSON response)](#22-properties-json-response)|Returns a table with an entry for every unique combination of DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. The API pulls all data in your organization as JSON responses. This method is best for small organizations with less than 100-K devices. The response is paginated, so you can use the @odata.nextLink field from the response to fetch the next results. |
108-
| Export software inventory assessment **(via files)**|Software inventory by device files. See: [2.3 Properties (via files)](#23-properties-via-files)|Returns a table with an entry for every unique combination of DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. This API solution enables pulling larger amounts of data faster and more reliably. So, it's recommended for large organizations, with more than 100-K devices. This API pulls all data in your organization as download files. The response contains URLs to download all the data from Azure Storage. This API enables you to download data from Azure Storage as follows: <ol><li>Call the API to get a list of download URLs with your organization data</li><li>Download the files using the download URLs and process the data as you like.</li></ol> |
108+
|Export software inventory assessment **(via files)**|Software inventory by device files. See: [2.3 Properties (via files)](#23-properties-via-files)|Returns a table with an entry for every unique combination of DeviceId, SoftwareVendor, SoftwareName, SoftwareVersion. This API solution enables pulling larger amounts of data faster and more reliably. So, it's recommended for large organizations, with more than 100-K devices. This API pulls all data in your organization as download files. The response contains URLs to download all the data from Azure Storage. This API enables you to download data from Azure Storage as follows: <ol><li>Call the API to get a list of download URLs with your organization data</li><li>Download the files using the download URLs and process the data as you like.</li></ol> |
109109

110110
### 2.2 Properties (JSON response)
111111

0 commit comments

Comments
 (0)