This commit is contained in:
MattB 2020-03-06 11:08:41 -08:00
Родитель 65572d44dd
Коммит e219c827f5
2 изменённых файлов: 91 добавлений и 1 удалений

21
LICENSE Normal file
Просмотреть файл

@ -0,0 +1,21 @@
MIT License
Copyright (c) Microsoft Corporation
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Просмотреть файл

@ -1 +1,70 @@
TODO: Create a file called LICENSE (not LICENSE.TXT, LICENSE.md, etc.)…
## Overview
This is currently an issues only repositiry to support the Microsoft.PowerPlatform.Cds.Client and its supporting assemblies and classes.
This encompases the contents of the following nuget packages:
[Microsoft.PowerPlatform.Cds.Client](https://www.nuget.org/packages/Microsoft.Powerplatform.Cds.Client)
-
[Microsoft.PowerPlatform.Cds.Client.Dynamics](https://www.nuget.org/packages/Microsoft.Powerplatform.Cds.Client.Dynamics)
-
[Microsoft.Dynamics.Sdk.Messages](https://www.nuget.org/packages/Microsoft.Dynamics.Sdk.Messages)
-
This library is and its supporting assemblies are a revision and update of the Microsoft.Xrm.Tooling.Connector.CrmServiceClient and the underlying Microsoft.Xrm.Sdk.Client libraries.
We are using this effort to for a few key things we have wanted to get done for a number of years,
1. Refactor and update our client libraries to allow us to spit up Powerplatform Common Data Service SDK support from Microsoft Dynamics 365.
2. Provide multi targeted library build that targets our supported .net client platforms.
3. Update connection patterns and behaviors to be consistent with many of the broadly accepted patterns.
4. Create a pattern to allow developers focus on the use of Common Data Service, or CDS + Dynamics as they need.
<b>We are currently in ALPHA.</b>
What does this mean?
Alpha means that we can and will change the api surface, namepaces and behavior from time to time. this is mostly driven by feedback from users of the client (you). During this process we are also working though ports of many internal tools and will adjust things based on the needs of those tools were it make sense.
We encourage you to read the release notes we provide with each nuget packages. As with most of our Nuget packages that are intended as tools or for developer consumption, we extensively comment in release notes.
At this time:
The alpha version of the SDK libs supports the following and has the following notices:
* .net full framework 4.6.2, 4.7.2, 4.8 and .net core 3.0, 3.1
* We are supporting only Client Secret / Cert flows for .net core. On .net framework additionally we support OAuth User flows
* We are shipping the initial drop using ADAL.net for the Auth Lib. We MAY change to use MSAL shortly
* MSAL would enabled us to support User Interactive flows on .net core.
* 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.
* The Assembly Names Will likely change at least once more.
* 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 )
* 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..
* Plugin Development using this Client is NOT supported at this time.
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.
You can find those here: [https://github.com/microsoft/PowerApps-Samples/tree/master/cds/orgsvc/C%23](PowerApps-Samples/cds/orgsvc/C#/)
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.
We believe forthe vast majorty of applications working against the older dynamices sdk libs, you should only need Microsoft.Powerplatform.Cds.Client and Microsoft.Dynamics.Sdk.Messages.
If your working against CDS Only and or custom entities and sdk messages, 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.
<b>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.
While we are monitoring the community forums, you are encouraged to open issue [here](../issues)
</b>
## Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## License
[MIT](LICENSE)