Tutorial: Register an Azure-aware plug-in using the Plug-in Registration Tool

This walkthrough demonstrates how to register a service endpoint step using the Plug-in Registration Tool. Once configured, Common Data Service (CDS) can post the execution context of the current operation to a Azure solution endpoint. For this walkthrough, the step is registered to post the execution context of the CreateRequest message for an Account entity to the Azure Service Bus.

The following prerequisites must be completed before you start this walkthrough:

  • Access to the Plug-in Registration Tool. To get the Plug-in Registration Tool, see Download tools from NuGet.
  • Your CDS system user account must have the System Customizer or System Administrator role.
  • Have access to a Azure platform service namespace that is configured for SAS authorization, to which CDS will post a message.
  • If you plan to use any other Azure messaging entity other than a queue, for example a relay, there must be a listener application actively listening to the specified solution endpoint for CDS to successfully post to the Azure Service Bus. For more information, see Write a Listener for an Azure Solution.
  • A configured service endpoint with SAS authorization is available in the target organization. More information: Walkthrough: Configure Microsoft Azure (SAS) for integration with CDS.


This walkthrough contains the following steps:

  1. Connect to CDS
  2. Register a service endpoint step for an event
  3. Test the endpoint registration

Connect to CDS

Follow the steps below to connect to CDS using the Plug-in Registration tool.

  1. Run the Plug-in Registration tool.

  2. Click Create New Connection.

  3. In the Login dialog box, select Microsoft 365.

    Login form for an online deployment

  4. If you check Display list of available organizations, you are presented with a list of organizations that you belong to after you click Login. This enables you to choose the organization that you want to register the service endpoint with. Otherwise, your default organization is used.

  5. Enter the indicated information about the server and login account, and then click Login.

Register a service endpoint step for an event

Follow the steps below to register a step for an event on the service endpoint.

  1. Select an existing service endpoint in the tab of the tab of the target organization.

  2. Navigate to the Register menu and click Register New Step.

  3. Fill out the Register New Step dialog box for an account create event as shown in the following figure.

    Creating a service endpoint step

  4. Click Register New Step.

CDS will now post the current message containing the execution context to the service bus whenever an account is created. The post is performed asynchronously and is not executed immediately.

Test the endpoint registration

After you register the endpoint you can test it. A listener must be running or a queue available on the target endpoint for the service bus post from the plug-in to happen.

  1. Open a canvas or model-driven application for the same organization that you registered the service endpoint under.
  2. Create a new Account entity record.
  3. Enter an account name, for example 'Adventure Works Cycle', into the Account Name field, and then click Save.
  4. Wait about 10 minutes for the Azure Service Bus post to occur.
  5. In the Dynamics 365 - Custom model-driven app, select Settings > System > System Jobs.
  6. Open the system job that has the same name that you specified for your service endpoint. Check the status to see if the post was successful, is waiting, or failed.

You can now unregister the endpoint, if so desired, by selecting it in the tool's tree view and click Unregister.

See also

Azure integration for CDS
Introduction to Microsoft Azure Integration with CDS