Add first draft of readme. Add comment for dtmi validation. #18987
Conversation
|
This pull request is protected by Check Enforcer. What is Check Enforcer?Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass. Why am I getting this message?You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged. What should I do now?If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows: What if I am onboarding a new service?Often, new services do not have validation pipelines associated with them. In order to bootstrap pipelines for a new service, please perform following steps: For data-plane/track 2 SDKs Issue the following command as a pull request comment:
For track 1 management-plane SDKsPlease open a separate PR and to your service SDK path in this file. Once that PR has been merged, you can re-run the pipeline to trigger the verification. |
|
|
||
| ### Authenticate the Client | ||
|
|
||
| Currently no authentication mechanisms are supported in the client. The global endpoint is not tied to an Azure subscription and does not support auth. All models published are meant for anonymous public consumption. |
There was a problem hiding this comment.
What if I want to have auth for my private endpoint?
There was a problem hiding this comment.
Think we need to punt on this question for this iteration. But its a good use case for us to talk about in future iterations.
Unless you think we should word this section differently.
There was a problem hiding this comment.
I agree you can punt on it for this PR, and yes I think it is important to figure out for private endpoints.
sdk/modelsrepository/Azure.Iot.ModelsRepository/src/DtmiConventions.cs
Outdated
Show resolved
Hide resolved
* Initial Commit - Bring ModelRepository Project to the mono repo (#18706) * Use resx file and update formattings. * Add client diagnostics - Add sync APIs to RemoteFetcher and LocalFetcher (#18807) * Add async methods to the ResolverClient (#18814) * Add support for recorded tests. (#18836) * Add support for recorded tests. * Make strings constants * Update file names to include plural models * Refactor RepositoryHandler and ResolverClient (#18857) * Refactor ModelQuery (#18843) * Refactor ModelQuery. * Combine constant files. * Rename Client to ModelsRepoClient (#18862) * Remove ResolverException in favor of RequestFailedException (#18874) * Remove ResolverException in favor of RequestFailedException. Adds more docstrings. * Rename Repo to Repository and minor changes / Import samples project (#18986) * Format changes/Remove resx file. * Add first draft of readme. Add comment for dtmi validation. (#18987) * Add comment for dtmi validation. * Fix links. * Add diagnostic event info. * Source link specifically pointing to 'src' folder. * Use fluent assertion * Use playback as default * fix Links and root service directory casing Co-authored-by: Paymaun <Paymaunh@microsoft.com>
No description provided.