-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Managed Identity Support on IotHub [New stable API version: 2021-03-31] #14183
Conversation
Hi, @nimengan Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
[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. |
Swagger Validation Report
|
Rule | Message |
---|---|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: includeConfigurations Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L4158 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: includeConfigurations Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L4208 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L76 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L302 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L343 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L387 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L431 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L478 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L532 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L708 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L755 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics' Location: Microsoft.Devices/stable/2021-03-31/iothub.json#L806 |
️️✔️
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 BreakingChange (Base on preview version): 14 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2021-03-03-preview/iothub.json <---> new: stable/2021-03-31/iothub.json
Only 10 items are listed, please refer to log for more details.
️❌
Cross Version BreakingChange (Base on stable version): 9 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: stable/2020-08-31/iothub.json <---> new: stable/2021-03-31/iothub.json
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"iothub/resource-manager/readme.md", "tag":"package-2021-03", "details":"The schema 'components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/iothub/resource-manager/Microsoft.Devices/stable/2021-03-31/iothub.json#/components/schemas/components·11psznm·schemas·eventhubconsumergroupinfo·properties·properties·additionalproperties" |
|
💬 AutorestCore/Exception | "readme":"iothub/resource-manager/readme.md", "tag":"package-2021-03", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
💬 AutorestCore/Exception | "readme":"iothub/resource-manager/readme.md", "tag":"package-2021-03", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"iothub/resource-manager/readme.md", "tag":"package-2021-03", "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.
Swagger Generation Artifacts
|
Hi, @nimengan your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ |
NewApiVersionRequired reason: |
@jianyexi Could you please help merging this PR to master branch ? |
@jianyexi, sorry to bug you. could you please help in merging this PR ? |
The cross version breaking changes also need to be approved, as these changes are disallowed in the new api version as well. |
but the resolution for issues present in the cross api version breaking change in the guidance mentions to have it as new api version. Cause: This is considered a breaking change. This change requires new api-version. But we are already are doing it in new api version. |
@jianyexi breaking change has been approved. please merge the PR to the master |
Good capture, I will update the doc , thanks |
…1] (Azure#14183) * Adds base for updating Microsoft.Devices from version stable/2020-08-31 to version 2021-03-31 * Updates readme * Updates API version in new specs and examples * Adding properties related to managed identity. * Fixing eventhub consumer group put issue. * Adding DeviceConnectionStateEvents as routing source * Adding missing propeties of import/export in 2021-03-03-preview * Removing import/export properties added in last commit * Removing the regex from readOnly PrivateEndpoint name * Removing private endpoint regex in new API version
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.
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.
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.
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.