added swagger for microsoft.hybridonboarding #27668

akashkeshari · 2024-02-06T07:05:31Z

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

Click here to see the details of Step 1

Breaking changes review (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:

The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
You believe there is no need for you to request breaking change approval, for any reason.
Such claims must be reviewed, and the process is the same.

Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

For help with Step 2 / "ARM review", see https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

New resource provider.
New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix OpenAPI spec quality issues in S360.
Other, please clarify:
- edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2024-02-06T07:05:35Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ The suppressions you added require review. Refer to step 1 in the PR workflow diagram (even if your PR is for data plane, not ARM), or to step 3, depending onthe kind of suppression you did.
❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it. In addition, refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

openapi-pipeline-app · 2024-02-06T07:05:35Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Compared specs (v2.2.0)	new version	base version
package-preview-2024-06	package-preview-2024-06(b289812)	default(main)

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-02-06T07:05:36Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs] Generate from a8c84a6eba17b6c93f792ab2d88acb185447ca48. 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.
warn		specification/hybridonboarding/ExtensionManager.Management/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️track2_azure-mgmt-hybridonboarding [View full logs] [Preview SDK Changes]
- azure-mgmt-hybridonboarding-1.0.0b1.zip
- azure_mgmt_hybridonboarding-1.0.0b1-py3-none-any.whl
```
info	[Changelog]   - Initial Release
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs] Generate from a8c84a6eba17b6c93f792ab2d88acb185447ca48. 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
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh]   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
cmderr	[init.sh]                                  Dload  Upload   Total   Spent    Left  Speed
cmderr	[init.sh] 
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
cmderr	[init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz...
cmderr	[init.sh] Computing checksum with sha256sum
cmderr	[init.sh] Checksums matched!
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-hybridonboarding [View full logs] [Preview SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from a8c84a6eba17b6c93f792ab2d88acb185447ca48. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
warn		specification/hybridonboarding/ExtensionManager.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/hybridonboarding/armhybridonboarding [View full logs] [Preview SDK Changes]

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from a8c84a6eba17b6c93f792ab2d88acb185447ca48. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-hybridonboarding [View full logs] [Preview SDK Changes]
- azure-arm-hybridonboarding-1.0.0-beta.1.tgz

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs] Generate from a8c84a6eba17b6c93f792ab2d88acb185447ca48. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] npm notice
cmderr	[initScript.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.5.0` to update!
cmderr	[initScript.sh] npm notice
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json

️✔️hybridonboarding [View full logs] [Preview Schema Changes]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-02-06T07:05:36Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/hybridonboarding/armhybridonboarding	https://apiview.dev/Assemblies/Review/28d580928e6f4ccba8a7edfc81bc47e0?revisionId=6191baa7b7a241f3b53125f1f8b314c5
Java	azure-resourcemanager-hybridonboarding	https://apiview.dev/Assemblies/Review/ab0844059b2e48e98af48c0e637fb538?revisionId=0fd785d56997408b92d594ab755849ff
JavaScript	@azure/arm-hybridonboarding	https://apiview.dev/Assemblies/Review/2020d23c169b4ea18e3682d79485a9eb?revisionId=078942d5180542469702679168734f90
TypeSpec	ExtensionManager.Management	https://apiview.dev/Assemblies/Review/496d2e870bca4442acefe1493c802d41?revisionId=3da3b320c40a46fb9185573b8d7f0695
Swagger	Microsoft.HybridOnboarding	https://apiview.dev/Assemblies/Review/6fed29bd337e4784ae64001fc2908878?revisionId=4268e724fd41484b8635561cca99d8f0

openapi-workflow-bot · 2024-02-06T07:11:39Z

Hi @akashkeshari This PR was flagged for attempting to introduce a new RP namespace to the main branch without first merging the new RP to the RPSaaSMaster branch. Please add the new RP in a merge to RPSaaSMaster before continuing the merge to main.

openapi-workflow-bot · 2024-02-06T07:11:39Z

Hi, @akashkeshari, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved.
Action Required:

Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.

Paste the issue link that you created in step 1 in this PR

Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

added swagger for microsoft.hybridonboarding

aaf6b70

AzureRestAPISpecReview added CI-RpaaSRPNotInPrivateRepo new-api-version new-rp-namespace resource-manager RPaaS TypeSpec Authored with TypeSpec labels Feb 6, 2024

Akash Keshari added 12 commits February 19, 2024 20:12

updated resource model

8dd662d

fixed few checks

b644274

added examples

2491195

made few fixes

f20340e

few updates

852d961

update swagger

b9437d4

updated remove infra api

03089e9

updated swagger based on review comments

cdc4f73

added managed identity

943eba9

added remove/add CL api

24d878f

fix typespec val

7677821

Merge branch 'main' into akash/ms_hybridonboard

35d3053

Akash Keshari added 6 commits March 14, 2024 01:07

added custom msi def

2e46c69

added scenario profile in resource model

92add04

updated example reference

8934727

updated description

d046689

update openapi.json due to failing typespec validation gitdiff

4f33a8e

added suppression for guid usage

b289812

AzureRestAPISpecReview added the SuppressionReviewRequired label Mar 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added swagger for microsoft.hybridonboarding #27668

added swagger for microsoft.hybridonboarding #27668

akashkeshari commented Feb 6, 2024 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented Feb 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented Feb 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented Feb 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented Feb 6, 2024 •

edited

Loading

openapi-workflow-bot bot commented Feb 6, 2024

openapi-workflow-bot bot commented Feb 6, 2024

added swagger for microsoft.hybridonboarding #27668

Are you sure you want to change the base?

added swagger for microsoft.hybridonboarding #27668

Conversation

akashkeshari commented Feb 6, 2024 • edited by openapi-workflow-bot bot Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Breaking changes review (Diagram Step 1)

ARM API changes review (Diagram Step 2)

Diagram footnotes

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Feb 6, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Feb 6, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Feb 6, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented Feb 6, 2024 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Feb 6, 2024

openapi-workflow-bot bot commented Feb 6, 2024

akashkeshari commented Feb 6, 2024 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented Feb 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented Feb 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented Feb 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented Feb 6, 2024 •

edited

Loading