Создание workplaceSensorDevice

Статья
09/17/2024

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Создайте новое устройство датчика на рабочем месте.

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	❌	❌	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Примечание.

Чтобы приложение с делегированными разрешениями на запись рабочих устройств вошедшего пользователя должно быть членом роли администратора TenantPlacesManagement Exchange Online.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	PlaceDevice.ReadWrite.All	Недоступно.
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	PlaceDevice.ReadWrite.All	Недоступно.

HTTP-запрос

POST /workplace/sensorDevices

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Content-Type	application/json. Обязательно.

Текст запроса

В тексте запроса укажите представление объекта workplaceSensorDevice в формате JSON.

При создании объекта workplaceSensorDevice можно указать следующие свойства.

Свойство	Тип	Описание
description	String	Описание устройства. Необязательный параметр.
deviceId	String	Определяемый пользователем уникальный идентификатор устройства, предоставленный во время создания. Обязательно.
displayName	String	Отображаемое имя устройства. Необязательный параметр.
ipV4Address	String	IPv4-адрес устройства. Необязательный параметр.
ipV6Address	String	IPv6-адрес устройства. Необязательный параметр.
macAddress	String	MAC-адрес устройства. Необязательный параметр.
manufacturer	String	Производитель устройства. Обязательно.
placeId	String	Уникальный идентификатор места, где находится устройство. Если устройство установлено в комнате, оснащенной почтовым ящиком, это свойство должно соответствовать externalDirectoryObjectId или Microsoft Entra идентификатору объекта почтового ящика комнаты. Необязательный параметр.
Датчики	коллекция workplaceSensor	Список датчиков, связанных с устройством, которые собирают и сообщают данные о физических условиях или условиях окружающей среды, таких как заполненность, количество людей, вывод, температура и многое другое. Обязательный атрибут.
tags	Коллекция String	Список настраиваемых тегов, связанных с устройством. Поддерживает `$filter`. Необязательный параметр.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 201 Created и объект workplaceSensorDevice в теле отклика.

Примеры

Запрос

Ниже показан пример запроса.

POST https://graph.microsoft.com/beta/workplace/sensorDevices
Content-Type: application/json

