Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Adding GET operation for Network Virtual Appliance Inbound Secuirty Rules #29339

Merged
merged 1 commit into from
Jun 10, 2024
Merged

Adding GET operation for Network Virtual Appliance Inbound Secuirty Rules #29339

merged 1 commit into from
Jun 10, 2024

Conversation

ashutmi
Copy link
Contributor

@ashutmi ashutmi commented Jun 5, 2024 •
edited
Loading

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@ashutmi ashutmi requested a review from Joanna-Yang-Art as a code owner June 5, 2024 10:36
@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 5, 2024 •
edited
Loading

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 5, 2024 •
edited
Loading

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
There are no breaking changes.
Compared specs (v0.10.9) new version base version
networkVirtualAppliance.json 2024-01-01(2aea0d7) 2023-11-01(main)
️⚠️LintDiff: 4 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-2024-01 package-2024-01(2aea0d7) package-2024-01(release-network-Microsoft.Network-2024-01-01)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ RequiredReadOnlySystemData The response of operation:'InboundSecurityRule_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L848
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'InboundSecurityRuleModel'. Consider using the plural form of 'InboundSecurityRule' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L849
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L853
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create Network Virtual Appliance Inbound Security Rules
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L894


The following errors/warnings exist before current PR submission:

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

Rule Message
❌ ResourceNameRestriction The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L37
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L38
❌ ParametersInPointGet Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L105
❌ PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L181
❌ ResourceNameRestriction The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L288
❌ ResourceNameRestriction The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L448
❌ ResourceNameRestriction The resource name parameter 'siteName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L448
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L449
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L488
❌ ResourceNameRestriction The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L641
❌ PathForTrackedResourceTypes The path must be under a subscription and resource group for tracked resource types.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L733
❌ ResourceNameRestriction The resource name parameter 'skuName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L733
❌ ResourceNameRestriction The resource name parameter 'networkVirtualApplianceName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L776
❌ ResourceNameRestriction The resource name parameter 'ruleCollectionName' should be defined with a 'pattern' restriction.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L776
❌ MissingTypeObject The schema 'NetworkVirtualAppliance' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L903
❌ MissingTypeObject The schema 'NetworkVirtualAppliancePropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L927
❌ MissingTypeObject The schema 'VirtualApplianceSkuProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1063
❌ MissingTypeObject The schema 'VirtualApplianceNicProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1083
❌ MissingTypeObject The schema 'VirtualApplianceSite' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1221
❌ MissingTypeObject The schema 'VirtualApplianceSiteProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1250
❌ MissingTypeObject The schema 'Office365PolicyProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1270
❌ MissingTypeObject The schema 'BreakOutCategoryPolicies' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1280
❌ AllTrackedResourcesMustHaveDelete The resource NetworkVirtualApplianceSku does not have a corresponding delete operation.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1300
❌ MissingTypeObject The schema 'NetworkVirtualApplianceSku' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1300
❌ TrackedResourcePatchOperation Tracked resource 'NetworkVirtualApplianceSku' must have patch operation that at least supports the update of tags.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1300
❌ TrackedResourcesMustHavePut The tracked resource NetworkVirtualApplianceSku does not have a corresponding put operation.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1300
❌ MissingTypeObject The schema 'NetworkVirtualApplianceSkuPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1321
❌ MissingTypeObject The schema 'NetworkVirtualApplianceSkuInstances' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1347
❌ MissingTypeObject The schema 'NetworkVirtualApplianceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1364
❌ MissingTypeObject The schema 'NetworkVirtualApplianceSiteListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/stable/2024-01-01/networkVirtualAppliance.json#L1380
️️✔️Avocado succeeded [Detail] [Expand] 
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand] 
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand] 
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 5, 2024 •
edited
Loading

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-java failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-go failed [Detail]

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

️❌ azure-resource-manager-schemas failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-powershell warning [Detail]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 5, 2024 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
JavaScript @azure/arm-network https://apiview.dev/Assemblies/Review/c13fd66ecbcc4c2a9995c8a1f4187240?revisionId=5d5ea768d4b14092ab0f6d97965f5a90
Swagger Microsoft.Network https://apiview.dev/Assemblies/Review/9a91f46aa0a846acaae91aba821517fb?revisionId=d0db16e5aa844392a25bf443255a9fe3

