cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
MattB-MSFT
Microsoft
Microsoft

Announcing the .net Core SDK for Common Data Service (CDS) - External Client Development

This Post has been superseded by net-SDK-for-Dataverse-Dataverse-ServiceClient 

 

 

Folks, 

As many of you know, we have a existing .net full framework SDK that we provide for folks to develop client applications that communicate with CDS.  This SDK has existed for a long period and arose from the Dynamics 365 aspects of our platform. 

We have continued to support this SDK over the last many years over many versions of our platform.   

 

We have been working to update this SDK package to better address the needs of the current platform and the technologies that many of our partners who develop client applications to integrate with the Power Platform use.   We are now ready to share this with the larger community for testing and feedback. 

 

Today we have posted the alpha version of the Microsoft.Powerplatform.Cds.Client on nuget.  along with a few additional packages that we are using to split out the Dynamics Sales / Service and Marketing centric messages and helpers from the core CDS platform SDK

 

This version of the SDK libs supports the following and has the following notices: 

  1. .net full framework 4.6.2, 4.7.2, 4.8 and .net core 3.0, 3.1 
  2. We are supporting only Client Secret / Cert flows for .net core.  On .net framework additionally we support OAuth User flows
  3. We are shipping the initial drop using ADAL.net for the Auth Lib.   We MAY change to use MSAL shortly 
    1. MSAL would enabled us to support User Interactive flows on .net core. 
  4. The Namespaces of areas WILL change.  We do not know what they will change too just yet but they will change before we “release” this.
  5. The Assembly Names Will likely change at least once more. 
  6. The Message types that are part of the client have been reduced to CDS Core server messages only.  Things like “QualifyLeadRequest” have been removed to their own Nuget package ( Microsoft.Dynamics.Sdk.Messages ) 
  7. We will likely ship more extension packages that will contain the “CRM” messages,  though over time, we will likely split the namespaces of those messages up based on service line,  think Field Service or Sales or Customer Service, etc..
  8. Plugin Development using this Client is NOT supported at this time. 

We have pushed the first version up to nuget,  its tagged as preview and I encourage you to read the release notes we provide with the nuget packages. As with most of our Nuget packages that are intended as tools or for developer consumption, we extensively comment in release notes. 

 

Samples and such will be updated overtime on the PowerApps Samples GitHub Site as we move forward with the evolution of this capability.   That said, any of the existing CrmServiceClient samples can be used as a base to start.

 

From a scenario point of view,  we are particularity interested in any issues or challenges when using these library in either Asp.net Core or Functions scenarios. 

 

Links for the packages:

https://www.nuget.org/packages/Microsoft.Powerplatform.Cds.Client

https://www.nuget.org/packages/Microsoft.Powerplatform.Cds.Client.Dynamics

https://www.nuget.org/packages/Microsoft.Dynamics.Sdk.Messages

 

for 99% of your applications working against Dynamics, you should only need Microsoft.Powerplatform.Cds.Client and Microsoft.Dynamics.Sdk.Messages.

if your working against CDS Only,  you should only need Microsoft.Powerplatform.Cds.Client.  If you do not experience that, or find missing messages in the CDS only scenarios, please let us know. 

 

Note: Please be aware that during the Alpha \ Beta phases, these nuget packages are not supported via official channels

Support is aware of them, however you will likely be directed back to the community forums for support during the Alpha \ Beta phases.  A number of our dev's and PM's do monitor this channel and can respond to questions and feedback. 

 

As we progress this process it is our intent to deprecate then retire the older Microsoft.Xrm.Tooling.* Packages and replace them with updates built on this new set of Nuget Packages. 

 

Thanks All, and we look forward to your feedback on this.

 

Update:  We have setup a github issues site to track issues for this effort: 

Update#2:  We have now begun posting the code for the CdsServiceClient on this git Hub repro for reference. 

Please find the site here: https://github.com/microsoft/PowerPlatform-CdsServiceClient 

 

MattB-MSFT.  

 

47 REPLIES 47
Artem_Grunin
New Member

@MattB-MSFT, why not to enable the following old tech from Microsoft's Jeffrey Richter: https://blogs.msdn.microsoft.com/microsoft_press/2010/02/03/jeffrey-richter-excerpt-2-from-clr-via-c...:

