Create deviceManagementExchangeConnector

Namespace: microsoft.graph

Note: The Microsoft Graph API for Intune requires an active Intune license for the tenant.

Create a new deviceManagementExchangeConnector object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	✅

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All

HTTP Request

POST /deviceManagement/exchangeConnectors

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Accept	application/json

Request body

In the request body, supply a JSON representation for the deviceManagementExchangeConnector object.

The following table shows the properties that are required when you create the deviceManagementExchangeConnector.

Property	Type	Description
id	String	Not yet documented
lastSyncDateTime	DateTimeOffset	Last sync time for the Exchange Connector
status	deviceManagementExchangeConnectorStatus	Exchange Connector Status. Possible values are: none, connectionPending, connected, disconnected, unknownFutureValue.
primarySmtpAddress	String	Email address used to configure the Service To Service Exchange Connector.
serverName	String	The name of the Exchange server.
connectorServerName	String	The name of the server hosting the Exchange Connector.
exchangeConnectorType	deviceManagementExchangeConnectorType	The type of Exchange Connector Configured. Possible values are: onPremises, hosted, serviceToService, dedicated, unknownFutureValue.
version	String	The version of the ExchangeConnectorAgent
exchangeAlias	String	An alias assigned to the Exchange server
exchangeOrganization	String	Exchange Organization to the Exchange server

Response

If successful, this method returns a 201 Created response code and a deviceManagementExchangeConnector object in the response body.

Example

Request

Here is an example of the request.

HTTP

POST https://graph.microsoft.com/v1.0/deviceManagement/exchangeConnectors
Content-type: application/json
Content-length: 490

{
  "@odata.type": "#microsoft.graph.deviceManagementExchangeConnector",
  "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00",
  "status": "connectionPending",
  "primarySmtpAddress": "Primary Smtp Address value",
  "serverName": "Server Name value",
  "connectorServerName": "Connector Server Name value",
  "exchangeConnectorType": "hosted",
  "version": "Version value",
  "exchangeAlias": "Exchange Alias value",
  "exchangeOrganization": "Exchange Organization value"
}