This was referenced Jun 5, 2024
Closed
Closed
Closed
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 5, 2024
@azure-sdk azure-sdk mentioned this pull request Jun 5, 2024
Closed
@rkmanda rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 9, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 9, 2024
@ashutmi
Copy link
Contributor Author

ashutmi commented Jun 10, 2024

/pr RequestMerge

@rkmanda rkmanda merged commit c3086a2 into Azure:release-network-Microsoft.Network-2024-01-01 Jun 10, 2024
23 of 29 checks passed
ashutmi added a commit to ashutmi/azure-rest-api-specs that referenced this pull request Jun 10, 2024
@ashutmi
Adding GET operaton for Network Virtual Appliance Inbound Secuirty Ru…
58fb7c7 
…le (Azure#29339)
@ashutmi ashutmi mentioned this pull request Jun 10, 2024
Merged
GuptaVertika pushed a commit that referenced this pull request Jun 10, 2024
@ashutmi
Adding GET operaton for Network Virtual Appliance Inbound Secuirty Ru…
51433e1 
…le (#29339) (#29375)
rkmanda pushed a commit that referenced this pull request Jun 19, 2024
@GuptaVertika @saurabh83
@abhi7860 @arsheen @EugenioPena @daweiwang-microsoft @bhupeshbhatt1985 @bhupeshbhattmicrosoft @ashutmi @Khushboo-Baheti @jianzhao1992 @nimaller
Guptavertika/release network microsoft.network official 2024 01 01 (#…
b48d5d7 
…29302)

* Adds base for updating Microsoft.Network from version stable/2023-11-01 to version 2024-01-01

* Updates readme

* Updates API version in new specs and examples

* Add examples for Subnet peering and v6 Subnet peering. (#28827)

Add examples for Subnet peering and v6 Subnet peering.
---------

Co-authored-by: saurabh83 <[email protected]>

* Init (#29127)

Co-authored-by: Abhishek Shah <[email protected]>

* Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 (#29048)

Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>

* Added NoHealthyBackendsBehavior (#28868)

Added the property "NoHealthyBackendsBehavior" to the Probe properties.

* VirtualNetworkGatewayConnection using key vault for authentication. (#28760)

* Add parameters for cert based auth connection

* retrigger checks

* retrigger checks

* lintDiff

* Trigger Build

* revert PATCH changes

* fix

* change managed identity to v5

* add format and description

* rresolving conflict

* resolving readme file

* Revert "VirtualNetworkGatewayConnection using key vault for authentication. (#28760)"

This reverts commit c37ec24.

* Lint diff error suppress

* Guptavertika/release network microsoft.network official 2024 01 01 (#29367)

* added networkidentifier under vnet->subet->serviceendpoint

* added format :armid and updated description

* corrected the type

* fixed response

* response type fixed example

---------

Co-authored-by: Bhupesh Bhatt <[email protected]>

* Adding GET operaton for Network Virtual Appliance Inbound Secuirty Rule (#29339) (#29375)

* Fix for PR VirtualNetworkGatewayConnection using key vault for authentication. (#29357) (#29376)

* Fix

* Fix2

---------

Co-authored-by: Khushboo Baheti <[email protected]>

* Add CrossConnection Name as an optional query parameter in List ExpressRoute CrossConnection (#29251)

* Add CrossConnection name as an optional query parameter for List CrossConnection

* update example

* Addressing comments

* Change to OData filtering

* Fix the parameter reference

* Update

---------

Co-authored-by: Jianqi Zhao <[email protected]>

* initial changes (#29235)

* Changed type of networkIdentifier from PublicIPAddress to SubResource (#29469)

* added networkidentifier under vnet->subet->serviceendpoint

* added format :armid and updated description

* corrected the type

* fixed response

* response type fixed example

* Changed type of networkIdentifier from ./publicIpAddress.json#/definitions/PublicIPAddress to ./network.json#/definitions/SubResource

---------

Co-authored-by: Bhupesh Bhatt <[email protected]>

---------

Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: AFK1194 <[email protected]>
Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>
Co-authored-by: Eugenio Peña García <[email protected]>
Co-authored-by: daweiwang-microsoft <[email protected]>
Co-authored-by: Bhupesh Kumar Bhatt <[email protected]>
Co-authored-by: Bhupesh Bhatt <[email protected]>
Co-authored-by: Ashutosh Mishra <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: jianzhao1992 <[email protected]>
Co-authored-by: Jianqi Zhao <[email protected]>
Co-authored-by: nimaller <[email protected]>
mentat9 pushed a commit that referenced this pull request Jun 21, 2024
@nikhilpadhye1 @GuptaVertika
@saurabh83 @abhi7860 @arsheen @EugenioPena @daweiwang-microsoft @bhupeshbhatt1985 @Khushboo-Baheti @ashutmi @jianzhao1992 @nimaller
Moving missed changes from 2023-11-01 packet capture swagger fix to l… (
a0ace9e 
#29473)

* Adds base for updating Microsoft.Network from version stable/2023-11-01 to version 2024-01-01

* Updates readme

* Updates API version in new specs and examples

* Add examples for Subnet peering and v6 Subnet peering. (#28827)

Add examples for Subnet peering and v6 Subnet peering.
---------

Co-authored-by: saurabh83 <[email protected]>

* Init (#29127)

Co-authored-by: Abhishek Shah <[email protected]>

* Adding the new response code to the 2024-01-01 version release of swagger to match the bugfix in 2023-11-01 (#29048)

Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>

* Added NoHealthyBackendsBehavior (#28868)

Added the property "NoHealthyBackendsBehavior" to the Probe properties.

* VirtualNetworkGatewayConnection using key vault for authentication. (#28760)

* Add parameters for cert based auth connection

* retrigger checks

* retrigger checks

* lintDiff

* Trigger Build

* revert PATCH changes

* fix

* change managed identity to v5

* add format and description

* added networkidentifier under vnet->subet->serviceendpoint (#29292)

* added networkidentifier under vnet->subet->serviceendpoint

* resolving conflict (#29343)

* Fix for PR VirtualNetworkGatewayConnection using key vault for authentication. (#29357)

* Fix

* Fix2

---------

Co-authored-by: Khushboo Baheti <[email protected]>

* Adding GET operaton for Network Virtual Appliance Inbound Secuirty Rule (#29339)

* Moving missed changes from 2023-11-01 packet capture swagger fix to latest api version

* Add CrossConnection Name as an optional query parameter in List ExpressRoute CrossConnection (#29251)

* Add CrossConnection name as an optional query parameter for List CrossConnection

* update example

* Addressing comments

* Change to OData filtering

* Fix the parameter reference

* Update

---------

Co-authored-by: Jianqi Zhao <[email protected]>

* initial changes (#29235)

* adding supression for the breaking change in azure-sdk-for-go

* adding correct package for this supression

---------

Co-authored-by: GuptaVertika <[email protected]>
Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: saurabh83 <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: Abhishek Shah <[email protected]>
Co-authored-by: AFK1194 <[email protected]>
Co-authored-by: Arsheen Khatib (from Dev Box) <[email protected]>
Co-authored-by: Eugenio Peña García <[email protected]>
Co-authored-by: daweiwang-microsoft <[email protected]>
Co-authored-by: Bhupesh Kumar Bhatt <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: Khushboo Baheti <[email protected]>
Co-authored-by: Ashutosh Mishra <[email protected]>
Co-authored-by: jianzhao1992 <[email protected]>
Co-authored-by: Jianqi Zhao <[email protected]>
Co-authored-by: nimaller <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rkmanda rkmanda rkmanda approved these changes

@Joanna-Yang-Art Joanna-Yang-Art Awaiting requested review from Joanna-Yang-Art

@GuptaVertika GuptaVertika Awaiting requested review from GuptaVertika

Assignees
No one assigned
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review resource-manager
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ashutmi @rkmanda @AzureRestAPISpecReview