deviceTemplate resource type
Namespace: microsoft.graph
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 property values that are common to a set of device objects. The properties on the template are stamped on any device object that is created based on this template. This object is immutable.
Inherits from directoryObject.
Methods
| Method | Return type | Description |
|---|---|---|
| List | deviceTemplate collection | Get a list of deviceTemplate objects registered in the directory. |
| Create | deviceTemplate | Create a new deviceTemplate used to identify attributes and manage a group of devices with similar characteristics. |
| Get | deviceTemplate | Get the properties and relationships of a deviceTemplate object. |
| Delete | None | Delete a registered deviceTemplate. |
| List owners | directoryObject collection | Get a list of owners for a deviceTemplate object. |
| Add owner | None | Add a new owner to a deviceTemplate object. |
| Remove owner | None | Remove an owner from a deviceTemplate object. |
| Create device from template | device | Create a new device from a deviceTemplate. |
Properties
| Property | Type | Description |
|---|---|---|
| deletedDateTime | DateTimeOffset | Date and time when this object was deleted. Always null when the object hasn't been deleted. Inherited from directoryObject. |
| deviceAuthority | String | A tenant-defined name for the party that's responsible for provisioning and managing devices on the Microsoft Entra tenant. For example, Tailwind Traders (the manufacturer) makes security cameras that are installed in customer buildings and managed by Lakeshore Retail (the device authority). This value is provided to the customer by the device authority (manufacturer or reseller). |
| id | String | The unique identifier for the object. Inherited from directoryObject. Read-only. Supports $filter (eq, in). |
| manufacturer | String | Manufacturer name. |
| model | String | Model name. |
| mutualTlsOauthConfigurationId | String | Object ID of the mutualTlsOauthConfiguration. This value isn't required if self-signed certificates are used. This value is provided to the customer by the device authority (manufacturer or reseller). |
| mutualTlsOauthConfigurationTenantId | String | ID (tenant ID for device authority) of the tenant that contains the mutualTlsOauthConfiguration. This value isn't required if self-signed certificates are used. This value is provided to the customer by the device authority (manufacturer or reseller). |
| operatingSystem | String | Operating system type. Supports $filter (eq, in). |
Relationships
| Relationship | Type | Description |
|---|---|---|
| deviceInstances | device collection | Collection of device objects created based on this template. |
| owners | directoryObject collection | Collection of directory objects that can manage the device template and the related deviceInstances. Owners can be represented as service principals, users, or applications. An owner has full privileges over the device template and doesn't require other administrator roles to create, update, or delete devices from this template, as well as to add or remove template owners. There can be a maximum of 100 owners on a device template. Supports $expand. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.deviceTemplate",
"deletedDateTime": "String (timestamp)",
"deviceAuthority": "String",
"id": "String (identifier)",
"manufacturer": "String",
"model": "String",
"mutualTlsOauthConfigurationId": "String",
"mutualTlsOauthConfigurationTenantId": "String",
"operatingSystem": "String"
}