{
    "deviceId": "contoso_9D6816",
    "displayName": "Contoso 9D6816 Device",
    "description": "Contoso 9D6816 Device",
    "macAddress": "00:0A:95:9D:68:16",
    "manufacturer": "Contoso",
    "ipV4Address": "192.168.1.100",
    "ipV6Address": "2001:db8::ff00:42:8329",
    "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671",
    "tags": [
        "Building A",
        "Floor 3",
        "Room 301",
        "Conference Room"
    ],
    "sensors": [
        {
            "sensorType": "occupancy"
        },
        {
            "sensorType": "peopleCount"
        }
    ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new WorkplaceSensorDevice
{
	DeviceId = "contoso_9D6816",
	DisplayName = "Contoso 9D6816 Device",
	Description = "Contoso 9D6816 Device",
	MacAddress = "00:0A:95:9D:68:16",
	Manufacturer = "Contoso",
	IpV4Address = "192.168.1.100",
	IpV6Address = "2001:db8::ff00:42:8329",
	PlaceId = "acfa3bc0-2b83-425b-8910-84a0250e9671",
	Tags = new List<string>
	{
		"Building A",
		"Floor 3",
		"Room 301",
		"Conference Room",
	},
	Sensors = new List<WorkplaceSensor>
	{
		new WorkplaceSensor
		{
			SensorType = WorkplaceSensorType.Occupancy,
		},
		new WorkplaceSensor
		{
			SensorType = WorkplaceSensorType.PeopleCount,
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Workplace.SensorDevices.PostAsync(requestBody);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



mgc-beta workplace sensor-devices create --body '{\
    "deviceId": "contoso_9D6816",\
    "displayName": "Contoso 9D6816 Device",\
    "description": "Contoso 9D6816 Device",\
    "macAddress": "00:0A:95:9D:68:16",\
    "manufacturer": "Contoso",\
    "ipV4Address": "192.168.1.100",\
    "ipV6Address": "2001:db8::ff00:42:8329",\
    "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671",\
    "tags": [\
        "Building A",\
        "Floor 3",\
        "Room 301",\
        "Conference Room"\
    ],\
    "sensors": [\
        {\
            "sensorType": "occupancy"\
        },\
        {\
            "sensorType": "peopleCount"\
        }\
    ]\
}\
'

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewWorkplaceSensorDevice()
deviceId := "contoso_9D6816"
requestBody.SetDeviceId(&deviceId) 
displayName := "Contoso 9D6816 Device"
requestBody.SetDisplayName(&displayName) 
description := "Contoso 9D6816 Device"
requestBody.SetDescription(&description) 
macAddress := "00:0A:95:9D:68:16"
requestBody.SetMacAddress(&macAddress) 
manufacturer := "Contoso"
requestBody.SetManufacturer(&manufacturer) 
ipV4Address := "192.168.1.100"
requestBody.SetIpV4Address(&ipV4Address) 
ipV6Address := "2001:db8::ff00:42:8329"
requestBody.SetIpV6Address(&ipV6Address) 
placeId := "acfa3bc0-2b83-425b-8910-84a0250e9671"
requestBody.SetPlaceId(&placeId) 
tags := []string {
	"Building A",
	"Floor 3",
	"Room 301",
	"Conference Room",
}
requestBody.SetTags(tags)


workplaceSensor := graphmodels.NewWorkplaceSensor()
sensorType := graphmodels.OCCUPANCY_WORKPLACESENSORTYPE 
workplaceSensor.SetSensorType(&sensorType) 
workplaceSensor1 := graphmodels.NewWorkplaceSensor()
sensorType := graphmodels.PEOPLECOUNT_WORKPLACESENSORTYPE 
workplaceSensor1.SetSensorType(&sensorType) 

sensors := []graphmodels.WorkplaceSensorable {
	workplaceSensor,
	workplaceSensor1,
}
requestBody.SetSensors(sensors)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
sensorDevices, err := graphClient.Workplace().SensorDevices().Post(context.Background(), requestBody, nil)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

WorkplaceSensorDevice workplaceSensorDevice = new WorkplaceSensorDevice();
workplaceSensorDevice.setDeviceId("contoso_9D6816");
workplaceSensorDevice.setDisplayName("Contoso 9D6816 Device");
workplaceSensorDevice.setDescription("Contoso 9D6816 Device");
workplaceSensorDevice.setMacAddress("00:0A:95:9D:68:16");
workplaceSensorDevice.setManufacturer("Contoso");
workplaceSensorDevice.setIpV4Address("192.168.1.100");
workplaceSensorDevice.setIpV6Address("2001:db8::ff00:42:8329");
workplaceSensorDevice.setPlaceId("acfa3bc0-2b83-425b-8910-84a0250e9671");
LinkedList<String> tags = new LinkedList<String>();
tags.add("Building A");
tags.add("Floor 3");
tags.add("Room 301");
tags.add("Conference Room");
workplaceSensorDevice.setTags(tags);
LinkedList<WorkplaceSensor> sensors = new LinkedList<WorkplaceSensor>();
WorkplaceSensor workplaceSensor = new WorkplaceSensor();
workplaceSensor.setSensorType(WorkplaceSensorType.Occupancy);
sensors.add(workplaceSensor);
WorkplaceSensor workplaceSensor1 = new WorkplaceSensor();
workplaceSensor1.setSensorType(WorkplaceSensorType.PeopleCount);
sensors.add(workplaceSensor1);
workplaceSensorDevice.setSensors(sensors);
WorkplaceSensorDevice result = graphClient.workplace().sensorDevices().post(workplaceSensorDevice);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const workplaceSensorDevice = {
    deviceId: 'contoso_9D6816',
    displayName: 'Contoso 9D6816 Device',
    description: 'Contoso 9D6816 Device',
    macAddress: '00:0A:95:9D:68:16',
    manufacturer: 'Contoso',
    ipV4Address: '192.168.1.100',
    ipV6Address: '2001:db8::ff00:42:8329',
    placeId: 'acfa3bc0-2b83-425b-8910-84a0250e9671',
    tags: [
        'Building A',
        'Floor 3',
        'Room 301',
        'Conference Room'
    ],
    sensors: [
        {
            sensorType: 'occupancy'
        },
        {
            sensorType: 'peopleCount'
        }
    ]
};

await client.api('/workplace/sensorDevices')
	.version('beta')
	.post(workplaceSensorDevice);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\WorkplaceSensorDevice;
use Microsoft\Graph\Beta\Generated\Models\WorkplaceSensor;
use Microsoft\Graph\Beta\Generated\Models\WorkplaceSensorType;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new WorkplaceSensorDevice();
$requestBody->setDeviceId('contoso_9D6816');
$requestBody->setDisplayName('Contoso 9D6816 Device');
$requestBody->setDescription('Contoso 9D6816 Device');
$requestBody->setMacAddress('00:0A:95:9D:68:16');
$requestBody->setManufacturer('Contoso');
$requestBody->setIpV4Address('192.168.1.100');
$requestBody->setIpV6Address('2001:db8::ff00:42:8329');
$requestBody->setPlaceId('acfa3bc0-2b83-425b-8910-84a0250e9671');
$requestBody->setTags(['Building A', 'Floor 3', 'Room 301', 'Conference Room', 	]);
$sensorsWorkplaceSensor1 = new WorkplaceSensor();
$sensorsWorkplaceSensor1->setSensorType(new WorkplaceSensorType('occupancy'));
$sensorsArray []= $sensorsWorkplaceSensor1;
$sensorsWorkplaceSensor2 = new WorkplaceSensor();
$sensorsWorkplaceSensor2->setSensorType(new WorkplaceSensorType('peopleCount'));
$sensorsArray []= $sensorsWorkplaceSensor2;
$requestBody->setSensors($sensorsArray);


$result = $graphServiceClient->workplace()->sensorDevices()->post($requestBody)->wait();

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.workplace_sensor_device import WorkplaceSensorDevice
from msgraph_beta.generated.models.workplace_sensor import WorkplaceSensor
from msgraph_beta.generated.models.workplace_sensor_type import WorkplaceSensorType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = WorkplaceSensorDevice(
	device_id = "contoso_9D6816",
	display_name = "Contoso 9D6816 Device",
	description = "Contoso 9D6816 Device",
	mac_address = "00:0A:95:9D:68:16",
	manufacturer = "Contoso",
	ip_v4_address = "192.168.1.100",
	ip_v6_address = "2001:db8::ff00:42:8329",
	place_id = "acfa3bc0-2b83-425b-8910-84a0250e9671",
	tags = [
		"Building A",
		"Floor 3",
		"Room 301",
		"Conference Room",
	],
	sensors = [
		WorkplaceSensor(
			sensor_type = WorkplaceSensorType.Occupancy,
		),
		WorkplaceSensor(
			sensor_type = WorkplaceSensorType.PeopleCount,
		),
	],
)

result = await graph_client.workplace.sensor_devices.post(request_body)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже приводится пример отклика.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#workplace/sensorDevices/$entity",
    "id": "ade7078f-4bf5-4239-bfde-95a7c4225df7",
    "deviceId": "contoso_9D6816",
    "displayName": "Contoso 9D6816 Device",
    "description": "Contoso 9D6816 Device",
    "macAddress": "00:0A:95:9D:68:16",
    "manufacturer": "Contoso",
    "ipV4Address": "192.168.1.100",
    "ipV6Address": "2001:db8::ff00:42:8329",
    "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671",
    "tags": [
        "Building A",
        "Floor 3",
        "Room 301",
        "Conference Room"
    ],
    "sensors": [
        {
            "sensorId": "Occupancy",
            "displayName": null,
            "sensorType": "occupancy",
            "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671"
        },
        {
            "sensorId": "PeopleCount",
            "displayName": null,
            "sensorType": "peopleCount",
            "placeId": "acfa3bc0-2b83-425b-8910-84a0250e9671"
        }
    ]
}

Поделиться через

Создание workplaceSensorDevice

Разрешения

HTTP-запрос

Заголовки запросов

Текст запроса

Отклик

Примеры

Запрос

Отклик

Обратная связь

Дополнительные ресурсы