added 2024-01-01-preview to public repo #27581

jamesfan1 · 2024-01-30T18:51:23Z

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.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

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

Click here to see the details of Step 1

Breaking changes review (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:

The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
You believe there is no need for you to request breaking change approval, for any reason.
Such claims must be reviewed, and the process is the same.

Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

For help with Step 2 / "ARM review", see https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

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 generated using OpenAPI Hub).
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.
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 PR workflow diagram Step 2 (ARM review), 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.

openapi-pipeline-app · 2024-01-30T18:51:27Z

Next Steps to Merge

✅ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

openapi-pipeline-app · 2024-01-30T18:51:28Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 24 Warnings warning [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
swagger.json	2024-01-01-preview(64e821a)	2023-09-01(main)
swagger.json	2024-01-01-preview(64e821a)	2021-05-01-preview(main)

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

Rule	Message
⚠️ 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L1594:15 Old: NGINX.NGINXPLUS/stable/2023-09-01/swagger.json#L1516:15

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

Rule	Message
⚠️ 1008 - ModifiedOperationId	The operation id has been changed from 'Certificates_Create' to 'Certificates_CreateOrUpdate'. This will impact generated code. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L80:7 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L80:7
⚠️ 1008 - ModifiedOperationId	The operation id has been changed from 'Deployments_Create' to 'Deployments_CreateOrUpdate'. This will impact generated code. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L590:7 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L523:7
⚠️ 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L1150:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1028:9
⚠️ 1017 - ReferenceRedirection	The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v5/types.json#L282:11 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1018:11
⚠️ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L264:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1007:9
⚠️ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L269:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1010:9
⚠️ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L274:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1013:9
⚠️ 1029 - ReadonlyPropertyChanged	The read only property has changed from 'false' to 'true'. New: common-types/resource-management/v5/types.json#L279:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1016:9
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'tags' renamed or removed? New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L1009:7 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L861:7
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'tags' renamed or removed? New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L1105:7 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L956:7
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L39:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L39:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L92:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L92:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L160:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L160:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L216:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L216:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L264:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L264:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L312:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L312:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L365:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L365:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L433:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L433:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L553:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L489:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L602:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L535:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L665:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L598:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L722:9 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L655:9
⚠️ 1036 - ConstraintChanged	The new version has a different 'pattern' value than the previous one. New: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json#L1647:5 Old: NGINX.NGINXPLUS/preview/2021-05-01-preview/swagger.json#L1361:5

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️❌Avocado: 18 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Certificates_CreateOrUpdate.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Certificates_Delete.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Certificates_Get.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Certificates_List.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Configurations_Analysis.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Configurations_CreateOrUpdate.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Configurations_Delete.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Configurations_Get.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Configurations_List.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Deployments_Create.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Deployments_Delete.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Deployments_Get.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Deployments_Get_AutoScale.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Deployments_List.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Deployments_ListByResourceGroup.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Deployments_Update.json
`❌` UNREFERENCED_JSON_FILE	The example JSON file is not referenced from the swagger file. readme: specification/nginx/resource-manager/readme.md json: preview/2024-01-01-preview/examples/Operations_List.json
`❌` UNREFERENCED_JSON_FILE	The swagger JSON file is not referenced from the readme file. readme: specification/nginx/resource-manager/readme.md json: NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️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 · 2024-01-30T18:51:28Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

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

️✔️Succeeded [Logs] Generate from 9eaf8a6e99bd40eb064ff614b6c87cfc9bcf5320. 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
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.101 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/nginx/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.Nginx [View full logs] [Preview SDK Changes]
```
warn	Skip artifact folder because it doesn't exist: artifacts/packages
```

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

⚠️Warning [Logs] Generate from 9eaf8a6e99bd40eb064ff614b6c87cfc9bcf5320. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
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
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh]  New minor version of npm available! 10.2.3 -> 10.4.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.4.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-nginx [View full logs] [Preview SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation ConfigurationsOperations.analysis
info	[Changelog]   - Model NginxCertificateProperties has a new parameter certificate_error
info	[Changelog]   - Model NginxCertificateProperties has a new parameter key_vault_secret_created
info	[Changelog]   - Model NginxCertificateProperties has a new parameter key_vault_secret_version
info	[Changelog]   - Model NginxCertificateProperties has a new parameter sha1_thumbprint

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

⚠️Warning [Logs] Generate from 9eaf8a6e99bd40eb064ff614b6c87cfc9bcf5320. 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
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] ent
cmderr	[init.sh]                                  Dload  Upload   Total   Spent    Left  Speed
cmderr	[init.sh] 
  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0-- --:--:--  575k
