-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve mgmt readme for identity support #14921
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
@deyaaeldeen Can we please update the code generator with similar changes? |
@ramya-rao-a Yes I will, I opened this issue for tracking: Azure/autorest.typescript#916. |
DataBoxEdge Swagger API Review- 2021-02-01 (Azure#14921) * Initial Commit with previously reviewed Changes * Updated Swagger * Added Example files * Updated Description for the APIs which are in private preview * Updated ReadmeFiles * Fixed folder structure * fixed json example references * Fixed supportPackage and Proactivelogcollection jsons * Fixed Prettier check * Fixed Prettier check * Fixed Azure-auth * Fixing UpdateDiagnosticRemoteSupportSettings.json Go Validations * Fixed Model Validation * Fix Model Validation + Prettier Check * Fixed Model Validation * Swagger LinterValidation Fix * Removed Type from UpdateDiagnosticProactiveLogCollectionSettings.json, failing Model Validation * Updated all the example files * fixed comments * Updated corresponding examples * Fixed Validation * Updated the tag to the latest * Fixed the tag Co-authored-by: Arzoo Jain <arja@microsoft.com>
add-identity-mgmt-lib.js
is the script that can be used on auto-generated mgmt plane packages to make them support the credentials from the@azure/identity
packageWe had feedback regarding the updated readme that the use of
DefaultAzureCredential
requires set up while the older readme used interactive credential from ms-rest-nodeauth which did not require any set up and so was easy to get started.In all the data plane packages that use the new Identity package across all languages, we have been using
DefaultAzureCredential
in our examples and getting started guides. If we are to change our getting started story, that would involve a larger effort cross languages and cross packages.In order to unblock the current efforts to have the mgmt plane packages support Azure Identity, we will rely on the doc https://aka.ms/azsdk/js/identity/examples. See #14920 for the improvements being done to this doc which will make it easier for us to simply point to this doc rather than go into details of which credential is easiest for getting started in the readme file of the consuming package.