C#

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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new DeviceManagementExchangeConnector
{
	OdataType = "#microsoft.graph.deviceManagementExchangeConnector",
	LastSyncDateTime = DateTimeOffset.Parse("2017-01-01T00:02:49.3205976-08:00"),
	Status = DeviceManagementExchangeConnectorStatus.ConnectionPending,
	PrimarySmtpAddress = "Primary Smtp Address value",
	ServerName = "Server Name value",
	ConnectorServerName = "Connector Server Name value",
	ExchangeConnectorType = DeviceManagementExchangeConnectorType.Hosted,
	Version = "Version value",
	ExchangeAlias = "Exchange Alias value",
	ExchangeOrganization = "Exchange Organization 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.ExchangeConnectors.PostAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc device-management exchange-connectors create --body '{\
  "@odata.type": "#microsoft.graph.deviceManagementExchangeConnector",\
  "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00",\
  "status": "connectionPending",\
  "primarySmtpAddress": "Primary Smtp Address value",\
  "serverName": "Server Name value",\
  "connectorServerName": "Connector Server Name value",\
  "exchangeConnectorType": "hosted",\
  "version": "Version value",\
  "exchangeAlias": "Exchange Alias value",\
  "exchangeOrganization": "Exchange Organization value"\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewDeviceManagementExchangeConnector()
lastSyncDateTime , err := time.Parse(time.RFC3339, "2017-01-01T00:02:49.3205976-08:00")
requestBody.SetLastSyncDateTime(&lastSyncDateTime) 
status := graphmodels.CONNECTIONPENDING_DEVICEMANAGEMENTEXCHANGECONNECTORSTATUS 
requestBody.SetStatus(&status) 
primarySmtpAddress := "Primary Smtp Address value"
requestBody.SetPrimarySmtpAddress(&primarySmtpAddress) 
serverName := "Server Name value"
requestBody.SetServerName(&serverName) 
connectorServerName := "Connector Server Name value"
requestBody.SetConnectorServerName(&connectorServerName) 
exchangeConnectorType := graphmodels.HOSTED_DEVICEMANAGEMENTEXCHANGECONNECTORTYPE 
requestBody.SetExchangeConnectorType(&exchangeConnectorType) 
version := "Version value"
requestBody.SetVersion(&version) 
exchangeAlias := "Exchange Alias value"
requestBody.SetExchangeAlias(&exchangeAlias) 
exchangeOrganization := "Exchange Organization value"
requestBody.SetExchangeOrganization(&exchangeOrganization) 

exchangeConnectors, err := graphClient.DeviceManagement().ExchangeConnectors().Post(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

DeviceManagementExchangeConnector deviceManagementExchangeConnector = new DeviceManagementExchangeConnector();
deviceManagementExchangeConnector.setOdataType("#microsoft.graph.deviceManagementExchangeConnector");
OffsetDateTime lastSyncDateTime = OffsetDateTime.parse("2017-01-01T00:02:49.3205976-08:00");
deviceManagementExchangeConnector.setLastSyncDateTime(lastSyncDateTime);
deviceManagementExchangeConnector.setStatus(DeviceManagementExchangeConnectorStatus.ConnectionPending);
deviceManagementExchangeConnector.setPrimarySmtpAddress("Primary Smtp Address value");
deviceManagementExchangeConnector.setServerName("Server Name value");
deviceManagementExchangeConnector.setConnectorServerName("Connector Server Name value");
deviceManagementExchangeConnector.setExchangeConnectorType(DeviceManagementExchangeConnectorType.Hosted);
deviceManagementExchangeConnector.setVersion("Version value");
deviceManagementExchangeConnector.setExchangeAlias("Exchange Alias value");
deviceManagementExchangeConnector.setExchangeOrganization("Exchange Organization value");
DeviceManagementExchangeConnector result = graphClient.deviceManagement().exchangeConnectors().post(deviceManagementExchangeConnector);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const deviceManagementExchangeConnector = {
  '@odata.type': '#microsoft.graph.deviceManagementExchangeConnector',
  lastSyncDateTime: '2017-01-01T00:02:49.3205976-08:00',
  status: 'connectionPending',
  primarySmtpAddress: 'Primary Smtp Address value',
  serverName: 'Server Name value',
  connectorServerName: 'Connector Server Name value',
  exchangeConnectorType: 'hosted',
  version: 'Version value',
  exchangeAlias: 'Exchange Alias value',
  exchangeOrganization: 'Exchange Organization value'
};

await client.api('/deviceManagement/exchangeConnectors')
	.post(deviceManagementExchangeConnector);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

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


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

$requestBody = new DeviceManagementExchangeConnector();
$requestBody->setOdataType('#microsoft.graph.deviceManagementExchangeConnector');
$requestBody->setLastSyncDateTime(new \DateTime('2017-01-01T00:02:49.3205976-08:00'));
$requestBody->setStatus(new DeviceManagementExchangeConnectorStatus('connectionPending'));
$requestBody->setPrimarySmtpAddress('Primary Smtp Address value');
$requestBody->setServerName('Server Name value');
$requestBody->setConnectorServerName('Connector Server Name value');
$requestBody->setExchangeConnectorType(new DeviceManagementExchangeConnectorType('hosted'));
$requestBody->setVersion('Version value');
$requestBody->setExchangeAlias('Exchange Alias value');
$requestBody->setExchangeOrganization('Exchange Organization value');

$result = $graphServiceClient->deviceManagement()->exchangeConnectors()->post($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.DeviceManagement.Administration

$params = @{
	"@odata.type" = "#microsoft.graph.deviceManagementExchangeConnector"
	lastSyncDateTime = [System.DateTime]::Parse("2017-01-01T00:02:49.3205976-08:00")
	status = "connectionPending"
	primarySmtpAddress = "Primary Smtp Address value"
	serverName = "Server Name value"
	connectorServerName = "Connector Server Name value"
	exchangeConnectorType = "hosted"
	version = "Version value"
	exchangeAlias = "Exchange Alias value"
	exchangeOrganization = "Exchange Organization value"
}

New-MgDeviceManagementExchangeConnector -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.device_management_exchange_connector import DeviceManagementExchangeConnector

graph_client = GraphServiceClient(credentials, scopes)

request_body = DeviceManagementExchangeConnector(
	odata_type = "#microsoft.graph.deviceManagementExchangeConnector",
	last_sync_date_time = "2017-01-01T00:02:49.3205976-08:00",
	status = DeviceManagementExchangeConnectorStatus.ConnectionPending,
	primary_smtp_address = "Primary Smtp Address value",
	server_name = "Server Name value",
	connector_server_name = "Connector Server Name value",
	exchange_connector_type = DeviceManagementExchangeConnectorType.Hosted,
	version = "Version value",
	exchange_alias = "Exchange Alias value",
	exchange_organization = "Exchange Organization value",
)

result = await graph_client.device_management.exchange_connectors.post(request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.type": "#microsoft.graph.deviceManagementExchangeConnector",
  "id": "e11c1de8-1de8-e11c-e81d-1ce1e81d1ce1",
  "lastSyncDateTime": "2017-01-01T00:02:49.3205976-08:00",
  "status": "connectionPending",
  "primarySmtpAddress": "Primary Smtp Address value",
  "serverName": "Server Name value",
  "connectorServerName": "Connector Server Name value",
  "exchangeConnectorType": "hosted",
  "version": "Version value",
  "exchangeAlias": "Exchange Alias value",
  "exchangeOrganization": "Exchange Organization value"
}