Cmdlets for Microsoft Exchange

Build 24.0.9060

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our Exchange Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site. 

Install-Module ExchangeCmdlets

The following line is then added to your profile, loading the cmdlets on the next session: 

Import-Module ExchangeCmdlets;

You can then use the Connect-Exchange cmdlet to create a connection object that can be passed to other cmdlets: 

$conn = Connect-Exchange -User '[email protected]' -Password 'myPassword' -Server 'https://outlook.office365.com/EWS/Exchange.asmx' -Platform 'Exchange_Online'

Connecting to Microsoft Exchange

There are two schemas available for connecting to Exchange:

  • Exchange Web Services (EWS), which is no longer being updated but is still available for both Exchange OnPremise and Exchange Online.
    Note: Microsoft recommends that Exchange Online users switch to Microsoft Graph.
  • Microsoft Graph

For a look at the data model for each of these schemas, see "Data Model".

To switch between EWS and Microsoft Graph, set Schema to either EWS or MSGraph.

Exchange Online users who still want to use EWS should set Schema to EWS and the Platform to Exchange_Online.

Authenticating to Microsoft Exchange OnPremises

Microsoft Exchange OnPremises supports Basic (default), Digest, Negotiate, or NTLM authentication.

Basic (default)

Microsoft Exchange OnPremises defaults sets Basic as the default authentication. To support Basic authentication, set these properties:
  • AuthScheme: Basic.
  • User: The user's login ID.
  • Password: The user's login password.

Digest

To support HTTP Digest authentication in an On-Premises deployment, set these properties:
  • AuthScheme: Digest.
  • User: The user's login ID.
  • Password: The user's login password.

Negotiate

Negotiate is used to direct the driver to negotiate an authentication mechanism with the server. The purpose of this authscheme is to facilitate Kerberos authentication in an On-Premises deployment. To support Kerberos authentication in an On-Premises deployment, set these properties:
  • AuthScheme: Negotiate.
  • User: The user's login ID.
  • Password: The user's login password.

NTLM

To use Windows NT LAN Manager (NTLM) authentication in an On-Premises deployment, set these parameters:
  • AuthScheme: NTLM.
  • User: The user's login Id.
  • Password: The user's login password.

Authenticating to Microsoft Exchange Online

Microsoft Exchange Online supports several types of OAuth-based authentication.

If you are connecting to Exchange Online platform through EWS, set AuthScheme to AzureAD, AzureServicePrincipal, or AzureMSI.

If you connect to Exchange Online through Microsoft Graph, set Schema to MSGraph. When Schema is set to MSGraph, the Platform is ignored.

Azure AD

Azure AD is Microsoft’s multi-tenant, cloud-based directory and identity management service. It is user-based authentication that requires that you set AuthScheme to AzureAD.

Authentication to Azure AD over a Web application always requires the creation of a custom OAuth application. For details, see Creating an Azure AD Application.

Desktop Applications

CData provides an embedded OAuth application that simplifies connection to Azure AD from a Desktop application.

You can also authenticate from a desktop application using a custom OAuth application. (For further information, see Creating an Azure AD Application.) To authenticate via Azure AD, set these parameters:

  • AuthScheme: AzureAD.

  • Custom applications only:

    • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
    • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
    • CallbackURL: The redirect URI you defined when you registered your custom OAuth application.

When you connect, the cmdlet opens Microsoft Exchange's OAuth endpoint in your default browser. Log in and grant permissions to the application.

The cmdlet completes the OAuth process, obtaining an access token from Microsoft Exchange and using it to request data. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the cmdlet refreshes it automatically.

Headless Machines

To configure the driver with a user account on a headless machine, you must authenticate on another device that has an internet browser.

You can do this in either of the following ways:

  • Obtain the OAuthVerifier value as described below in Option 1: Obtain and Exchange a Verifier Code.
  • Install the cmdlet on another machine as described below in Option 2: Transfer OAuth Settings. After you authenticate via the usual browser-based flow, transfer the OAuth authentication values.

