How to pipe Azure Active Directory Data to CSV in PowerShell

The CData Cmdlets Module for Azure Active Directory is a standard PowerShell module offering straightforward integration with Azure Active Directory. Below, you will find examples of using our AzureAD Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Azure Active Directory Data

Azure Active Directory uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the OAuth section in the Help documentation for an authentication guide.

$conn = Connect-AzureAD  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL"

Selecting Data

Follow the steps below to retrieve data from the Domains table and pipe the result into to a CSV file:

Select-AzureAD -Connection $conn -Table Domains | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myDomainsData.csv -NoTypeInformation

You will notice that we piped the results from Select-AzureAD 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" in the result set, and we do not necessarily want that information in our CSV file.

Deleting Data

The following line deletes any records that match the criteria:

Select-AzureAD -Connection $conn -Table Domains -Where "isVerified = TRUE" | Remove-AzureAD

Inserting and Updating Data

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

Import-Csv -Path C:\MyDomainsUpdates.csv | %{
  $record = Select-AzureAD -Connection $AzureAD -Table Domains -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-AzureAD -Connection $azuread -Table Domains -Columns ("id","availabilityStatus") -Values ($_.id, $_.availabilityStatus) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-AzureAD -Connection $azuread -Table Domains -Columns ("id","availabilityStatus") -Values ($_.id, $_.availabilityStatus)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!