Skip to content

Commit 9731107

Browse files
DanielabomDanielabom
authored
Merge pull request #25106 from microsoftgraph/davidk-industryData-beta-Run-Start
IndustryData Run Start beta documenation
2 parents f40e0fa + 2805106 commit 9731107

File tree

8 files changed

+165
-0
lines changed

8 files changed

+165
-0
lines changed

‎api-reference/beta/api/industrydata-industrydatarun-start.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: "industryDataRun: start"
3+
description: "Start a new industryDataRun."
4+
author: "dakelle"
5+
ms.localizationpriority: medium
6+
ms.subservice: "industry-data-etl"
7+
doc_type: apiPageType
8+
ms.date: 01/01/2025
9+
---
10+
11+
# industryDataRun: start
12+
13+
Namespace: microsoft.graph.industryData
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Start a new [industryDataRun](../resources/industrydata-industrydatarun.md). Industry data automates a run every 12 hours; however, users can use the start action to perform an on-demand run. The industry data service throttles the start of runs, allowing up to five successful runs every 12 hours. An on-demand run causes the next system-scheduled run to be skipped if it is set to run within the next 10 hours.
18+
19+
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
20+
21+
## Permissions
22+
23+
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions [only if your app requires it](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference).
24+
25+
<!-- {
26+
"blockType": "permissions",
27+
"name": "industrydata_industrydatarun_start"
28+
}
29+
-->
30+
[!INCLUDE [permissions-table](../includes/permissions/industrydata-industrydatarun-start-permissions.md)]
31+
32+
## HTTP request
33+
34+
<!-- {
35+
"blockType": "ignored"
36+
}
37+
-->
38+
39+
```http
40+
POST /external/industryData/runs/start
41+
```
42+
43+
## Request headers
44+
45+
| Name | Description |
46+
| :------------ | :------------------------ |
47+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
48+
49+
## Request body
50+
51+
Don't supply a request body for this method.
52+
53+
## Response
54+
55+
If successful, this method returns a `202 Accepted` response code. The response also contains a `Location` header, which contains the location of the [longRunningOperation(../resources/longrunningoperation.md). To check the status of this long-running operation, make a GET request to the location URL.
56+
57+
## Examples
58+
59+
### Request
60+
61+
The following example shows a request.
62+
63+
<!-- {
64+
"blockType": "request",
65+
"name": "industrydatarunthis.start"
66+
}
67+
-->
68+
69+
```msgraph-interactive
70+
POST https://graph.microsoft.com/beta/external/industryData/runs/start
71+
```
72+
73+
### Response
74+
75+
The following example shows the response.
76+
77+
<!-- {
78+
"blockType": "response",
79+
"truncated": true
80+
}
81+
-->
82+
``` http
83+
HTTP/1.1 202 Accepted
84+
Location: https://graph.microsoft.com/beta/external/industryData/operations/171bf0b4-14e9-408f-71dd-08dcd2a15d23
85+
```

‎api-reference/beta/api/longrunningoperation-get.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,5 +295,44 @@ Content-type: application/json
295295
}
296296
```
297297

298+
### Example 4: Retrieve a long-running operation from the industry data service
298299

300+
The following example shows how to get a long-running operation for the industry data service.
299301

302+
#### Request
303+
304+
The following example shows a request.
305+
306+
<!-- {
307+
"blockType": "request",
308+
"name": "get_longrunningoperation_industrydata"
309+
}-->
310+
```msgraph-interactive
311+
GET https://graph.microsoft.com/beta/external/industryData/operations/d194fa3e-18c9-47a1-0fb1-08dad8e7a876
312+
```
313+
314+
#### Response
315+
316+
The following example shows the response.
317+
318+
>**Note:** The response object shown here might be shortened for readability.
319+
<!-- {
320+
"blockType": "response",
321+
"truncated": true,
322+
"@odata.type": "microsoft.graph.longRunningOperation"
323+
}
324+
-->
325+
```http
326+
HTTP/1.1 200 OK
327+
Content-Type: application/json
328+
329+
{
330+
"@odata.type": "#microsoft.graph.longRunningOperation",
331+
"createdDateTime": "2022-12-14T05:54:35.400029Z",
332+
"id": "d194fa3e-18c9-47a1-0fb1-08dad8e7a876",
333+
"lastActionDateTime": "2022-12-14T05:54:43.8410226Z",
334+
"resourceLocation": "https://graph.microsoft.com/beta/industryData/dataConnectors/022da4a0-c239-4b07-abed-08dad8e7a07a",
335+
"status": "succeeded",
336+
"statusDetail": null
337+
}
338+
```

‎api-reference/beta/includes/permissions/industrydata-industrydatarun-start-permissions.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|IndustryData-Run.Start|Not available.|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|IndustryData-Run.Start|Not available.|
12+

‎api-reference/beta/resources/industrydata-industrydatarun.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ For details about how statistics can assist with health and monitoring a run gro
3333
| [List](../api/industrydata-industrydatarun-list.md) | [microsoft.graph.industryData.industryDataRun](industrydata-industrydatarun.md) collection | Get a list of the [industryDataRun](industrydata-industrydatarun.md) objects and their properties. |
3434
| [Get](../api/industrydata-industrydatarun-get.md) | [microsoft.graph.industryData.industryDataRun](industrydata-industrydatarun.md) | Read the properties and relationships of an [industryDataRun](industrydata-industrydatarun.md) object. |
3535
| [Get statistics](../api/industrydata-industrydatarun-getstatistics.md) | [microsoft.graph.industryData.industryDataRunStatistics](industrydata-industrydatarunstatistics.md) | Calculate statistics for a run group. |
36+
| [Start](../api/industrydata-industrydatarun-start.md) | None | Start a new [industryDataRun](../resources/industrydata-industrydatarun.md). |
3637

3738
## Properties
3839

‎api-reference/beta/toc/industry-data-etl-(preview)/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ items:
7878
href: ../../api/industrydata-industrydatarun-get.md
7979
- name: Get statistics
8080
href: ../../api/industrydata-industrydatarun-getstatistics.md
81+
- name: Start
82+
href: ../../api/industrydata-industrydatarun-start.md
8183
- name: Outbound provisioning flow set
8284
items:
8385
- name: Outbound provisioning flow set

‎changelog/Microsoft.IndustryData.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
{
22
"changelog": [
3+
{
4+
"ChangeList": [
5+
{
6+
"Id": "42766e66-be8f-4c20-89e6-1941ff8c710a",
7+
"ApiChange": "Method",
8+
"ChangedApiName": "start",
9+
"ChangeType": "Addition",
10+
"Description": "Added the [start](https://learn.microsoft.com/en-us/graph/api/industryData-industryDataRun-start?view=graph-rest-beta) method to the [industryDataRun](https://learn.microsoft.com/en-us/graph/api/resources/industryData-industryDataRun?view=graph-rest-beta) resource.",
11+
"Target": "industryDataRun"
12+
}
13+
],
14+
"Id": "42766e66-be8f-4c20-89e6-1941ff8c710a",
15+
"Cloud": "Prod",
16+
"Version": "beta",
17+
"CreatedDateTime": "2024-09-05T21:59:11.996509Z",
18+
"WorkloadArea": "Industry data ETL",
19+
"SubArea": ""
20+
},
321
{
422
"ChangeList": [
523
{

‎concepts/throttling-limits.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,10 @@ The preceding limits apply to the following resources:
263263

264264
[!INCLUDE [CPIM throttling documentation](../includes/throttling-cpim.md)]
265265

266+
## Industry data ETL service limits
267+
268+
The industry data service limits on-demand [runs](/graph/api/resources/industrydata-industrydatarun) to a maximum of five successful starts every 12 hours.
269+
266270
## Information protection service limits
267271

268272
The following limits apply to any request on `/informationProtection`.

‎concepts/whats-new-overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ For details about previous updates to Microsoft Graph, see [Microsoft Graph what
2929
- Use the [deviceTemplate](/graph/api/resources/devicetemplate?view=graph-rest-beta&preserve-view=true) resource and its associated methods to manage device templates for devices in Microsoft Entra ID.
3030
- Use the [mutualTlsOauthConfiguration](/graph/api/resources/mutualtlsoauthconfiguration?view=graph-rest-beta&preserve-view=true) resource and its associated methods to manage certificate authorities that are permitted to issue certificates for a specific set of objects used for mTLS.
3131

32+
### Industry data ETL
33+
34+
Use the [start](/graph/api/industrydata-industrydatarun-start?view=graph-rest-beta&preserve-view=true) operation on the [industryDataRun](/graph/api/resources/industrydata-industrydatarun?view=graph-rest-beta&preserve-view=true) resource to perform an on-demand run, with throttling limits of up to five successful runs every 12 hours.
35+
3236
## December 2024: New and generally available
3337

3438
### Reports

0 commit comments

Comments
 (0)