-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update property in load balancer for Connection Draining Phase 1 #23082
Update property in load balancer for Connection Draining Phase 1 #23082
Conversation
Hi, @phrazfipho Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
loadBalancer.json | 2022-11-01(c8bc29d) | 2022-09-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
1019 - RemovedEnumValue |
The new version is removing enum value(s) 'Drain' from the old version. New: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1730:9 Old: Microsoft.Network/stable/2022-09-01/loadBalancer.json#L1730:9 |
1025 - RequiredStatusChange |
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.Network/stable/2022-11-01/networkSecurityGroup.json#L720:7 Old: Microsoft.Network/stable/2022-09-01/networkSecurityGroup.json#L720:7 |
1033 - RemovedProperty |
The new version is missing a property found in the old version. Was 'applicationGatewayIPConfigurations' renamed or removed? New: Microsoft.Network/stable/2022-11-01/virtualNetwork.json#L1500:7 Old: Microsoft.Network/stable/2022-09-01/virtualNetwork.json#L1500:7 |
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-11 | package-2022-11(c8bc29d) | package-2022-11(release-Microsoft.Network-2022-11-01) |
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 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L37 |
LongRunningResponseStatusCode |
A 'delete' operation 'LoadBalancers_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L38 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L70 |
PatchSkuProperty |
The patch operation body parameter schema should contains property 'sku'. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L263 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L385 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L441 |
ResourceNameRestriction |
The resource name parameter 'backendAddressPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L441 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L613 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L637 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L690 |
ResourceNameRestriction |
The resource name parameter 'frontendIPConfigurationName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L690 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L747 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L800 |
ResourceNameRestriction |
The resource name parameter 'inboundNatRuleName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L800 |
LongRunningResponseStatusCode |
A 'delete' operation 'InboundNatRules_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L801 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L840 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1000 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1053 |
ResourceNameRestriction |
The resource name parameter 'loadBalancingRuleName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1053 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1110 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1163 |
ResourceNameRestriction |
The resource name parameter 'outboundRuleName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1163 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1220 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1276 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1364 |
ResourceNameRestriction |
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1385 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1385 |
ResourceNameRestriction |
The resource name parameter 'backendPoolName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1385 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1437 |
ResourceNameRestriction |
The resource name parameter 'loadBalancerName' should be defined with a 'pattern' restriction. Location: Microsoft.Network/stable/2022-11-01/loadBalancer.json#L1461 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
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
|
Generated ApiView
|
Hi @phrazfipho, 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. |
Hi @phrazfipho, Your PR has some issues. Please fix the CI sequentially by following the order of
|
The SDK breakings are not related to this PR. |
* Adds base for updating Microsoft.Network from version stable/2022-09-01 to version 2022-11-01 * Updates readme * Updates API version in new specs and examples * remove loadDistributionPolicy from appgw PUT request body example (#23144) * remove loadDistributionPolicy from appgw PUT request body example * remove loadDistributionPolicy from appgw PUT request body example2 * remove loadDistributionPolicy from appgw PUT request body example * remove duplicates * add private link configuration to see if it will fix validation error * remove privateLinkConfig related * revert changes to see if still get validation error * update back to original changes * add response resource id to fix modelValidation error * add connection resource * Selector in Exclusions should not be required as Operator EqualsAny does not need a Selector (#23184) * Application Gateway WAF Rate Limit feature swagger changes (#23021) * Application Gateway WAF Rate Limit feature swagger changes * Fixing lint errors * Updated rate limit feature examples * Fix for applicationGatewayIpConfigurations property and make the priority parameter as required for NSG (#23210) * Fix for applicationGatewayIpConfigurations property This swagger definition is defining property applicationGatewayIpConfigurations, ``` "applicationGatewayIpConfigurations": { "type": "array", "items": { "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayIPConfiguration" }, "description": "Application gateway IP configurations of virtual network resource." } ``` but actual rest api returned applicationGatewayIPConfigurations, the P is upper case while in swagger it is lower case. ``` { "name": "subnet-agw", "id": "/subscriptions/<sub-id>/resourceGroups/<rg-name>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/subnet-agw", "properties": { "applicationGatewayIPConfigurations": [ { "id": "/subscriptions/<sub-id>/resourceGroups/<rg-name>/providers/Microsoft.Network/applicationGateways/<agw-name>/gatewayIPConfigurations/appGatewayIpConfig" } ] }, "type": "Microsoft.Network/virtualNetworks/subnets" } ``` * Making priority property required [This is the API invoked](https://learn.microsoft.com/en-us/rest/api/virtualnetwork/network-security-groups/create-or-update?tabs=HTTP#code-try-0). For the NSG security rules without priorities, seems like the priority parameter is required. Azure portal works as expected. I don't think that's allowed but according to the schema it is because the priority property is not marked as required. I tried to create a NSG security rule without the priorities and it failed with below. Request Body: ``` { "properties": { "securityRules": [ { "name": "rule1", "properties": { "protocol": "*", "sourceAddressPrefix": "*", "destinationAddressPrefix": "*", "access": "Allow", "destinationPortRange": "80", "sourcePortRange": "*", "direction": "Inbound" } } ] }, "location": "eastus" } ``` Response received: ``` { "error": { "code": "SecurityRuleInvalidPriority", "message": "Security rule has invalid Priority. Value provided: 0 Allowed range 100-4096.", "details": [] } } ``` This PR will make the priority parameter as required. * Update NetworkSecurityGroupDelete.json * Update NetworkSecurityGroupRuleDelete.json * Update NetworkSecurityGroupDelete.json * Undo previous change of making fields optional within Exclusion (#23325) * Nivishenker/http headers to insert (#23295) * new app rule property - http header to insert * prettier * add to 22-11-01 * removed changes from 22-09-01 * fixed example * delete RCG example * fix delete examples * added a Location header * prettier fix * Application Gateway WAF Log scrubbing swagger changes (#23022) * Log scrubbing API changes * Update examples * Addressing comments * Fix * Update property in load balancer for Connection Draining Phase 1 (#23082) * Update property in load balancer for Coneection Draining Phase 1 * Fix model validation * Azure Firewall Packet Capture API. Cancelled PR from 2022-09-01 and created for 2022-11-01 (#23114) * moving packet-capture api to 2022-11-01 release from 2022-09-01 * fixing the LRO response header error for model validation * Changes for Additional nic and corrections (#23522) * Changes for Additional nic and corrections * Fixes for tool reported issues * Fix for SpellCheck, ModelValidation * Defining Location in NetworkVirtualApplianceDelete for async * Minor fix * Minor fix * Minor fix * PrettierCheck fixed * Fixing VirtualApplianceAdditionalNicProperties * ModelValidation fixed * Correcting the location header string * Correcting location header * Prettied Check Fix * Fix * Fix * Add inspection limit changes (#23536) * Fixed headers for examples (#23554) * Fix response of API: List of advertised/learned BGP routes (#23555) * fix response type * fix format * fix example, add x-ms-identifiers * AuxiliarySku on Nic (#23552) * Adding auxiliary sku property on nic * Adding AcceleratedConnections to AuxMode * modifying the auxSku values * Removing accidental change --------- Co-authored-by: Prachi Pravin Bhavsar <[email protected]> * migrated latest pr from incorrect branch (#23589) * Changes for NVA connection (#23173) * Changes for NVA connection * Changes to address validation failures * Fix some ModelValidation errors * Fix some ModelValidation errors * Fix some ModelValidation errors * Fix some ModelValidation errors * Fix some ModelValidation errors * Addressing some review comments * Addressing some review comments * Addressing some review comments * Addressing some review comments * Addressing some review comments * Fix camel case for property name * Fixing resourceUri to Camel case in example files * Fix SDK duplication error * Fix one LintDiff error * try fix lintdiff errors * fix lro erro in lintdiff * fix model validation error * Bastion S360 for 2022-11 version (#23595) * Release microsoft.network 2022 11 01 (#23564) * Application Gateway WAF Rate Limit feature swagger changes * Fixing lint errors * Updated rate limit feature examples * rateLimitDuration and rateLimitThreshold are not mandatory. There are only mandatory if ruleType is RateLimitRule. This validation will be done in NRP. * Fix attempt 2. Removed minimum constraint from rateLimitThreshold. Validation will be done in NRP * Remove the minimum number for the option field requestBodyInspectLimitInKB (#23663) * Remove minimum value for optional field requestBodyInspectLimitInKB * Remove exlcusiveMinimum --------- Co-authored-by: htippanaboya <[email protected]> Co-authored-by: tracyMicro <[email protected]> Co-authored-by: tejasshah7 <[email protected]> Co-authored-by: sraghavan-msft <[email protected]> Co-authored-by: navba-MSFT <[email protected]> Co-authored-by: NiviShenker <[email protected]> Co-authored-by: Sindhu Aluguvelli <[email protected]> Co-authored-by: phrazfipho <[email protected]> Co-authored-by: nikhilpadhye1 <[email protected]> Co-authored-by: JainRah <[email protected]> Co-authored-by: karanbazaz <[email protected]> Co-authored-by: yeliMSFT <[email protected]> Co-authored-by: pracsb <[email protected]> Co-authored-by: Prachi Pravin Bhavsar <[email protected]> Co-authored-by: nanditaashok-ms <[email protected]> Co-authored-by: anvrao1 <[email protected]> Co-authored-by: baoqihuang0326 <[email protected]>
* Adds base for updating Microsoft.Network from version stable/2022-09-01 to version 2022-11-01 * Updates readme * Updates API version in new specs and examples * remove loadDistributionPolicy from appgw PUT request body example (Azure#23144) * remove loadDistributionPolicy from appgw PUT request body example * remove loadDistributionPolicy from appgw PUT request body example2 * remove loadDistributionPolicy from appgw PUT request body example * remove duplicates * add private link configuration to see if it will fix validation error * remove privateLinkConfig related * revert changes to see if still get validation error * update back to original changes * add response resource id to fix modelValidation error * add connection resource * Selector in Exclusions should not be required as Operator EqualsAny does not need a Selector (Azure#23184) * Application Gateway WAF Rate Limit feature swagger changes (Azure#23021) * Application Gateway WAF Rate Limit feature swagger changes * Fixing lint errors * Updated rate limit feature examples * Fix for applicationGatewayIpConfigurations property and make the priority parameter as required for NSG (Azure#23210) * Fix for applicationGatewayIpConfigurations property This swagger definition is defining property applicationGatewayIpConfigurations, ``` "applicationGatewayIpConfigurations": { "type": "array", "items": { "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayIPConfiguration" }, "description": "Application gateway IP configurations of virtual network resource." } ``` but actual rest api returned applicationGatewayIPConfigurations, the P is upper case while in swagger it is lower case. ``` { "name": "subnet-agw", "id": "/subscriptions/<sub-id>/resourceGroups/<rg-name>/providers/Microsoft.Network/virtualNetworks/<vnet-name>/subnets/subnet-agw", "properties": { "applicationGatewayIPConfigurations": [ { "id": "/subscriptions/<sub-id>/resourceGroups/<rg-name>/providers/Microsoft.Network/applicationGateways/<agw-name>/gatewayIPConfigurations/appGatewayIpConfig" } ] }, "type": "Microsoft.Network/virtualNetworks/subnets" } ``` * Making priority property required [This is the API invoked](https://learn.microsoft.com/en-us/rest/api/virtualnetwork/network-security-groups/create-or-update?tabs=HTTP#code-try-0). For the NSG security rules without priorities, seems like the priority parameter is required. Azure portal works as expected. I don't think that's allowed but according to the schema it is because the priority property is not marked as required. I tried to create a NSG security rule without the priorities and it failed with below. Request Body: ``` { "properties": { "securityRules": [ { "name": "rule1", "properties": { "protocol": "*", "sourceAddressPrefix": "*", "destinationAddressPrefix": "*", "access": "Allow", "destinationPortRange": "80", "sourcePortRange": "*", "direction": "Inbound" } } ] }, "location": "eastus" } ``` Response received: ``` { "error": { "code": "SecurityRuleInvalidPriority", "message": "Security rule has invalid Priority. Value provided: 0 Allowed range 100-4096.", "details": [] } } ``` This PR will make the priority parameter as required. * Update NetworkSecurityGroupDelete.json * Update NetworkSecurityGroupRuleDelete.json * Update NetworkSecurityGroupDelete.json * Undo previous change of making fields optional within Exclusion (Azure#23325) * Nivishenker/http headers to insert (Azure#23295) * new app rule property - http header to insert * prettier * add to 22-11-01 * removed changes from 22-09-01 * fixed example * delete RCG example * fix delete examples * added a Location header * prettier fix * Application Gateway WAF Log scrubbing swagger changes (Azure#23022) * Log scrubbing API changes * Update examples * Addressing comments * Fix * Update property in load balancer for Connection Draining Phase 1 (Azure#23082) * Update property in load balancer for Coneection Draining Phase 1 * Fix model validation * Azure Firewall Packet Capture API. Cancelled PR from 2022-09-01 and created for 2022-11-01 (Azure#23114) * moving packet-capture api to 2022-11-01 release from 2022-09-01 * fixing the LRO response header error for model validation * Changes for Additional nic and corrections (Azure#23522) * Changes for Additional nic and corrections * Fixes for tool reported issues * Fix for SpellCheck, ModelValidation * Defining Location in NetworkVirtualApplianceDelete for async * Minor fix * Minor fix * Minor fix * PrettierCheck fixed * Fixing VirtualApplianceAdditionalNicProperties * ModelValidation fixed * Correcting the location header string * Correcting location header * Prettied Check Fix * Fix * Fix * Add inspection limit changes (Azure#23536) * Fixed headers for examples (Azure#23554) * Fix response of API: List of advertised/learned BGP routes (Azure#23555) * fix response type * fix format * fix example, add x-ms-identifiers * AuxiliarySku on Nic (Azure#23552) * Adding auxiliary sku property on nic * Adding AcceleratedConnections to AuxMode * modifying the auxSku values * Removing accidental change --------- Co-authored-by: Prachi Pravin Bhavsar <[email protected]> * migrated latest pr from incorrect branch (Azure#23589) * Changes for NVA connection (Azure#23173) * Changes for NVA connection * Changes to address validation failures * Fix some ModelValidation errors * Fix some ModelValidation errors * Fix some ModelValidation errors * Fix some ModelValidation errors * Fix some ModelValidation errors * Addressing some review comments * Addressing some review comments * Addressing some review comments * Addressing some review comments * Addressing some review comments * Fix camel case for property name * Fixing resourceUri to Camel case in example files * Fix SDK duplication error * Fix one LintDiff error * try fix lintdiff errors * fix lro erro in lintdiff * fix model validation error * Bastion S360 for 2022-11 version (Azure#23595) * Release microsoft.network 2022 11 01 (Azure#23564) * Application Gateway WAF Rate Limit feature swagger changes * Fixing lint errors * Updated rate limit feature examples * rateLimitDuration and rateLimitThreshold are not mandatory. There are only mandatory if ruleType is RateLimitRule. This validation will be done in NRP. * Fix attempt 2. Removed minimum constraint from rateLimitThreshold. Validation will be done in NRP * Remove the minimum number for the option field requestBodyInspectLimitInKB (Azure#23663) * Remove minimum value for optional field requestBodyInspectLimitInKB * Remove exlcusiveMinimum --------- Co-authored-by: htippanaboya <[email protected]> Co-authored-by: tracyMicro <[email protected]> Co-authored-by: tejasshah7 <[email protected]> Co-authored-by: sraghavan-msft <[email protected]> Co-authored-by: navba-MSFT <[email protected]> Co-authored-by: NiviShenker <[email protected]> Co-authored-by: Sindhu Aluguvelli <[email protected]> Co-authored-by: phrazfipho <[email protected]> Co-authored-by: nikhilpadhye1 <[email protected]> Co-authored-by: JainRah <[email protected]> Co-authored-by: karanbazaz <[email protected]> Co-authored-by: yeliMSFT <[email protected]> Co-authored-by: pracsb <[email protected]> Co-authored-by: Prachi Pravin Bhavsar <[email protected]> Co-authored-by: nanditaashok-ms <[email protected]> Co-authored-by: anvrao1 <[email protected]> Co-authored-by: baoqihuang0326 <[email protected]>
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:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.