Build MVC Applications with Connectivity to Azure Data Catalog Data

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Azure Data Catalog ADO.NET Provider

Rapidly create and deploy powerful .NET applications that integrate with Azure Data Catalog.



This article shows how to use only the Entity Framework and the CData ADO.NET provider to access Azure Data Catalog from an ASP.NET MVC application.

This article shows how to use wizards in Visual Studio to drop the CData ADO.NET Provider for Azure Data Catalog into a simple MVC (model, view, controller) project.

Create the Entity Framework Model

Follow the steps below to save connection properties and map tables to entities in the data model.

  1. Create a new MVC project in Visual Studio. In this example, the project name is MvcAzureDataCatalogApp.
  2. If you are using Entity Framework 6, you will need to take the preliminary step of registering the Azure Data Catalog Entity Framework provider for your project. See the "LINQ and Entity Framework" chapter in the help documentation for a guide.

    Note that MVC 3 scaffolding and MVC 4 scaffolding do not support Entity Framework 6. You can use your scaffolding with Entity Framework 6 by upgrading to the latest version of MVC.

  3. To add the .edmx file from the designer, right-click your Models folder and click Add New Item. Select ADO.NET Entity Data Model, name the model, and click Add. In this example, the name of the model is AzureDataCatalogModel.
  4. In the Entity Data Model wizard, select the option 'EF Designer from database'. The Entity Data Model wizard is displayed.
  5. Click New Connection. Select CData Azure Data Catalog Data Source in the dialog that is displayed.
  6. Specify the required connection string properties.

    You can optionally set the following to read the different catalog data returned from Azure Data Catalog.

      CatalogName: Set this to the CatalogName associated with your Azure Data Catalog. To get your Catalog name, navigate to your Azure Portal home page > Data Catalog > Catalog Name

    Connect Using OAuth Authentication

    You must use OAuth to authenticate with Azure Data Catalog. OAuth requires the authenticating user to interact with Azure Data Catalog using the browser. For more information, refer to the OAuth section in the help documentation.

  7. Name the connection and select whether to include sensitive information, such as connection credentials, in the connection string. For simplicity, this example saves sensitive information in Web.config. The connection settings are saved as AzureDataCatalogEntities.

  8. Select the views you need. In this example, Tables is imported. Also, the option to pluralize object names is deselected in this example. Click Finish to create the .edmx file.
  9. Build your project to complete this step.

Scaffold the Controller and Views

After creating the model and building the project, you can use ASP.NET Scaffolding wizards to create the controller and the views.

  1. In Solution Explorer, right-click the controllers folder and click Add -> Controller. Select MVC 5 Controller with views, using Entity Framework.
  2. In the Add Controller dialog that is then displayed, select the following options:

    • Model class: Select a table you imported; for example, Tables.
    • Data context class: Select your context class.
  3. Leave the default values for the other fields.

You can now access the list of Tables records at http://MySite/Tables. With every state change the site picks up any data changes.