NginxExtension - update docs to show standardv3 plans in examples#9534
Conversation
️✔️Azure CLI Extensions Breaking Change Test
|
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
|
There was a problem hiding this comment.
Pull request overview
This PR claims to update NGINX extension documentation to show the new "standardv3" marketplace SKU in examples. However, the actual code changes do not align with this stated purpose.
Changes:
- Version bump from 2.0.0b9 to 2.0.0b10
- Removal of
--enable-diagnostics trueflag from a test command - Update of API key expiration date in test from November 2025 to February 2026
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/nginx/setup.py | Version incremented to 2.0.0b10 |
| src/nginx/HISTORY.rst | Added release notes claiming SKU documentation updates |
| src/nginx/azext_nginx/tests/latest/test_nginx_scenario.py | Removed diagnostics flag and updated test API key expiration date |
|
|
||
| 2.0.0b10 | ||
| ++++++ | ||
| * Updated Nginx Deployment documentation to show new marketplace SKU in examples. |
There was a problem hiding this comment.
The release notes claim to have "Updated Nginx Deployment documentation to show new marketplace SKU in examples," but the actual changes in this PR are:
- Removal of the
--enable-diagnostics trueflag from a test command - Update of an API key expiration date in a test
No documentation files containing SKU examples (such as files in the aaz directory) have been updated, and there are no references to "standardv3" anywhere in the codebase. The release notes should accurately describe the actual changes made in this PR.
| * Updated Nginx Deployment documentation to show new marketplace SKU in examples. | |
| * Removed the ``--enable-diagnostics true`` flag from a test command. | |
| * Updated the API key expiration date in a test. |
| }) | ||
| self.kwargs['identities'] = "{\"type\":\"UserAssigned\",\"userAssignedIdentities\":{\"" + managed_identity['id'] + "\":{}}}" | ||
| self.cmd('nginx deployment create --name {deployment_name} --resource-group {rg} --location {location} --sku name={sku} --enable-diagnostics true --network-profile front-end-ip-configuration="{public_ip_addresses}" network-interface-configuration="{subnet_id}" --identity {identities} --scaling-properties capacity=10 --auto-upgrade-profile upgrade-channel=preview', checks=[ | ||
| self.cmd('nginx deployment create --name {deployment_name} --resource-group {rg} --location {location} --sku name={sku} --network-profile front-end-ip-configuration="{public_ip_addresses}" network-interface-configuration="{subnet_id}" --identity {identities} --scaling-properties capacity=10 --auto-upgrade-profile upgrade-channel=preview', checks=[ |
There was a problem hiding this comment.
The removal of the --enable-diagnostics true flag from this test command appears to be intentional but is not documented in the HISTORY.rst file. This change should either be explained in the release notes or reverted if it was unintentional.
| self.cmd('nginx deployment create --name {deployment_name} --resource-group {rg} --location {location} --sku name={sku} --network-profile front-end-ip-configuration="{public_ip_addresses}" network-interface-configuration="{subnet_id}" --identity {identities} --scaling-properties capacity=10 --auto-upgrade-profile upgrade-channel=preview', checks=[ | |
| self.cmd('nginx deployment create --name {deployment_name} --resource-group {rg} --location {location} --sku name={sku} --network-profile front-end-ip-configuration="{public_ip_addresses}" network-interface-configuration="{subnet_id}" --identity {identities} --scaling-properties capacity=10 --auto-upgrade-profile upgrade-channel=preview --enable-diagnostics true', checks=[ |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
| options=["--root-file"], | ||
| arg_group="Properties", | ||
| help="The root file of the Nginx Configuration", | ||
| help="The root file of the Nginx Configuration", |
|
|
||
| :example: Deployment Create with PublicIP | ||
| az nginx deployment create --name myDeployment --resource-group myResourceGroup --location eastus2 --sku name="standard_Monthly_gmz7xq9ge3py" --network-profile front-end-ip-configuration="{public-ip-addresses:[{id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIP}]}" network-interface-configuration="{subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet}" | ||
| az nginx deployment create --name myDeployment --resource-group myResourceGroup --location eastus2 --sku name="standardv3_Monthly_gmz7xq9ge3py" --network-profile front-end-ip-configuration="{public-ip-addresses:[{id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/publicIPAddresses/myPublicIP}]}" network-interface-configuration="{subnet-id:/subscriptions/mySubscription/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet}" |
There was a problem hiding this comment.
as the generated codes been modified, better to provide the link of pr in Azure/aaz.
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 2 pipeline(s). |
|
[Release] Update index.json for extension [ nginx-2.0.0b10 ] : https://dev.azure.com/msazure/One/_build/results?buildId=150736894&view=results |
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.