azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Adding UserAssigned Identity Suppport
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [ ] new API version
- [x] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[ ] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
-
[x] 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
Hi, @mvvsubbu Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| accessconnector.json | 2022-04-01-preview(e92140f) | 2022-04-01-preview(main) |
| Rule | Message |
|---|---|
|
The new version is missing a definition that was found in the old version. Was 'IdentityData' removed or renamed? New: Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json#L314:3 Old: Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json#L314:3 |
|
The new version has a new property 'userAssignedIdentities' in response that was not found in the old version. New: common-types/resource-management/v3/managedidentity.json#L52:7 Old: Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json#L354:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-04-01-preview | package-2022-04-01-preview(e92140f) | package-2022-04-01-preview(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json#L321 |
| :warning: R4021 - DescriptionAndTitleMissing | 'AccessConnectorProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Databricks/preview/2022-04-01-preview/accessconnector.json#L333 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️~[Staging] TrafficValidation 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.
️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/e92140fe7f6af4dfab72ad1c54584fa08747a9d8/specification/databricks/resource-manager/readme.md#tag-package-2022-04-01-preview">databricks/resource-manager/readme.md#package-2022-04-01-preview
| Rule | Message |
|---|---|
| :warning: PreCheck/PropertyRedeclarationWarning | "readme":"databricks/resource-manager/readme.md", "tag":"package-2022-04-01-preview", "details":"Schema 'GroupIdInformation' has a property 'id' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from GroupIdInformation" |
| :warning: PreCheck/PropertyRedeclarationWarning | "readme":"databricks/resource-manager/readme.md", "tag":"package-2022-04-01-preview", "details":"Schema 'GroupIdInformation' has a property 'name' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from GroupIdInformation" |
| :warning: PreCheck/PropertyRedeclarationWarning | "readme":"databricks/resource-manager/readme.md", "tag":"package-2022-04-01-preview", "details":"Schema 'GroupIdInformation' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from GroupIdInformation" |
| :warning: UnkownSecurityScheme | "readme":"databricks/resource-manager/readme.md", "tag":"package-2022-04-01-preview", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-python-track2 - track2_azure-mgmt-databricks - 1.1.0b1+ Client name is changed from `AzureDatabricksManagementClient` to `DatabricksClient`
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 5613b0681d5424423abcd91819a6007665d8a6fd. SDK Automation 14.0.0command 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 cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New minor version of npm available! 8.15.0 -> 8.19.2 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-databricks [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation group AccessConnectorsOperations info [Changelog] - Added operation group OutboundNetworkDependenciesEndpointsOperations info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Client name is changed from `AzureDatabricksManagementClient` to `DatabricksClient`
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 5613b0681d5424423abcd91819a6007665d8a6fd. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/databricks/armdatabricks [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New const `ManagedServiceIdentityTypeSystemAssignedUserAssigned` info [Changelog] - New const `ManagedServiceIdentityTypeNone` info [Changelog] - New const `ManagedServiceIdentityTypeUserAssigned` info [Changelog] - New const `ManagedServiceIdentityTypeSystemAssigned` info [Changelog] - New type alias `ManagedServiceIdentityType` info [Changelog] - New function `*AccessConnectorsClient.BeginDelete(context.Context, string, string, *AccessConnectorsClientBeginDeleteOptions) (*runtime.Poller[AccessConnectorsClientDeleteResponse], error)` info [Changelog] - New function `*AccessConnectorsClient.Get(context.Context, string, string, *AccessConnectorsClientGetOptions) (AccessConnectorsClientGetResponse, error)` info [Changelog] - New function `NewAccessConnectorsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*AccessConnectorsClient, error)` info [Changelog] - New function `*AccessConnectorsClient.BeginCreateOrUpdate(context.Context, string, string, AccessConnector, *AccessConnectorsClientBeginCreateOrUpdateOptions) (*runtime.Poller[AccessConnectorsClientCreateOrUpdateResponse], error)` info [Changelog] - New function `*AccessConnectorsClient.NewListByResourceGroupPager(string, *AccessConnectorsClientListByResourceGroupOptions) *runtime.Pager[AccessConnectorsClientListByResourceGroupResponse]` info [Changelog] - New function `PossibleManagedServiceIdentityTypeValues() []ManagedServiceIdentityType` info [Changelog] - New function `*AccessConnectorsClient.NewListBySubscriptionPager(*AccessConnectorsClientListBySubscriptionOptions) *runtime.Pager[AccessConnectorsClientListBySubscriptionResponse]` info [Changelog] - New function `*AccessConnectorsClient.BeginUpdate(context.Context, string, string, AccessConnectorUpdate, *AccessConnectorsClientBeginUpdateOptions) (*runtime.Poller[AccessConnectorsClientUpdateResponse], error)` info [Changelog] - New struct `AccessConnector` info [Changelog] - New struct `AccessConnectorListResult` info [Changelog] - New struct `AccessConnectorProperties` info [Changelog] - New struct `AccessConnectorUpdate` info [Changelog] - New struct `AccessConnectorsClient` info [Changelog] - New struct `AccessConnectorsClientBeginCreateOrUpdateOptions` info [Changelog] - New struct `AccessConnectorsClientBeginDeleteOptions` info [Changelog] - New struct `AccessConnectorsClientBeginUpdateOptions` info [Changelog] - New struct `AccessConnectorsClientCreateOrUpdateResponse` info [Changelog] - New struct `AccessConnectorsClientDeleteResponse` info [Changelog] - New struct `AccessConnectorsClientGetOptions` info [Changelog] - New struct `AccessConnectorsClientGetResponse` info [Changelog] - New struct `AccessConnectorsClientListByResourceGroupOptions` info [Changelog] - New struct `AccessConnectorsClientListByResourceGroupResponse` info [Changelog] - New struct `AccessConnectorsClientListBySubscriptionOptions` info [Changelog] - New struct `AccessConnectorsClientListBySubscriptionResponse` info [Changelog] - New struct `AccessConnectorsClientUpdateResponse` info [Changelog] - New struct `ManagedServiceIdentity` info [Changelog] - New struct `UserAssignedIdentity` info [Changelog] info [Changelog] Total 0 breaking change(s), 51 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 5613b0681d5424423abcd91819a6007665d8a6fd. SDK Automation 14.0.0command 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-databricks [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from 5613b0681d5424423abcd91819a6007665d8a6fd. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile 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
️✔️databricks [View full logs] [Preview Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 5613b0681d5424423abcd91819a6007665d8a6fd. SDK Automation 14.0.0command 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.Databricks [View full logs] [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/databricks/armdatabricks | https://apiview.dev/Assemblies/Review/8f4c9e20f5a74bc888d0986dd72a173f |
| Python | track2_azure-mgmt-databricks | https://apiview.dev/Assemblies/Review/4c0694d65b8441e29270b2149c845cf7 |
| JavaScript | @azure/arm-databricks | Create ApiView failed. Please ask PR assignee for help |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.
We haven't published any SDKs, Az CLI, PS or Terraform for Previous Version and We have only supported this feature in REST API. Also we have very limited number of customers created this resource. So we would like to apply for breaking change policy review
Hi, @mvvsubbu. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi @mvvsubbu, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. 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. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.