Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
configurationSnapshotJob resource type
Namespace: microsoft.graph
Represents an asynchronous job that is created when an admin creates a snapshot. When an admin calls the configurationBaseline: createSnapshot API, a configurationSnapshotJob is created and runs asynchronously. Once the job completes successfully, the admin can download the extraction.
Inherits from entity.
Methods
| Method | Return type | Description |
|---|---|---|
| Create snapshot | configurationSnapshotJob | Create a configurationSnapshotJob asynchronously. |
| List snapshot jobs | configurationSnapshotJob collection | Get a list of the configurationSnapshotJob objects and their properties. |
| Get snapshot job | configurationSnapshotJob | Read the properties and relationships of a configurationSnapshotJob object. |
| Delete snapshot job | None | Delete a configurationSnapshotJob object. |
Properties
| Property | Type | Description |
|---|---|---|
| completedDateTime | DateTimeOffset | The date and time when the snapshot job was completed. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $filter (eq, ne, ge, le) and $orderby. |
| createdBy | identitySet | The user, app, or device that triggered the snapshot. Requires $select to retrieve. Supports $filter (eq). |
| createdDateTime | DateTimeOffset | The date and time when the snapshot job was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Supports $filter (eq, ne, ge, le) and $orderby. |
| description | String | User-friendly description of the snapshot given by the user. Supports $filter (eq, ne, startsWith) and $orderby. |
| displayName | String | User-friendly name provided by the user during snapshot creation. Supports $filter (eq, ne, startsWith) and $orderby. |
| errorDetails | String collection | Details of errors related to the reasons why the snapshot can't complete. Requires $select to retrieve. |
| id | String | Globally unique identifier (GUID) of the snapshot job. Inherited from entity. Supports $filter (eq, ne) and $orderby. |
| resourceLocation | String | The URL at which the snapshot file resides. Requires $select to retrieve. |
| resources | String collection | The names of all resources included in the request body by the user who created the snapshot. Fetched by the system. Requires $select to retrieve. |
| status | snapshotJobStatus | Status of the snapshot. The possible values are: notStarted, running, succeeded, failed, unknownFutureValue, partiallySuccessful. Use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: partiallySuccessful. Supports $filter (eq, ne) and $orderby. |
| tenantId | String | Globally unique identifier (GUID) of the tenant for which the snapshot is created. Supports $filter (eq, ne). |
Relationships
None.
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.configurationSnapshotJob",
"completedDateTime": "String (timestamp)",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"description": "String",
"displayName": "String",
"errorDetails": ["String"],
"id": "String (identifier)",
"resourceLocation": "String",
"resources": ["String"],
"status": "String",
"tenantId": "String"
}
Feedback
Was this page helpful?