cmderr	[init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz...
cmderr	[init.sh] Computing checksum with sha256sum
cmderr	[init.sh] Checksums matched!
cmderr	[init.sh]
cmderr	[init.sh] npm notice New major version of npm available! 9.5.0 -> 10.4.0
cmderr	[init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0>
cmderr	[init.sh] npm notice Run `npm install -g npm@10.4.0` to update!
cmderr	[init.sh] npm notice
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-nginx [View full logs] [Preview SDK Changes]

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

️✔️Succeeded [Logs] Generate from 9eaf8a6e99bd40eb064ff614b6c87cfc9bcf5320. 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/nginx/armnginx [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `ResourceProviderDefaultErrorResponse.Error` has been changed from `*ErrorResponseBody` to `*ErrorDetail`
info	[Changelog] - Struct `ErrorResponseBody` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New function `*ConfigurationsClient.Analysis(context.Context, string, string, string, *ConfigurationsClientAnalysisOptions) (ConfigurationsClientAnalysisResponse, error)`
info	[Changelog] - New struct `AnalysisCreate`
info	[Changelog] - New struct `AnalysisCreateConfig`
info	[Changelog] - New struct `AnalysisError`
info	[Changelog] - New struct `AnalysisResult`
info	[Changelog] - New struct `AnalysisResultData`
info	[Changelog] - New struct `CertificateErrorResponseBody`
info	[Changelog] - New struct `ErrorAdditionalInfo`
info	[Changelog] - New struct `ErrorDetail`
info	[Changelog] - New field `CertificateError`, `KeyVaultSecretCreated`, `KeyVaultSecretVersion`, `SHA1Thumbprint` in struct `CertificateProperties`
info	[Changelog]
info	[Changelog] Total 3 breaking change(s), 18 additive change(s).

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

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

azure-arm-nginx-4.0.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation Configurations.analysis
info	[Changelog]   - Added Interface AnalysisCreate
info	[Changelog]   - Added Interface AnalysisCreateConfig
info	[Changelog]   - Added Interface AnalysisError
info	[Changelog]   - Added Interface AnalysisResult
info	[Changelog]   - Added Interface AnalysisResultData
info	[Changelog]   - Added Interface ConfigurationsAnalysisOptionalParams
info	[Changelog]   - Added Interface ErrorAdditionalInfo
info	[Changelog]   - Added Interface ErrorDetail
info	[Changelog]   - Added Interface NginxCertificateErrorResponseBody
info	[Changelog]   - Added Type Alias ConfigurationsAnalysisResponse
info	[Changelog]   - Interface NginxCertificateProperties has a new optional parameter certificateError
info	[Changelog]   - Interface NginxCertificateProperties has a new optional parameter keyVaultSecretCreated
info	[Changelog]   - Interface NginxCertificateProperties has a new optional parameter keyVaultSecretVersion
info	[Changelog]   - Interface NginxCertificateProperties has a new optional parameter sha1Thumbprint
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Type of parameter error of interface ResourceProviderDefaultErrorResponse is changed from ErrorResponseBody to ErrorDetail

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs] Generate from 9eaf8a6e99bd40eb064ff614b6c87cfc9bcf5320. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh]  notice
cmderr	[initScript.sh] npm notice New minor version of npm available! 10.2.3 -> 10.4.0
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.4.0` to update!
cmderr	[initScript.sh] npm notice
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
warn	No file changes detected after generation

️✔️nginx [View full logs]

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 9eaf8a6e99bd40eb064ff614b6c87cfc9bcf5320. 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.nginx.DefaultTag [View full logs] [Preview SDK Changes]
- Az.Nginx.0.1.0.nupkg

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

openapi-pipeline-app · 2024-01-30T18:51:29Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/nginx/armnginx	https://apiview.dev/Assemblies/Review/54b1e1dfd98c4c2cb44c0a03efa8326f?revisionId=1ddd77023cca4a21928a359956a8980c
JavaScript	@azure/arm-nginx	https://apiview.dev/Assemblies/Review/58527f71fd1645209a788a5fd37fb991?revisionId=a30aecb0016f4412bf12443abea84886
Java	azure-resourcemanager-nginx	Create ApiView timeout. Package is too large and we cannot create ApiView for it.

openapi-workflow-bot · 2024-01-30T18:57:30Z

Hi @jamesfan1! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

jamesfan1 · 2024-01-30T20:53:12Z

/azp run

azure-pipelines · 2024-01-30T20:53:30Z

Azure Pipelines successfully started running 4 pipeline(s).

jamesfan1 · 2024-01-30T21:06:46Z

Avocado is failing but the whole folder is unchanged from the private repo. And if I check manually I see the reference is all correct.

mentat9 · 2024-02-07T22:02:35Z

specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json

+        }
+      }
+    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}/analyze": {


analyze

This is a righteous change, but renaming it has the effect of deleting the old API (analysis POST action). Removing the old one requires breaking change review.

thanks @mentat9

@jamesfan1 I believe this might be an issue. The endpoint is actually analysis and I am curious if there was a reason to rename it here?

mentat9 · 2024-02-07T22:02:39Z

specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json

+      ],
+      "x-ms-client-flatten": true,
+      "properties": {
+        "name": {


name

Avoid duplicating names of the top-level resource envelope properties (name, type, id, etc.) within the property bag. Something like "scaleProfileName" would work.

mentat9 · 2024-02-07T22:02:42Z

specification/nginx/resource-manager/NGINX.NGINXPLUS/preview/2024-01-01-preview/swagger.json

+              "items": {
+                "$ref": "#/definitions/ScaleProfile"
+              },
+              "x-ms-identifiers": []


"x-ms-identifiers": []

Looks like the name (or scaleProfileName) property should go here. Will it be unique in this collection?

Hi @mentat9

I am curious to know what you mean by this comment. The ScaleProfile is an array and each element/profile gets a name.

openapi-workflow-bot · 2024-02-07T22:03:13Z

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

jamesfan1 · 2024-02-16T19:30:50Z

@rkmanda the internal azure-rest-api-spec-pr is already reviewed and merged, this PR has no change compare to the internal one

internal PR: https://github.com/Azure/azure-rest-api-specs-pr/pull/16404

Thank you

rkmanda

jamesfan1 · 2024-02-17T20:29:38Z

/pr RequestMerge

jamesfan1 · 2024-02-18T18:07:10Z

/pr RequestMerge

azure-sdk mentioned this pull request Jan 30, 2024

[AutoPR sdk/resourcemanager/nginx/armnginx] added 2024-01-01-preview to public repo azure-sdk/azure-sdk-for-go#8717

Closed

AzureRestAPISpecReview added ARMReview CI-MissingBaseCommit new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 30, 2024

jamesfan1 force-pushed the adding-2024-01-01-preview-for-nginx-public-repo branch from 177257a to ba781bf Compare January 30, 2024 20:34

jamesfan1 removed the CI-MissingBaseCommit label Jan 30, 2024

openapi-pipeline-app bot added CI-MissingBaseCommit and removed CI-MissingBaseCommit labels Jan 30, 2024

mentat9 reviewed Feb 7, 2024

View reviewed changes

mentat9 added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Feb 7, 2024

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 7, 2024

jamesfan1 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 8, 2024

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 8, 2024

tombuildsstuff mentioned this pull request Feb 13, 2024

nginx : Use latest NGINXaaS API (2024-01-01-preview) hashicorp/terraform-provider-azurerm#24868

Merged

jamesfan1 force-pushed the adding-2024-01-01-preview-for-nginx-public-repo branch from d585c23 to d913e31 Compare February 13, 2024 22:16

jamesfan1 force-pushed the adding-2024-01-01-preview-for-nginx-public-repo branch from e40f2fb to b8ffdac Compare February 13, 2024 22:49

azure-sdk mentioned this pull request Feb 13, 2024

[AutoPR nginx/resource-manager] added 2024-01-01-preview to public repo azure-sdk/azure-resource-manager-schemas#4125

Draft

AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Feb 13, 2024

jamesfan1 added 2 commits February 13, 2024 15:07

use 2023-09-01 as base

1cc8818

added 2024-01-01-preview

64e821a

jamesfan1 force-pushed the adding-2024-01-01-preview-for-nginx-public-repo branch from b8ffdac to 64e821a Compare February 13, 2024 23:07

AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Feb 13, 2024

jamesfan1 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 13, 2024

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 13, 2024

jamesfan1 requested a review from rkmanda February 14, 2024 02:35

rkmanda approved these changes Feb 17, 2024

View reviewed changes

rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Feb 17, 2024

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 17, 2024

microsoft-github-policy-service bot added the MergeRequested label Feb 17, 2024

jamesfan1 added the Approved-Avocado label Feb 18, 2024

ms-henglu approved these changes Feb 19, 2024

View reviewed changes

ms-henglu merged commit d1027c6 into Azure:main Feb 19, 2024
31 checks passed

konrad-jamrozik mentioned this pull request Feb 22, 2024

LintDiff (most likely) incorrectly concludes in several cases it should not run its validation Azure/azure-sdk-tools#7730

Open

magodo mentioned this pull request Feb 23, 2024

NGINX@2024-01-01-preview: Add to readme.md #27891

Merged

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added 2024-01-01-preview to public repo #27581

added 2024-01-01-preview to public repo #27581

jamesfan1 commented Jan 30, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2024 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Jan 30, 2024 •

edited

Loading

openapi-workflow-bot bot commented Jan 30, 2024

jamesfan1 commented Jan 30, 2024

azure-pipelines bot commented Jan 30, 2024

jamesfan1 commented Jan 30, 2024

mentat9 Feb 7, 2024

puneetsarna Feb 9, 2024

mentat9 Feb 7, 2024

mentat9 Feb 7, 2024

puneetsarna Feb 9, 2024 •

edited

Loading

openapi-workflow-bot bot commented Feb 7, 2024

jamesfan1 commented Feb 16, 2024 •

edited

Loading

rkmanda left a comment

jamesfan1 commented Feb 17, 2024

jamesfan1 commented Feb 18, 2024

added 2024-01-01-preview to public repo #27581

added 2024-01-01-preview to public repo #27581

Conversation

jamesfan1 commented Jan 30, 2024 • edited Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Breaking changes review (Diagram Step 1)

ARM API changes review (Diagram Step 2)

Diagram footnotes

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Jan 30, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Jan 30, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jan 30, 2024 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Jan 30, 2024 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Jan 30, 2024

jamesfan1 commented Jan 30, 2024

azure-pipelines bot commented Jan 30, 2024

jamesfan1 commented Jan 30, 2024

mentat9 Feb 7, 2024

Choose a reason for hiding this comment

puneetsarna Feb 9, 2024

Choose a reason for hiding this comment

mentat9 Feb 7, 2024

Choose a reason for hiding this comment

mentat9 Feb 7, 2024

Choose a reason for hiding this comment

puneetsarna Feb 9, 2024 • edited Loading

Choose a reason for hiding this comment

openapi-workflow-bot bot commented Feb 7, 2024

jamesfan1 commented Feb 16, 2024 • edited Loading

rkmanda left a comment

Choose a reason for hiding this comment

jamesfan1 commented Feb 17, 2024

jamesfan1 commented Feb 18, 2024

jamesfan1 commented Jan 30, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jan 30, 2024 •

edited

Loading

puneetsarna Feb 9, 2024 •

edited

Loading

jamesfan1 commented Feb 16, 2024 •

edited

Loading