Option 1: Obtain and Exchange a Verifier Code

  1. Find the authorization endpoint.

    Custom applications only: Set these properties to create the Authorization URL:

    • OAuthClientId: The client Id assigned when you registered your application.
    • OAuthClientSecret: The client secret assigned when you registered your application.

    Custom and embedded applications: Call the GetOAuthAuthorizationURL stored procedure.

    1. Open the URL returned by the stored procedure in a browser.
    2. Log in and grant permissions to the cmdlet. You are redirected to the callback URL, which contains the verifier code.
    3. Save the value of the verifier code. You will use this later to set the OAuthVerifier connection property.

  2. Exchange the OAuth verifier code for OAuth refresh and access tokens.

    At the headless machine, set these properties:

    • AuthScheme: AzureAD.
    • OAuthVerifier: The verifier code.
    • OAuthSettingsLocation: The location of the file that holds the OAuth token values that persist across connections.

    • Custom applications only:

      • OAuthClientId: The client Id in your custom OAuth application settings.
      • OAuthClientSecret: The client secret in the custom OAuth application settings.

  3. After the OAuth settings file is generated, reset the following properties to connect:

    • OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location grants read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

    • Custom applications only:

      • OAuthClientId: The client Id assigned when you registered your application.
      • OAuthClientSecret: The client secret assigned when you registered your application.

Option 2: Transfer OAuth Settings

Before you can connect via a headless machine, you must create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described above, in Desktop Applications.

After you complete the instructions in Desktop Applications, the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

At the headless machine, set these properties:

  • AuthScheme: AzureAD.
  • OAuthSettingsLocation: The location of your OAuth settings file. Make sure this location gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

  • Custom applications only:

    • OAuthClientId: The client Id assigned when you registered your application.
    • OAuthClientSecret: The client secret assigned when you registered your application.

Azure Service Principal

Azure Service Principal is role-based application-based authentication. This means that authentication is done per application, rather than per user. All tasks taken on by the application are executed without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

For information about how to set up Azure Service Principal authentication, see Creating an Azure AD Application with Service Principal.

Managed Service Identity (MSI)

If you are running Microsoft Exchange on an Azure VM and want to leverage MSI to connect, set AuthScheme to AzureMSI.

User-Managed Identities

To obtain a token for a managed identity, use the OAuthClientId property to specify the managed identity's "client_id".

When your VM has multiple user-assigned managed identities, you must also specify OAuthClientId.

Retrieving Data

The Select-Exchange cmdlet provides a native PowerShell interface for retrieving data: 

$results = Select-Exchange -Connection $conn -Table "Contacts" -Columns @("LastModifiedByName, GivenName") -Where "BusinessAddress_City='Raleigh'"
The Invoke-Exchange cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file: 

Select-Exchange -Connection $conn -Table Contacts -Where "BusinessAddress_City = 'Raleigh'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myContactsData.csv -NoTypeInformation

You will notice that we piped the results from Select-Exchange into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON: 

 
PS C:\> $conn  = Connect-Exchange -User '[email protected]' -Password 'myPassword' -Server 'https://outlook.office365.com/EWS/Exchange.asmx' -Platform 'Exchange_Online'
PS C:\> $row = Select-Exchange -Connection $conn -Table "Contacts" -Columns (LastModifiedByName, GivenName) -Where "BusinessAddress_City = 'Raleigh'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Contacts",
  "Columns":  [

  ],
  "LastModifiedByName":  "MyLastModifiedByName",
  "GivenName":  "MyGivenName"
}

Deleting Data

The following line deletes any records that match the criteria: 

Select-Exchange -Connection $conn -Table Contacts -Where "BusinessAddress_City = 'Raleigh'" | Remove-Exchange

Modifying Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Microsoft Exchange, checking first whether a record already exists and needs to be updated instead of inserted. 

Import-Csv -Path C:\MyContactsUpdates.csv | %{
  $record = Select-Exchange -Connection $conn -Table Contacts -Where ("ItemId = `'"+$_.ItemId+"`'")
  if($record){
    Update-Exchange -Connection $conn -Table Contacts -Columns @("LastModifiedByName","GivenName") -Values @($_.LastModifiedByName, $_.GivenName) -Where "ItemId  = `'$_.ItemId`'"
  }else{
    Add-Exchange -Connection $conn -Table Contacts -Columns @("LastModifiedByName","GivenName") -Values @($_.LastModifiedByName, $_.GivenName)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060