Then add these DLLs to your Visual Studio project. For each DLL file you add, display its properties and change its “Build Action” to “Embedded Resource.” This causes the C# compiler to embed the DLL file(s) into your EXE file, and you can deploy this one EXE file. At runtime, the CLR won’t be able to find the dependent DLL assemblies, which is a problem. To fix this, when your application initializes, register a callback method with the AppDomain’s ResolveAssembly event.

 

It works like a charm and has zero impact on build time. There are tools like this https://github.com/Fody/Costura that make "merging" setup a single package installation step. This one use Einar Egilsson's suggestion to use module initializes to enable this tech for DLL's as well.

 

Unfortunately, we can't access ResolveAssembly event in Sandbox, but it works on-premise for not isolated plugins. If you can't enable this event for security reasons, you can add appropriate resolver for us and everybody win.

 

p.s. .NET Core 3 should support single assembly compilation, don't it? If .NET Core + Standard is our future, I guess, we can leave with ILMerge/ILRepack for a while 🙂

Anonymous
Not applicable

Hello @MattB-MSFT  @BetimBeja ,
First thank you guys for you answer, it was very useful 😄
the Secret Client authentification work perfectly in Windows, but in Linux i get error :'(

Microsoft.Powerplatform.Cds.Client.Utils.CdsConnectionException: Failed to connect to Common Data Service
---> System.AggregateException: One or more errors occurred. (The request channel timed out attempting to send after 00:02:00. Increase the timeout value passed to the call to Request or increase the SendTimeout value on the Binding. The time allotted to this operation may have been a portion of a longer timeout.)
---> System.TimeoutException: The request channel timed out attempting to send after 00:02:00. Increase the timeout value passed to the call to Request or increase the SendTimeout value on the Binding. The time allotted to this operation may have been a portion of a longer timeout.
---> System.TimeoutException: The HTTP request to 'https://vsmptest.crm4.dynamics.com/XRMServices/2011/Organization.svc/web?SDKClientVersion=9.0.45.79' has exceeded the allotted timeout of 00:02:00. The time allotted to this operation may have been a portion of a longer timeout.
at System.ServiceModel.Channels.HttpChannelFactory`1.HttpClientRequestChannel.HttpClientChannelAsyncRequest.SendRequestAsync(Message message, TimeoutHelper timeoutHelper)
at System.ServiceModel.Channels.RequestChannel.RequestAsync(Message message, TimeSpan timeout)
--- End of inner exception stack trace ---

Cordially



Folks,  we have stood up an github issues site to track issue and provide status updates for the CdsServiceClient and its surrounding bits. 

Please find the site here: https://github.com/microsoft/PowerPlatform-CdsServiceClient 

 

@BetimBeja I have forward the issue your describing over to the auth team to have a look,  an Anonymous response is defiantly not what we want in this situation. 

 

@Anonymous that looks a lot like a network issue,  are you using a Linux hosted function there? or are you hosting it on your own box?

 

 

MarkData8
Advocate I
Advocate I

Is there an intention of supporting additional authentication types for .NET Core before GA? We currently connect to customer's on-prem instances with and without IFDs as well as online instances, and currently the CRM SDK is the only thing holding us back from switching fully to .NET Core/Standard.

We are considering supporting Active Directory Only for onPrem where ADFS is not present. 

 

Thanks

MattB. 

Hi Matt

 

Any plans to deliver an early bound generation tool for .NET Core (CrmSvcUtil)?

 

Thanks!

The current CrmServiceUtil generates classes that work cleanly with the .net core clients. 

 

Insofar as building a version that will codegen based on .net core.  at this time no. 

Its not on our short term list as .net core is missing a good deal of the code dom we use to do mutilanguage generation in CrmServiceUtil. 

 

That said, as .net core evolves our options may change. 

 

Could you outline your use case for needing it?

 

thanks

 

If the generated classes work with .NET core I'm fine. I don't need a .NET core based version of the tool itself.

My use case is to communicate with CDS from an Azure Function using Web API combined with early bound classes.

MarkData8
Advocate I
Advocate I

As far as I can tell, the new SDK will only support connecting via Web API and not SOAP, is that correct? What is the earliest version that it will connect to - 8.0?

 

For on-prem IFD instances with ADFS, what authentication methods are planned to be supported?

Anonymous
Not applicable

Hello @MattB-MSFT 

Can you give us an exact date of the first stable release

Thank you

Cordially

Helpful resources

Announcements

Microsoft Ignite 2023: The Recap

What an amazing event we had this year, as Microsoft showcased the latest advancements in how AI has the potential to reshape how customers, partners and developers strategize the future of work. Check out below some of our handpicked videos and Ignite announcements to see how Microsoft is driving real change for users and businesses across the globe.   Video Highlights Click the image below to check out a selection of Ignite 2023 videos, including the "Microsoft Cloud in the era of AI" keynote from Scott Guthrie, Charles Lamanna, Arun Ulag, Sarah Bird, Rani Borkar, Eric Boyd, Erin Chapple, Ali Ghodsi, and Seth Juarez. There's also a great breakdown of the amazing Microsoft Copilot Studio with Omar Aftab, Gary Pretty, and Kendra Springer, plus exciting sessions from Rajesh Jha, Jared Spataro, Ryan Jones, Zohar Raz, and many more.     Blog Announcements Microsoft Copilot presents an opportunity to reimagine the way we work—turning natural language into the most powerful productivity tool on the planet. With AI, organizations can unearth value in data across productivity tools like business applications and Microsoft 365. Click the link below to find out more.     Check out the latest features in Microsoft Power Apps that will help developers create AI-infused apps faster, give administrators more control over managing thousands of Microsoft Power Platform makers at scale, and deliver better experiences to users around the world. Click the image below to find out more.     Click below to discover new ways to orchestrate business processes across your organization with Copilot in Power Automate. With its user-friendly interface that offers hundreds of prebuilt drag-and-drop actions, more customers have been able to benefit from the power of automation.     Discover how Microsoft Power Platform and Microsoft Dataverse are activating the strength of your enterprise data using AI, the announcement of “plugins for Microsoft Copilot for Microsoft 365”, plus two new Power Apps creator experiences using Excel and natural language.       Click below to find out more about the general availability of Microsoft Fabric and the public preview of Copilot in Microsoft Fabric. With the launch of these next-generation analytics tools, you can empower your data teams to easily scale the demand on your growing business.     And for the rest of all the good stuff, click the link below to visit the Microsoft Ignite 2023 "Book of News", with over ONE HUNDRED announcements across infrastructure, data, security, new tools, AI, and everything else in-between!        

Back to Basics Tuesday Tip #9: All About the Galleries

This is the ninth post in our series dedicated to helping the amazing members of our community--both new members and seasoned veterans--learn and grow in how to best engage in the community! Each Tuesday, we feature new content that will help you best understand the community--from ranking and badges to profile avatars, from Super Users to blogging in the community. Our hope is that this information will help each of our community members grow in their experience with Power Platform, with the community, and with each other!     Today's Tip: All About the Galleries Have you checked out the library of content in our galleries? Whether you're looking for the latest info on an upcoming event, a helpful webinar, or tips and tricks from some of our most experienced community members, our galleries are full of the latest and greatest video content for the Power Platform communities.   There are several different galleries in each community, but we recommend checking these out first:   Community Connections & How-To Videos Hosted by members of the Power Platform Community Engagement  Team and featuring community members from around the world, these helpful videos are a great way to "kick the tires" of Power Platform and find out more about your fellow community members! Check them out in Power Apps, Power Automate, Power Pages, and Copilot Studio!         Webinars & Video Gallery Each community has its own unique webinars and videos highlighting some of the great work being done across the Power Platform. Watch tutorials and demos by Microsoft staff, partners, and community gurus! Check them out: Power Apps Webinars & Video Gallery Power Automate Webinars & Video Gallery Power Pages Webinars & Video Gallery Copilot Studio Webinars & Video Gallery   Events Whether it's the excitement of the Microsoft Power Platform Conference, a local event near you, or one of the many other in-person and virtual connection opportunities around the world, this is the place to find out more about all the Power Platform-centered events. Power Apps Events Power Automate Events Power Pages Events Copilot Studio Events   Unique Galleries to Each Community Because each area of Power Platform has its own unique features and benefits, there are areas of the galleries dedicated specifically to videos about that product. Whether it's Power Apps samples from the community or the Power Automate Cookbook highlighting unique flows, the Bot Sharing Gallery in Copilot Studio or Front-End Code Samples in Power Pages, there's a gallery for you!   Check out each community's gallery today! Power Apps Gallery Power Automate Gallery Power Pages Gallery Copilot Studio Gallery

Unlocking the Power of Community: A Journey with Featued User Group leaders Geetha Sivasailam and Ben McMann

In the bustling world of technology, two dynamic leaders, Geetha Sivasailam and Ben McMann, have been at the forefront, steering the ship of the Dallas Fort Worth Power Platform User Group since its inception in February 2019. As Practice Lead (Power Platform | Fusion Dev) at Lantern, Geetha brings a wealth of consulting experience, while Ben, a key member of the Studio Leadership team at Lantern, specializes in crafting strategies that leverage Microsoft digital technologies to transform business models.   Empowering Through Community Leadership Geetha and Ben's journey as user group leaders began with a simple yet powerful goal: to create a space where individuals across the DFW area could connect, grow their skills, and add value to their businesses through the Power Platform. The platform, known for its versatility, allows users to achieve more with less code and foster creativity.   The Power of Community Impact Reflecting on their experiences, Geetha and Ben emphasize the profound impact that community engagement has had on both their professional and personal lives. The Power Platform community, they note, is a wellspring of resources and opportunities, fostering continuous learning, skill enhancement, and networking with industry experts and peers.   Favorite Moments and Words of Wisdom The duo's favorite aspect of leading the user group lies in witnessing the transformative projects and innovations community members create with the Power Platform. Their advice to aspiring user group leaders? "Encourage diverse perspectives, maintain an open space for idea-sharing, stay curious, and, most importantly, have fun building a vibrant community."   Building Bridges, Breaking Barriers Geetha and Ben encourage others to step into the realm of user group leadership, citing the rewarding experience of creating and nurturing a community of like-minded individuals. They highlight the chance to influence, impact, and positively guide others, fostering connections that extend beyond mere technology discussions.   Joining a User Group: A Gateway to Growth The leaders stress the importance of joining a user group, emphasizing exposure to diverse perspectives, solutions, and career growth opportunities within the Power Platform community. "Being part of such a group provides a supportive environment for seeking advice, sharing experiences, and navigating challenges."   A Year of Milestones Looking back at the past year, Geetha and Ben express pride in the group's growth and global participation. They recount the enriching experience of meeting members in person at the Microsoft Power Platform conference, showcasing the diverse range of perspectives and guest speakers that enriched the community's overall experience.   Continuous Learning on the Leadership Journey As user group leaders, Geetha and Ben recognize the continuous learning curve, blending interpersonal skills, adaptability, and dedication to foster a vibrant community. They highlight the importance of patience, persistence, and flexibility in achieving group goals, noting the significance of listening to the needs and suggestions of group members.They invite all tech enthusiasts to join the Dallas Fort Worth Power Platform User Group, a thriving hub where the power of community propels individuals to new heights in the dynamic realm of technology.

Visit the Community Lounge at Microsoft Ignite!

Are you attending Microsoft Ignite in Seattle this week? If so, we'd love to see you at the Community Lounge! Hosted by members of our Community team, it's a great place to connect, meet some Microsoft executives, and get a sticker or two. And if you're an MVP there are some special opportunities to meet up!     The Community Lounge is more than just a space—it's a hub of activity, collaboration, and camaraderie. So, dive in, explore, and make the most of your Microsoft Ignite experience by immersing yourself in the vibrant and dynamic community that awaits you.Find out the schedule and all the details here: Community Lounge at Ignite! See you at #MSIgnite!    

Back to Basics Tuesday Tip #8: Subscriptions & Notifications

This is the eighth post in our series dedicated to helping the amazing members of our community--both new members and seasoned veterans--learn and grow in how to best engage in the community! Each Tuesday, we feature new content that will help you best understand the community--from ranking and badges to profile avatars, from Super Users to blogging in the community. Our hope is that this information will help each of our community members grow in their experience with Power Platform, with the community, and with each other!   This Week: All About Subscriptions & Notifications Subscribing to a CategorySubscribing to a TopicSubscribing to a LabelBookmarksManaging & Viewing your Subscriptions & BookmarksA Note on Following Friends on Mobile   Subscriptions ensure that you receive automated messages about the most recent posts and replies. There are multiple ways you can subscribe to content and boards in the community! (Please note: if you have created an AAD (Azure Active Directory) account you won't be able to receive e-mail notifications.)   Subscribing to a Category  When you're looking at the entire category, select from the Options drop down and choose Subscribe.   You can then choose to Subscribe to all of the boards or select only the boards you want to receive notifications. When you're satisfied with your choices, click Save.   Subscribing to a Topic You can also subscribe to a single topic by clicking Subscribe from the Options drop down menu, while you are viewing the topic or in the General board overview, respectively.   Subscribing to a Label You can find the labels at the bottom left of a post.From a particular post with a label, click on the label to filter by that label.          This opens a window containing a list of posts with the label you have selected. Click Subscribe.   Note: You can only subscribe to a label at the board level. If you subscribe to a label named 'Copilot' at board #1, it will not automatically subscribe you to an identically named label at board #2. You will have to subscribe twice, once at each board.   Bookmarks Just like you can subscribe to topics and categories, you can also bookmark topics and boards from the same menus! Simply go to the Topic Options drop down menu to bookmark a topic or the Options drop down to bookmark a board.   The difference between subscribing and bookmarking is that subscriptions provide you with notifications, whereas bookmarks provide you a static way of easily accessing your favorite boards from the My subscriptions area.   Managing & Viewing Your Subscriptions & Bookmarks To manage your subscriptions, click on your avatar and select My subscriptions from the drop-down menu. From the Subscriptions & Notifications tab, you can manage your subscriptions, including your e-mail subscription options, your bookmarks, your notification settings, and your email notification format.     You can see a list of all your subscriptions and bookmarks and choose which ones to delete, either individually or in bulk, by checking multiple boxes.     A Note on Following Friends on Mobile Adding someone as a friend or selecting Follow in the mobile view does not allow you to subscribe to their activity feed. You will merely be able to see your friends’ biography, other personal information, or online status, and send messages more quickly by choosing who to send the message to from a list, as opposed to having to search by username.              

Exclusive LIVE Community Event: Power Apps Copilot Coffee Chat with Simon Matthews and Miti Joshi

We are thrilled to announce our first-ever Power Apps Copilot Coffee Chat with Simon Matthews and Miti Joshi, which will be held LIVE on November 14th, 2023 at 9:30 AM Pacific Standard Time (PST). Give your "kudo" today (by clicking the thumbs up button 👍 below) and mark your calendars for November 14th, 2023 at 9:30 AM PST to join us for an engaging and informative session.   This is an incredible opportunity to connect with members of the Power Apps product team and ask them anything. We will discuss the emergence of generative AI and how we are changing the way makers build and use Microsoft Power Apps with the support of Copilot. We are excited to have Simon Matthews and Miti Joshi as our hosts for this AMA. Simon leads the Product Management team focused on Power Apps Maker Copilot and Data Experiences, while Miti builds Copilot for business application users, focusing on Copilot for end users of canvas and model-driven Power Apps.   This live event will give you the unique opportunity to learn more about the Power Apps Copilot plans, where we’ll focus, and get insight into upcoming features. We’re looking forward to hearing from the community, so bring your questions!HOW TO GET ACCESS TO THIS EXCLUSIVE AMA: Kudo this post to reserve your spot! Reserve your spot now by kudoing this post.  Reservations will be prioritized on when your kudo for the post comes through, so don't wait! Click that "kudo button" today.   Invitations will be sent on November 13thUsers posting Kudos after November 13th at 5PM PST may not receive an invitation but will be able to view the session online after conclusion of the event.       Give your "kudo" today and mark your calendars for November 14th, 2023 at 9:30 AM PST and join us for an engaging and informative session.

Top Kudoed Authors
Users online (5,017)