azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Add New ListNetworkGroupMembership API to network 2022 06 01 preview
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
- [x] new API version
- [ ] 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):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [ ] 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:
-
[x] 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.
Swagger pipeline can not start as the pull request has merge conflicts.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @yanfa317 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 pipeline can not start as the pull request has merge conflicts.
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-06-preview | package-2022-06-preview(5aebe1b) | default(dev-release-network-2022-06-01-preview) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: PageableOperation | Based on the response model schema, operation 'ListNetworkGroupMemberships' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Network/preview/2022-06-01-preview/networkManagerGroupMembership.json#L58 |
️❌Avocado: 16 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/expressRouteCircuits/{}/arpTable is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2015-06-15/expressRouteCircuit.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/expressRouteCircuits/{}/routesTable is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2015-06-15/expressRouteCircuit.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Network/virtualnetworks is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2015-06-15/virtualNetwork.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/virtualnetworks is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2015-06-15/virtualNetwork.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/virtualnetworks/{}/subnets/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2015-06-15/virtualNetwork.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/virtualnetworks/{}/subnets is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2015-06-15/virtualNetwork.json |
|
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2021-08-01/vmssNetworkInterface.json |
|
The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag. readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2021-08-01/vmssPublicIpAddress.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/interfaceEndpoints/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2019-02-01/interfaceEndpoint.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/interfaceEndpoints is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2019-02-01/interfaceEndpoint.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Network/interfaceEndpoints is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2019-02-01/interfaceEndpoint.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/virtualWans/{}/p2sVpnServerConfigurations/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2019-07-01/virtualWan.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/virtualWans/{}/p2sVpnServerConfigurations is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2019-07-01/virtualWan.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/firewallPolicies/{}/ruleGroups/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2020-04-01/firewallPolicy.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/firewallPolicies/{}/ruleGroups is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2020-04-01/firewallPolicy.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/virtualNetworks/{}/bastionHosts is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/network/resource-manager/readme.md json: Microsoft.Network/stable/2020-05-01/virtualNetwork.json |
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️⚠️SDK Breaking Change Tracking warning [Detail]
Breaking Changes Tracking
⚠️azure-sdk-for-js - @azure/arm-network - 31.0.0+ Interface AdminRuleCollectionsListNextOptionalParams no longer has parameter skipToken + Interface AdminRuleCollectionsListNextOptionalParams no longer has parameter top + Interface AdminRulesListNextOptionalParams no longer has parameter skipToken + Interface AdminRulesListNextOptionalParams no longer has parameter top + Interface ConnectivityConfigurationsListNextOptionalParams no longer has parameter skipToken + Interface ConnectivityConfigurationsListNextOptionalParams no longer has parameter top + Interface ManagementGroupNetworkManagerConnectionsListNextOptionalParams no longer has parameter skipToken + Interface ManagementGroupNetworkManagerConnectionsListNextOptionalParams no longer has parameter top + Interface NetworkGroupsListNextOptionalParams no longer has parameter skipToken + Interface NetworkGroupsListNextOptionalParams no longer has parameter top + Interface NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsNextOptionalParams no longer has parameter expand + Interface NetworkManagersListBySubscriptionNextOptionalParams no longer has parameter skipToken + Interface NetworkManagersListBySubscriptionNextOptionalParams no longer has parameter top + Interface NetworkManagersListNextOptionalParams no longer has parameter skipToken + Interface NetworkManagersListNextOptionalParams no longer has parameter top + Interface ScopeConnectionsListNextOptionalParams no longer has parameter skipToken + Interface ScopeConnectionsListNextOptionalParams no longer has parameter top + Interface SecurityAdminConfigurationsListNextOptionalParams no longer has parameter skipToken + Interface SecurityAdminConfigurationsListNextOptionalParams no longer has parameter top + Interface ServiceTagInformationListNextOptionalParams no longer has parameter noAddressPrefixes + Interface ServiceTagInformationListNextOptionalParams no longer has parameter tagName + Interface StaticMembersListNextOptionalParams no longer has parameter skipToken + Interface StaticMembersListNextOptionalParams no longer has parameter top + Interface SubscriptionNetworkManagerConnectionsListNextOptionalParams no longer has parameter skipToken + Interface SubscriptionNetworkManagerConnectionsListNextOptionalParams no longer has parameter top + Interface VirtualNetworksListDdosProtectionStatusNextOptionalParams no longer has parameter skipToken + Interface VirtualNetworksListDdosProtectionStatusNextOptionalParams no longer has parameter top
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 3f2dcf868fa25036ded606f900e3e75eb3a9b9d2. SDK Automation 14.0.0warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-6.0 command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/network/resource-manager/readme.md cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied
️✔️Microsoft.Azure.Management.Network [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 3f2dcf868fa25036ded606f900e3e75eb3a9b9d2. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.Network [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 3f2dcf868fa25036ded606f900e3e75eb3a9b9d2. 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] npm notice cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.2.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.2.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-network [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Model NspLink has a new parameter remote_perimeter_location info [Changelog] - Model NspLinkReference has a new parameter remote_perimeter_location
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 3f2dcf868fa25036ded606f900e3e75eb3a9b9d2. SDK Automation 14.0.0command ./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 available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-network-generated [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 3f2dcf868fa25036ded606f900e3e75eb3a9b9d2. 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/network/armnetwork [View full logs] [Preview SDK Changes]info [Changelog] ### Other Changes info [Changelog] info [Changelog] Total 0 breaking change(s), 0 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 3f2dcf868fa25036ded606f900e3e75eb3a9b9d2. 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-network [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Interface AdminRuleCollectionsListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface AdminRuleCollectionsListNextOptionalParams no longer has parameter top info [Changelog] - Interface AdminRulesListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface AdminRulesListNextOptionalParams no longer has parameter top info [Changelog] - Interface ConnectivityConfigurationsListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface ConnectivityConfigurationsListNextOptionalParams no longer has parameter top info [Changelog] - Interface ManagementGroupNetworkManagerConnectionsListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface ManagementGroupNetworkManagerConnectionsListNextOptionalParams no longer has parameter top info [Changelog] - Interface NetworkGroupsListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface NetworkGroupsListNextOptionalParams no longer has parameter top info [Changelog] - Interface NetworkInterfacesListVirtualMachineScaleSetIpConfigurationsNextOptionalParams no longer has parameter expand info [Changelog] - Interface NetworkManagersListBySubscriptionNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface NetworkManagersListBySubscriptionNextOptionalParams no longer has parameter top info [Changelog] - Interface NetworkManagersListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface NetworkManagersListNextOptionalParams no longer has parameter top info [Changelog] - Interface ScopeConnectionsListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface ScopeConnectionsListNextOptionalParams no longer has parameter top info [Changelog] - Interface SecurityAdminConfigurationsListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface SecurityAdminConfigurationsListNextOptionalParams no longer has parameter top info [Changelog] - Interface ServiceTagInformationListNextOptionalParams no longer has parameter noAddressPrefixes info [Changelog] - Interface ServiceTagInformationListNextOptionalParams no longer has parameter tagName info [Changelog] - Interface StaticMembersListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface StaticMembersListNextOptionalParams no longer has parameter top info [Changelog] - Interface SubscriptionNetworkManagerConnectionsListNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface SubscriptionNetworkManagerConnectionsListNextOptionalParams no longer has parameter top info [Changelog] - Interface VirtualNetworksListDdosProtectionStatusNextOptionalParams no longer has parameter skipToken info [Changelog] - Interface VirtualNetworksListDdosProtectionStatusNextOptionalParams no longer has parameter top
️🔄 azure-resource-manager-schemas inProgress [Detail]
️❌ azure-powershell failed [Detail]
❌Failed [Logs] Generate from 3f2dcf868fa25036ded606f900e3e75eb3a9b9d2. 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.network [View full logs] [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/network/armnetwork | https://apiview.dev/Assemblies/Review/a7e548fe643042ccbc5df033d129ca5f |
| Java | azure-resourcemanager-network-generated | https://apiview.dev/Assemblies/Review/2f840812d5c24853bfdeb2aa5c44dae5 |
| .Net | Azure.ResourceManager.Network | There is no API change compared with the previous version |
| JavaScript | @azure/arm-network | https://apiview.dev/Assemblies/Review/5d396cb1b58e47a6ba93004b30dafad7 |
Hi, @yanfa317 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Hi @yanfa317, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi @yanfa317, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
@yanfa317 - Please use the instructions in this comment to request ARM revisit of your PR: https://github.com/Azure/azure-rest-api-specs/pull/21970#issuecomment-1368044696.
