workbook resource type

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a tenant-scoped Microsoft Security workbook with a display name and a JSON document.

Use the /security/workbooks APIs to manage these resources. This resource is separate from an Excel workbook.

Creating a workbook with POST generates its ID. Using PATCH with a client-selected GUID creates or replaces the workbook at that ID. Repeating the request with the same GUID preserves the workbook's identity. An update replaces the entire content document; it doesn't merge nested properties. The service preserves the original creation audit information.

Inherits from entity.

Methods

Method	Return type	Description
List	microsoft.graph.security.workbook collection	Get the workbooks in the tenant.
Create	microsoft.graph.security.workbook	Create a workbook with a server-generated ID.
Get	microsoft.graph.security.workbook	Get a workbook by its ID.
Update	microsoft.graph.security.workbook	Create or replace a workbook using a client-selected ID.
Delete	None	Delete a workbook by its ID.

Properties

Property	Type	Description
content	microsoft.graph.security.workbookContent	The workbook's JSON document. Required when creating or replacing a workbook. Supply a JSON object, not a JSON-encoded string. Replaced as a whole on update. Omitted from collection responses by default; use $select to include it.
createdAtDateTime	DateTimeOffset	The date and time when the workbook was created. Set by the service and preserved on update. Read-only.
createdByUpn	String	The user principal name recorded when the workbook was created. Set by the service and preserved on update. Read-only.
etag	String	The opaque concurrency token derived from the workbook's storage ETag. Set by the service. Read-only. For conditional updates, use the value returned in the HTTP ETag response header.
id	String	The GUID that identifies the workbook. Required and immutable. Generated by POST or supplied in the PATCH item route for repeatable deployments. Don't supply this property in the request body. Inherits from entity.
lastUpdatedByUpn	String	The user principal name recorded for the most recent update. Set by the service. Read-only.
name	String	The display name of the workbook. Required when creating or replacing a workbook. Maximum length is 256 characters.
updatedAtDateTime	DateTimeOffset	The date and time of the most recent update. Set by the service. Read-only.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.security.workbook",
  "id": "String (identifier)",
  "name": "String",
  "content": {
    "@odata.type": "microsoft.graph.security.workbookContent"
  },
  "etag": "String",
  "createdByUpn": "String",
  "lastUpdatedByUpn": "String",
  "createdAtDateTime": "String (timestamp)",
  "updatedAtDateTime": "String (timestamp)"
}