Обновление объекта notificationMessageTemplate

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

Примечание. API Microsoft Graph для Intune требует наличия активной лицензии Intune для клиента.

Обновление свойств объекта notificationMessageTemplate.

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

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

Разрешения

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

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

HTTP-запрос

PATCH /deviceManagement/notificationMessageTemplates/{notificationMessageTemplateId}

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

Заголовок	Значение
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.
Accept	application/json

Тело запроса

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

В приведенной ниже таблице указаны свойства, необходимые при создании объекта notificationMessageTemplate.

Свойство	Тип	Описание
id	String	Ключ объекта.
lastModifiedDateTime	DateTimeOffset	Дата и время последнего изменения объекта.
displayName	String	Отображаемое имя для шаблона сообщения уведомления.
defaultLocale	String	Языковой стандарт по умолчанию, который используется, если запрошенный языковой стандарт недоступен.
brandingOptions	notificationTemplateBrandingOptions	Параметры фирменной символики шаблона сообщения. Фирменная символика определяется в консоли администрирования Intune. Возможные значения: none, includeCompanyLogo, includeCompanyName, includeContactInformation, includeCompanyPortalLink, includeDeviceDetails, unknownFutureValue.
roleScopeTagIds	Коллекция строк	Список тегов области для этого экземпляра сущности.

Отклик

В случае успешного выполнения этот метод возвращает код отклика 200 OK и обновленный объект notificationMessageTemplate в теле отклика.

Пример

Запрос

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

HTTP

PATCH https://graph.microsoft.com/v1.0/deviceManagement/notificationMessageTemplates/{notificationMessageTemplateId}
Content-type: application/json
Content-length: 259

{
  "@odata.type": "#microsoft.graph.notificationMessageTemplate",
  "displayName": "Display Name value",
  "defaultLocale": "Default Locale value",
  "brandingOptions": "includeCompanyLogo",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ]
}

C#

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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new NotificationMessageTemplate
{
	OdataType = "#microsoft.graph.notificationMessageTemplate",
	DisplayName = "Display Name value",
	DefaultLocale = "Default Locale value",
	BrandingOptions = NotificationTemplateBrandingOptions.IncludeCompanyLogo,
	RoleScopeTagIds = new List<string>
	{
		"Role Scope Tag Ids value",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DeviceManagement.NotificationMessageTemplates["{notificationMessageTemplate-id}"].PatchAsync(requestBody);

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

CLI

mgc device-management notification-message-templates patch --notification-message-template-id {notificationMessageTemplate-id} --body '{\
  "@odata.type": "#microsoft.graph.notificationMessageTemplate",\
  "displayName": "Display Name value",\
  "defaultLocale": "Default Locale value",\
  "brandingOptions": "includeCompanyLogo",\
  "roleScopeTagIds": [\
    "Role Scope Tag Ids value"\
  ]\
}\
'

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

Go

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

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

requestBody := graphmodels.NewNotificationMessageTemplate()
displayName := "Display Name value"
requestBody.SetDisplayName(&displayName) 
defaultLocale := "Default Locale value"
requestBody.SetDefaultLocale(&defaultLocale) 
brandingOptions := graphmodels.INCLUDECOMPANYLOGO_NOTIFICATIONTEMPLATEBRANDINGOPTIONS 
requestBody.SetBrandingOptions(&brandingOptions) 
roleScopeTagIds := []string {
	"Role Scope Tag Ids value",
}
requestBody.SetRoleScopeTagIds(roleScopeTagIds)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
notificationMessageTemplates, err := graphClient.DeviceManagement().NotificationMessageTemplates().ByNotificationMessageTemplateId("notificationMessageTemplate-id").Patch(context.Background(), requestBody, nil)

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

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

NotificationMessageTemplate notificationMessageTemplate = new NotificationMessageTemplate();
notificationMessageTemplate.setOdataType("#microsoft.graph.notificationMessageTemplate");
notificationMessageTemplate.setDisplayName("Display Name value");
notificationMessageTemplate.setDefaultLocale("Default Locale value");
notificationMessageTemplate.setBrandingOptions(EnumSet.of(NotificationTemplateBrandingOptions.IncludeCompanyLogo));
LinkedList<String> roleScopeTagIds = new LinkedList<String>();
roleScopeTagIds.add("Role Scope Tag Ids value");
notificationMessageTemplate.setRoleScopeTagIds(roleScopeTagIds);
NotificationMessageTemplate result = graphClient.deviceManagement().notificationMessageTemplates().byNotificationMessageTemplateId("{notificationMessageTemplate-id}").patch(notificationMessageTemplate);

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const notificationMessageTemplate = {
  '@odata.type': '#microsoft.graph.notificationMessageTemplate',
  displayName: 'Display Name value',
  defaultLocale: 'Default Locale value',
  brandingOptions: 'includeCompanyLogo',
  roleScopeTagIds: [
    'Role Scope Tag Ids value'
  ]
};

await client.api('/deviceManagement/notificationMessageTemplates/{notificationMessageTemplateId}')
	.update(notificationMessageTemplate);

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

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\NotificationMessageTemplate;


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

$requestBody = new NotificationMessageTemplate();
$requestBody->setOdataType('#microsoft.graph.notificationMessageTemplate');
$requestBody->setDisplayName('Display Name value');
$requestBody->setDefaultLocale('Default Locale value');
$requestBody->setBrandingOptions(new NotificationTemplateBrandingOptions('includeCompanyLogo'));
$requestBody->setRoleScopeTagIds(['Role Scope Tag Ids value', 	]);

$result = $graphServiceClient->deviceManagement()->notificationMessageTemplates()->byNotificationMessageTemplateId('notificationMessageTemplate-id')->patch($requestBody)->wait();

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

PowerShell

Import-Module Microsoft.Graph.DeviceManagement

$params = @{
	"@odata.type" = "#microsoft.graph.notificationMessageTemplate"
	displayName = "Display Name value"
	defaultLocale = "Default Locale value"
	brandingOptions = "includeCompanyLogo"
	roleScopeTagIds = @(
	"Role Scope Tag Ids value"
)
}

Update-MgDeviceManagementNotificationMessageTemplate -NotificationMessageTemplateId $notificationMessageTemplateId -BodyParameter $params

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

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.notification_message_template import NotificationMessageTemplate

graph_client = GraphServiceClient(credentials, scopes)

request_body = NotificationMessageTemplate(
	odata_type = "#microsoft.graph.notificationMessageTemplate",
	display_name = "Display Name value",
	default_locale = "Default Locale value",
	branding_options = NotificationTemplateBrandingOptions.IncludeCompanyLogo,
	role_scope_tag_ids = [
		"Role Scope Tag Ids value",
	],
)

result = await graph_client.device_management.notification_message_templates.by_notification_message_template_id('notificationMessageTemplate-id').patch(request_body)

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

Отклик

Ниже приведен пример отклика. Примечание. Представленный здесь объект отклика может быть усечен для краткости. При фактическом вызове будут возвращены все свойства.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 372

{
  "@odata.type": "#microsoft.graph.notificationMessageTemplate",
  "id": "e1db399b-399b-e1db-9b39-dbe19b39dbe1",
  "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00",
  "displayName": "Display Name value",
  "defaultLocale": "Default Locale value",
  "brandingOptions": "includeCompanyLogo",
  "roleScopeTagIds": [
    "Role Scope Tag Ids value"
  ]
}