azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Swagger changes for NSP Patch API.
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
- [ ] 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"
- [ ] 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:
-
[ ] 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.
-
[ ] 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, @Aastha20 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.
![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-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 + Interface DdosProtectionPlan no longer has parameter publicIpAddresses
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ebc9beff769a5742ab8b61b1e00a823a67373f20. 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 ebc9beff769a5742ab8b61b1e00a823a67373f20. 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 ebc9beff769a5742ab8b61b1e00a823a67373f20. 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
️✔️track2_azure-mgmt-network [View full logs] [Preview SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation NetworkSecurityPerimetersOperations.patch info [Changelog] - Model NetworkWatcher has a new parameter running_operation_ids
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from ebc9beff769a5742ab8b61b1e00a823a67373f20. 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 ebc9beff769a5742ab8b61b1e00a823a67373f20. 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] ### Features Added info [Changelog] info [Changelog] - New struct `DelegationProperties` info [Changelog] - New struct `PartnerManagedResourceProperties` info [Changelog] - New field `VirtualNetwork` in struct `BackendAddressPoolPropertiesFormat` info [Changelog] - New field `CustomBlockResponseBody` in struct `PolicySettings` info [Changelog] - New field `CustomBlockResponseStatusCode` in struct `PolicySettings` info [Changelog] - New field `Delegation` in struct `VirtualAppliancePropertiesFormat` info [Changelog] - New field `DeploymentType` in struct `VirtualAppliancePropertiesFormat` info [Changelog] - New field `PartnerManagedResource` in struct `VirtualAppliancePropertiesFormat` info [Changelog] info [Changelog] Total 0 breaking change(s), 7 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from ebc9beff769a5742ab8b61b1e00a823a67373f20. 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] **Features** info [Changelog] info [Changelog] - Added Interface DdosProtectionPlansDeleteHeaders info [Changelog] - Added Interface DelegationProperties info [Changelog] - Added Interface PartnerManagedResourceProperties info [Changelog] - Added Interface PublicIPAddressesDdosProtectionStatusHeaders info [Changelog] - Added Interface PublicIPAddressesDeleteHeaders info [Changelog] - Interface BackendAddressPool has a new optional parameter virtualNetwork info [Changelog] - Interface DdosProtectionPlan has a new optional parameter publicIPAddresses info [Changelog] - Interface NetworkVirtualAppliance has a new optional parameter delegation info [Changelog] - Interface NetworkVirtualAppliance has a new optional parameter deploymentType info [Changelog] - Interface NetworkVirtualAppliance has a new optional parameter partnerManagedResource info [Changelog] - Interface PolicySettings has a new optional parameter customBlockResponseBody info [Changelog] - Interface PolicySettings has a new optional parameter customBlockResponseStatusCode info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Interface DdosProtectionPlan no longer has parameter publicIpAddresses
️❌ azure-resource-manager-schemas failed [Detail]
❌Failed [Logs] Generate from ebc9beff769a5742ab8b61b1e00a823a67373f20. 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] WARN 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
❌network/resource-manager [View full logs] [Preview Schema Changes]
️❌ azure-powershell failed [Detail]
❌Failed [Logs] Generate from ebc9beff769a5742ab8b61b1e00a823a67373f20. 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]
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.
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.
Can you mark the changelog properly and see if you need a new API version base on the auto detection, and when you are ready, relabel the PR with waitforarmfeedback, thanks.
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
Hi, @Aastha20. 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.
The SDK breaking changes are not related to this PR.
We are using 3 versions as of now to roll out our changes, “2021-02-01-preview”, “2021-05-01-preview” and “2022-02-01-preview”. Our service (Network Security Perimeter) is still in private preview and is being tested by only one customer. Therefore, I have made all the files consistent in the above stated version folders and removed our changes from any remaining folders. The other versions are in use by other teams. The changes that I have added are not a breaking change since we are still in private preview. To answer your question specifically, I have removed our files (including networkSecurityPerimeter.json) from the “2021-03-01-preview” folder as we do not support that version. Let me know if you have any further questions and if its okay to approve the changes.
Can you mark the changelog properly and see if you need a new API version base on the auto detection, and when you are ready, relabel the PR with waitforarmfeedback, thanks.
I have made the necessary changes in the ADO task : https://msazure.visualstudio.com/One/_workitems/edit/15891696/
We are using 3 versions as of now to roll out our changes, “2021-02-01-preview”, “2021-05-01-preview” and “2022-02-01-preview”. Our service (Network Security Perimeter) is still in private preview and is being tested by only one customer. Therefore, I have made all the files consistent in the above stated version folders and removed our changes from any remaining folders. The other versions are in use by other teams. The changes that I have added are not a breaking change since we are still in private preview. To answer your question specifically, I have removed our files (including networkSecurityPerimeter.json) from the “2021-03-01-preview” folder as we do not support that version. Let me know if you have any further questions and if its okay to approve the changes.
The SDK breaking changes are not related to this PR.
The changes are related to a new service called network security perimeter (NSP) which is not yet exposed to customers. In this PR, we have used the same version that we had used earlier (2021-02-01-preview) as all the resources and APIs need to go together.
I can see from the wiki that a newer preview version is to be used. However, if we have to use anything other than the existing versions (we have 2021-02-01-review and 2021-05-01-preview), we need to add them in the NRP manifest file. The manifest rollout will take a lot of time and we may miss the release deadlines
What I mean is the SDK breaking changes. I don't think the below part is related to your PR.
❌azure-sdk-for-js - @azure/arm-network - 31.0.0
- Interface DdosProtectionPlan no longer has parameter publicIpAddresses
- Interface AdminRule no longer has parameter kind
- Interface DefaultAdminRule no longer has parameter kind
Can you mark the changelog properly and see if you need a new API version base on the auto detection, and when you are ready, relabel the PR with waitforarmfeedback, thanks.
I have made the necessary changes in the ADO task : https://msazure.visualstudio.com/One/_workitems/edit/15891696/
The changes are related to a new service called network security perimeter (NSP) which is not yet exposed to customers. In this PR, we have used the same version that we had used earlier (2021-02-01-preview) as all the resources and APIs need to go together.
I can see from the wiki that a newer preview version is to be used. However, if we have to use anything other than the existing versions (we have 2021-02-01-review and 2021-05-01-preview), we need to add them in the NRP manifest file. The manifest rollout will take a lot of time and we may miss the release deadlines
Please follow up with @JeffreyRichter to review this breaking change.
If the 2021-02-01-preview version is already available to customers, then we cannot change it in any way (as per Azure policy). Doing so would mean that we have multiple versions of a single version and this is very confusing to customers and Azure Customer Support Services when they try to help customers because it's impossible to ask a customer what version of the service they are using and know what features are or are not supported in that version.
Azure's policy is designed for the best customer experience and not designed to simplify or speed up the manifest deployment for MS engineers. Any changes to an API contract (including additions) must be done via a new api-version (as per Azure policy).
Hi @Aastha20, 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.
Hi @Aastha20, 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 |
Approving breaking change as it only affects parts of the service not yet exposed in public preview.
If the 2021-02-01-preview version is already available to customers, then we cannot change it in any way (as per Azure policy). Doing so would mean that we have multiple versions of a single version and this is very confusing to customers and Azure Customer Support Services when they try to help customers because it's impossible to ask a customer what version of the service they are using and know what features are or are not supported in that version.
Azure's policy is designed for the best customer experience and not designed to simplify or speed up the manifest deployment for MS engineers. Any changes to an API contract (including additions) must be done via a new api-version (as per Azure policy).
The version "2021-02-01-preview" or any other version for that matter is not available to customers. It is being used for testing. We are still in private preview.
have fixed Avocado and prettier check. Please approve the PR so that I can merge it
have fixed Avocado and prettier check. Please approve the PR so that I can merge it
The PR is marked armChangeRequested, could you address the feedback from ARM team and ask them to review & approve this PR?
Hi, @Aastha20. 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, @Aastha20. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.