Fixing Documentation +Bugs on PublicIPAddress & DdosProtectionPlan Resources #21300

mchakka · 2022-10-26T23:04:55Z

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.

We recently added a fix for the 2022-05-01 version to fix the documentation and we're making the change for the newest API version. Link to the fix for the previous version: #20978

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: ⚠️

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.

openapi-workflow-bot · 2022-10-26T23:04:58Z

Hi, @mchakka Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2022-10-26T23:04:58Z

Swagger Validation Report

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

There are no breaking changes.

️❌Breaking Change(Cross-Version): 1 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.1)]	new version	base version
ddosProtectionPlan.json	2022-07-01(9ae0172)	2022-05-01(main)
publicIpAddress.json	2022-07-01(9ae0172)	2022-05-01(main)

The following breaking changes are detected by comparison with the latest stable version:

Rule	Message
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'publicIpAddresses' renamed or removed? New: Microsoft.Network/stable/2022-07-01/ddosProtectionPlan.json#L402:7 Old: Microsoft.Network/stable/2022-05-01/ddosProtectionPlan.json#L396:7

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-07	package-2022-07(9ae0172)	package-2022-07(release-network-Microsoft.Network-2022-07-01)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` R4037 - MissingTypeObject	The schema 'DdosProtectionPlan' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/ddosProtectionPlan.json#L359
`❌` R4037 - MissingTypeObject	The schema 'DdosProtectionPlanPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/ddosProtectionPlan.json#L401
`❌` R4037 - MissingTypeObject	The schema 'DdosProtectionPlanListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/ddosProtectionPlan.json#L432
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L435
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L464
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L464
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L464
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L464
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L464
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L464
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L464
`❌` R4037 - MissingTypeObject	The schema 'PublicIPAddressPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/stable/2022-07-01/publicIpAddress.json#L464

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

Validation passes for Avocado.

️️✔️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.

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

openapi-pipeline-app · 2022-10-26T23:04:59Z

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 DdosProtectionPlan no longer has parameter publicIpAddresses

⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-network - 22.1.0

+	Removed operation group NspLinkReconcileOperations
+	Removed operation group NspLinkReferenceReconcileOperations
+	Removed operation group NspLinkReferencesOperations
+	Removed operation group NspLinksOperations

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

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

warn	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 --use=@microsoft.azure/autorest.csharp@2.3.82 --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]
- Microsoft.Azure.Management.Network.24.0.0.nupkg
- Microsoft.Azure.Management.Network.24.0.0.symbols.nupkg

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed [Logs] Generate from a3f618b7ac364e65438d324f0d13af747cfed927. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[91mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:517
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m 517 | �[0m         �[96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m     | �[91m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[91m�[96m     | �[91mFailed to generate sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[91mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:601
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m 601 | �[0m … rtifacts += �[96mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m     | �[91m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[91m�[96m     | �[91mCannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m     | �[91m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because it does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[91mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:517
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m 517 | �[0m         �[96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[96m     | �[91m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[91m�[96m     | �[91mFailed to generate sdk artifact
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.ResourceManager.Network [View full logs] [Preview SDK Changes]
```
info	[Changelog]
```

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

⚠️Warning [Logs] Generate from a3f618b7ac364e65438d324f0d13af747cfed927. 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.
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] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Removed operation group NspLinkReconcileOperations
info	[Changelog]   - Removed operation group NspLinkReferenceReconcileOperations
info	[Changelog]   - Removed operation group NspLinkReferencesOperations
info	[Changelog]   - Removed operation group NspLinksOperations

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

️✔️Succeeded [Logs] Generate from a3f618b7ac364e65438d324f0d13af747cfed927. 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
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 a3f618b7ac364e65438d324f0d13af747cfed927. 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
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 `DeploymentType` in struct `VirtualAppliancePropertiesFormat`
info	[Changelog] - New field `PartnerManagedResource` in struct `VirtualAppliancePropertiesFormat`
info	[Changelog] - New field `Delegation` in struct `VirtualAppliancePropertiesFormat`
info	[Changelog] - New field `CustomBlockResponseStatusCode` in struct `PolicySettings`
info	[Changelog] - New field `CustomBlockResponseBody` in struct `PolicySettings`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 6 additive change(s).

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

️✔️Succeeded [Logs] Generate from a3f618b7ac364e65438d324f0d13af747cfed927. 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-network [View full logs] [Preview SDK Changes] Breaking Change Detected

azure-arm-network-31.0.0.tgz

info	[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 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 inProgress [Detail]

️❌ azure-powershell failed [Detail]

❌Failed [Logs] Generate from a3f618b7ac364e65438d324f0d13af747cfed927. SDK Automation 14.0.0

command	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]

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

openapi-pipeline-app · 2022-10-26T23:05:00Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/network/armnetwork	https://apiview.dev/Assemblies/Review/4cd79a73eb5b4988adb0d5f3772e9bd0
Java	azure-resourcemanager-network-generated	https://apiview.dev/Assemblies/Review/0a2790e13a324f3a8b9a26b60369b822
JavaScript	@azure/arm-network	https://apiview.dev/Assemblies/Review/871b33b821b748d59488135ea38666a8
Python	track2_azure-mgmt-network	Create ApiView timeout. Package is too large and we cannot create ApiView for it.

openapi-workflow-bot · 2022-10-26T23:38:26Z

Hi @mchakka, 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

If you need further help, please feedback via swagger feedback.

openapi-workflow-bot · 2022-10-28T21:23:19Z

Hi @mchakka, 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.

raych1 · 2022-10-31T00:51:25Z

@mchakka , please fix modelvalidation failures and request breaking change review approval.

mchakka · 2022-10-31T23:02:52Z

Regarding Breaking change - this is not a breaking change, it's actually a bug fix. While building the Powershell cmdlets, we noticed that the swagger defintion had a mis-match to the actual response from the API in NRP, hence we're making the fix here so the new SDK will match the response from NRP so that the PS cmdlets will finally work.

The feature is not released to customers yet so we will not be breaking anything through this change. Please let us know how to proceed as we're on a tight deadline for the monthly network swagger release

* Adds base for updating Microsoft.Network from version stable/2022-05-01 to version 2022-07-01 * Updates readme * Updates API version in new specs and examples * Adds a SaaS NVA swagger changes (#20973) * add saas nva swagger changes * add saas nva put example * add arm-id format * minor change * address review comments * add custom words * Sync python sdk config change from main (#21129) * 12997638: Custom Block Response support for AppGW WAF (#21113) * 12997638: Custom Block Response support for AppGW WAF * 12997638: CustomBlockresponse for Appgw WAF - added example * 12997638: Custom Block Response for AppGW WAF lint fix Co-authored-by: akshaymurali <akshaymurali@microsoft.com> * Cherry picked resurrected verification (#21218) * Fixing Documentation +Bugs on PublicIPAddress & DdosProtectionPlan Resources (#21300) * small fix * bug fix * some model validation fixes * more model validation fixes? * more fixes * fixed prettier Co-authored-by: Manas Chakka <manaschakka@microsoft.com> Co-authored-by: Haoran Hong <88764852+honghr@users.noreply.github.com> Co-authored-by: sbhosalemsft <98562322+sbhosalemsft@users.noreply.github.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: akshaym6 <35283938+akshaym6@users.noreply.github.com> Co-authored-by: akshaymurali <akshaymurali@microsoft.com> Co-authored-by: Mikhail <mitryakh@microsoft.com> Co-authored-by: Manas Chakka <mchakka@gmail.com> Co-authored-by: Manas Chakka <manaschakka@microsoft.com>

* Adds base for updating Microsoft.Network from version stable/2022-05-01 to version 2022-07-01 * Updates readme * Updates API version in new specs and examples * Adds a SaaS NVA swagger changes (Azure#20973) * add saas nva swagger changes * add saas nva put example * add arm-id format * minor change * address review comments * add custom words * Sync python sdk config change from main (Azure#21129) * 12997638: Custom Block Response support for AppGW WAF (Azure#21113) * 12997638: Custom Block Response support for AppGW WAF * 12997638: CustomBlockresponse for Appgw WAF - added example * 12997638: Custom Block Response for AppGW WAF lint fix Co-authored-by: akshaymurali <akshaymurali@microsoft.com> * Cherry picked resurrected verification (Azure#21218) * Fixing Documentation +Bugs on PublicIPAddress & DdosProtectionPlan Resources (Azure#21300) * small fix * bug fix * some model validation fixes * more model validation fixes? * more fixes * fixed prettier Co-authored-by: Manas Chakka <manaschakka@microsoft.com> Co-authored-by: Haoran Hong <88764852+honghr@users.noreply.github.com> Co-authored-by: sbhosalemsft <98562322+sbhosalemsft@users.noreply.github.com> Co-authored-by: Ray Chen <raychen@microsoft.com> Co-authored-by: akshaym6 <35283938+akshaym6@users.noreply.github.com> Co-authored-by: akshaymurali <akshaymurali@microsoft.com> Co-authored-by: Mikhail <mitryakh@microsoft.com> Co-authored-by: Manas Chakka <mchakka@gmail.com> Co-authored-by: Manas Chakka <manaschakka@microsoft.com>

small fix

c0cedaa

mchakka requested a review from MikhailTryakhov as a code owner October 26, 2022 23:04

openapi-assignment-bot bot assigned raych1 Oct 26, 2022

ghost added the Network label Oct 26, 2022

AzureRestAPISpecReview added CI-FixRequiredOnFailure resource-manager labels Oct 26, 2022

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Oct 27, 2022

mchakka changed the title ~~Fixing Documentation on Public IP Address~~ Fixing Documentation on Public IP Address for 2022-07-01 API Version Oct 27, 2022

mchakka changed the title ~~Fixing Documentation on Public IP Address for 2022-07-01 API Version~~ Fixing Documentation +Bugs on Public IP Address Resourc Oct 28, 2022

mchakka changed the title ~~Fixing Documentation +Bugs on Public IP Address Resourc~~ Fixing Documentation +Bugs on Public IP Address Resource Oct 28, 2022

mchakka changed the title ~~Fixing Documentation +Bugs on Public IP Address Resource~~ Fixing Documentation +Bugs on PublicIPAddress & DdosProtectionPlan Resources Oct 28, 2022

bug fix

cf9b7ec

AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 28, 2022

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Oct 28, 2022

Manas Chakka added 2 commits October 31, 2022 14:44

some model validation fixes

e4ca209

more model validation fixes?

1cf1d1c

Manas Chakka added 2 commits October 31, 2022 15:36

more fixes

bea517c

fixed prettier

9ae0172

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 1, 2022

raych1 approved these changes Nov 2, 2022

View reviewed changes

raych1 merged commit 62b9f65 into release-network-Microsoft.Network-2022-07-01 Nov 2, 2022

raych1 deleted the manaschakka/fixdocumentation branch November 2, 2022 01:42

mchakka mentioned this pull request Nov 2, 2022

Bug Fix for Viewing the PSPublicIpAddress & PSDdosProtectionPlan objects Azure/azure-powershell#19981

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixing Documentation +Bugs on PublicIPAddress & DdosProtectionPlan Resources #21300

Fixing Documentation +Bugs on PublicIPAddress & DdosProtectionPlan Resources #21300

mchakka commented Oct 26, 2022 •

edited

Loading

openapi-workflow-bot bot commented Oct 26, 2022

openapi-pipeline-app bot commented Oct 26, 2022 •

edited

Loading

openapi-pipeline-app bot commented Oct 26, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Oct 26, 2022 •

edited

Loading

openapi-workflow-bot bot commented Oct 26, 2022

openapi-workflow-bot bot commented Oct 28, 2022

raych1 commented Oct 31, 2022

mchakka commented Oct 31, 2022

Fixing Documentation +Bugs on PublicIPAddress & DdosProtectionPlan Resources #21300

Fixing Documentation +Bugs on PublicIPAddress & DdosProtectionPlan Resources #21300

Conversation

mchakka commented Oct 26, 2022 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Oct 26, 2022

openapi-pipeline-app bot commented Oct 26, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Oct 26, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Oct 26, 2022 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Oct 26, 2022

openapi-workflow-bot bot commented Oct 28, 2022

raych1 commented Oct 31, 2022

mchakka commented Oct 31, 2022

mchakka commented Oct 26, 2022 •

edited

Loading

openapi-pipeline-app bot commented Oct 26, 2022 •

edited

Loading

openapi-pipeline-app bot commented Oct 26, 2022 •

edited

Loading

openapi-pipeline-app bot commented Oct 26, 2022 •

edited

Loading