Skip to content
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

Azure Health Bot MSI support #14786

Closed
wants to merge 7 commits into from
Closed

Conversation

guy-microsoft
Copy link
Contributor

@guy-microsoft guy-microsoft commented Jun 13, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@guy-microsoft guy-microsoft added the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label Jun 13, 2021
@openapi-workflow-bot
Copy link

Hi, @guy-microsoft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 13, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L498
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L705
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction
    Location: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L693
    ⚠️ R4006 - DeprecatedXmsCodeGenerationSetting The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation.
    Location: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L7
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️❌Cross-Version Breaking Changes: 58 Errors, 0 Warnings failed [Detail]
    The following breaking changes are detected by comparison with the latest stable version:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L490:9
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L430:9
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L498:9
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L434:9
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L87:13
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L87:13
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L633:15
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L562:15
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L641:15
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L570:15
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L128:13
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L128:13
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L540:9
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L475:9
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L180:13
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L180:13
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L220:13
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L220:13
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L251:13
    Old: Microsoft.HealthBot/stable/2020-12-08/healthbot.json#L251:13


    The following breaking changes are detected by comparison with latest preview version:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.HealthBot/checkNameAvailability' removed or restructured?
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L40:5
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CheckNameAvailabilityRequestBody' removed or renamed?
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L340:3
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L382:3
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L490:9
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L533:9
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L498:9
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L537:9
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L87:13
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L129:13
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L633:15
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L662:15
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L641:15
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L670:15
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L128:13
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L170:13
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L540:9
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L575:9
    1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.HealthBot/stable/2021-06-10/healthbot.json#L180:13
    Old: Microsoft.HealthBot/preview/2020-12-08-preview/healthbot.json#L222:13
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"healthbot/resource-manager/readme.md",
    "tag":"package-2021-06-10",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"healthbot/resource-manager/readme.md",
    "tag":"package-2021-06-10",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"healthbot/resource-manager/readme.md",
    "tag":"package-2021-06-10",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 13, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - healthbot/mgmt/2020-12-08/healthbot - v55.2.0
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-healthbot - 1.0.0b1
    ️✔️azure-sdk-for-go - healthbot/mgmt/2021-06-10/healthbot - v55.2.0
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d39d9558bf61524371884a9f0cfd4b5e5591f5ad. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.Healthbot [View full logs]  [Preview SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from d39d9558bf61524371884a9f0cfd4b5e5591f5ad. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-healthbot [View full logs]  [Preview SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model HealthBot has a new parameter identity
      info	[Changelog]   - Model HealthBotUpdateParameters has a new parameter identity
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from d39d9558bf61524371884a9f0cfd4b5e5591f5ad. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-06-13 13:37:28 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-healthbot;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-06-13 13:37:28 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-06-13 13:37:28 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.29 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/healthbot/azure-resourcemanager-healthbot --java.namespace=com.azure.resourcemanager.healthbot   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/healthbot/resource-manager/readme.md
      cmderr	[generate.py] 2021-06-13 13:37:53 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-healthbot
      cmderr	[generate.py] 2021-06-13 13:37:53 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-06-13 13:37:53 INFO [POM][Skip] pom already has module azure-resourcemanager-healthbot
      cmderr	[generate.py] 2021-06-13 13:37:53 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-06-13 13:37:53 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-06-13 13:37:53 INFO [POM][Skip] pom already has module sdk/healthbot
      cmderr	[generate.py] 2021-06-13 13:37:53 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-healthbot [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-06-13 13:40:00 DEBUG Got artifact_id: azure-resourcemanager-healthbot
      cmderr	[Inst] 2021-06-13 13:40:00 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-06-13 13:40:00 DEBUG Got artifact: azure-resourcemanager-healthbot-1.0.0-beta.2-javadoc.jar
      cmderr	[Inst] 2021-06-13 13:40:00 DEBUG Got artifact: azure-resourcemanager-healthbot-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-13 13:40:00 DEBUG Match jar package: azure-resourcemanager-healthbot-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-13 13:40:00 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14786/azure-sdk-for-java/azure-resourcemanager-healthbot/azure-resourcemanager-healthbot-1.0.0-beta.2.jar\" -o azure-resourcemanager-healthbot-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-healthbot -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-healthbot-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d39d9558bf61524371884a9f0cfd4b5e5591f5ad. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.6.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/healthbot/resource-manager/readme.md
    • ️✔️@azure/arm-healthbot [View full logs]  [Preview SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/healthbotClient.js → ./dist/arm-healthbot.js...
      cmderr	[npmPack] created ./dist/arm-healthbot.js in 207ms
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d39d9558bf61524371884a9f0cfd4b5e5591f5ad. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️healthbot/mgmt/2021-06-10/healthbot [View full logs]  [Preview SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️healthbot/mgmt/2020-12-08/healthbot [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d39d9558bf61524371884a9f0cfd4b5e5591f5ad. Azure CLI Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --az --use=@autorest/az@latest --version=3.0.6271 --clear-output-folder=true --azure-cli-extension-folder=/home/vsts/work/1/s/azure-cli-extensions ../azure-rest-api-specs/specification/healthbot/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (PreNamer/DeduplicateName): Deduplicating schema name: 'error' -> 'errorAutoGenerated'
      cmdout	[Autorest] WARNING (): cli.auto-parameter-hidden is not true, skip visibility cleaner
      cmderr	[Autorest] BELOW TEST SCENARIO SECTION CAN BE USED IN readme.cli.md
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest]   test-scenario:
      cmderr	[Autorest]     - name: /Bots/put/BotCreate
      cmderr	[Autorest]     - name: /Bots/get/List Bots by Resource Group
      cmderr	[Autorest]     - name: /Bots/get/List Bots by Subscription
      cmderr	[Autorest]     - name: /Bots/get/ResourceInfoGet
      cmderr	[Autorest]     - name: /Bots/patch/BotUpdate
      cmderr	[Autorest]     - name: /Bots/delete/BotDelete
      cmderr	[Autorest] --------------------------------------------------------
    • ️✔️healthbot [View full logs]  [Preview Azure CLI Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @guy-microsoft guy-microsoft removed the NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR label Jun 13, 2021
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 13, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @guy-microsoft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @guy-microsoft guy-microsoft added NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 13, 2021
    @guy-microsoft
    Copy link
    Contributor Author

    Closing in favor of this PR.

    @JackTn
    Copy link
    Member

    JackTn commented Jun 16, 2022

    Hi, @guy-microsoft. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days.

    2 similar comments
    @JackTn
    Copy link
    Member

    JackTn commented Jun 16, 2022

    Hi, @guy-microsoft. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days.

    @JackTn
    Copy link
    Member

    JackTn commented Jun 16, 2022

    Hi, @guy-microsoft. The PR has be closed for a long time and it's related branch still exist. Please tell me if you still need this branch or i will delete it in 14 days.

    @JackTn JackTn deleted the azure-health-bot-msi-new-api branch July 5, 2022 01:19
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    NotReadyForReview <valid label in PR review process>It is in draft for swagger or not swagger PR
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants