Imagebuilder API Release 2024-02-01 #28871

zdelacerda-microsoft · 2024-04-26T18:44:51Z

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

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of 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 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.
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.

Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.

Updated the API version from stable/2023-07-01 to stable/2024-02-01.

openapi-pipeline-app · 2024-04-26T18:44:56Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ The required check named Swagger SpellCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

openapi-pipeline-app · 2024-04-26T18:44:56Z

Swagger Validation Report

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

There are no breaking changes.

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

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

Rule	Message
`❌` Runtime Exception	"new":"https://github.com/Azure/azure-rest-api-specs/blob/a9d65a190f43088ee76033dcf5bdc9baac570432/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2023-07-01/imagebuilder.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.97/common/temp/node_modules/.pnpm/@Azure+oad@0.10.8/node_modules/autorest/dist/app.js" --v2 --input-file=specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-wGNbIk 2: ERROR: Referenced file 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/OperationsList.json' not found 3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json:755:12 ($.paths["/providers/Microsoft.VirtualMachineImages/operations"].get["x-ms-examples"]["Retrieve operations list"]["$ref"]) 4: FATAL: swagger-document/loader - FAILED 5: FATAL: Error: [OperationAbortedException] Error occurred. Exiting. 6: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting."

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

Rule	Message
`❌` Runtime Exception	"new":"https://github.com/Azure/azure-rest-api-specs/blob/a9d65a190f43088ee76033dcf5bdc9baac570432/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/preview/2019-05-01-preview/imagebuilder.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.97/common/temp/node_modules/.pnpm/@Azure+oad@0.10.8/node_modules/autorest/dist/app.js" --v2 --input-file=specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-htq9yl 2: ERROR: Referenced file 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/OperationsList.json' not found 3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json:755:12 ($.paths["/providers/Microsoft.VirtualMachineImages/operations"].get["x-ms-examples"]["Retrieve operations list"]["$ref"]) 4: FATAL: swagger-document/loader - FAILED 5: FATAL: Error: [OperationAbortedException] Error occurred. Exiting. 6: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting."

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

There is no credential detected.

️❌LintDiff: 20 Errors, 0 Warnings failed [Detail]

Compared specs (v2.2.0)	new version	base version
package-2024-02	package-2024-02(a9d65a1)	default(main)

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

Rule	Message	Related RPC [For API reviewers]
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplates.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L70
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplatesByRg.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L112
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateLinux.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L173
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateWindows.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L176
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateTags.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L232
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateToRemoveIdentities.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L235
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetImageTemplate.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L275
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteImageTemplate.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L325
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/RunImageTemplate.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L374
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CancelImageBuild.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L423
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListRunOutputs.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L468
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetRunOutput.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L513
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListTriggers.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L558
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetTrigger.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L603
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateSourceImageTrigger.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L665
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteTrigger.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L718
`❌` invalid-ref	Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/OperationsList.json . Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L754
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L769	RPC-Policy-V1-05, RPC-Put-V1-23
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1655	RPC-Policy-V1-05, RPC-Put-V1-23
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1741	RPC-Policy-V1-05, RPC-Put-V1-23

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` ProvisioningStateMustBeReadOnly	provisioningState property must be set to readOnly. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L151
`❌` ProvisioningStateMustBeReadOnly	provisioningState property must be set to readOnly. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L157
`❌` ProvisioningStateMustBeReadOnly	provisioningState property must be set to readOnly. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L213
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L217
`❌` ProvisioningStateMustBeReadOnly	provisioningState property must be set to readOnly. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L263
`❌` PostResponseCodes	Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L332
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L359
`❌` PostResponseCodes	Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L381
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L408
`❌` ProvisioningStateMustBeReadOnly	provisioningState property must be set to readOnly. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L501
`❌` ProvisioningStateMustBeReadOnly	provisioningState property must be set to readOnly. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L591
`❌` ProvisioningStateMustBeReadOnly	provisioningState property must be set to readOnly. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L643
`❌` ProvisioningStateMustBeReadOnly	provisioningState property must be set to readOnly. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L649
`❌` OperationsApiSchemaUsesCommonTypes	Operations API path must follow the schema provided in the common types. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L740
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L769
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1175
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1193
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1217
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1287
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1593
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1694
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1741
`❌` AvoidAdditionalProperties	Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1780
`❌` XmsParameterLocation	The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L2034
`❌` XmsParameterLocation	The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L2084
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L945
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L950
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1116
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1121
⚠️ LocationMustHaveXmsMutability	Property `location` must have `'x-ms-mutability':['read', 'create']` extension defined. Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1202

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

Rule	Message
`❌` NO_JSON_FILE_FOUND	The JSON file is not found but it is referenced from the readme file. readme: specification/imagebuilder/resource-manager/readme.md json: stable/2024-02-01/examples/OperationsList.json

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

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

️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` unacceptable kind of an object to dump [object Error]	"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/a9d65a190f43088ee76033dcf5bdc9baac570432/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json"

️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` INTERNAL_ERROR	Unexpected internal error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplates.json' Error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplates.json' JsonUrl: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json

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

Validation passed for PoliCheck.

️❌SpellCheck: 2 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` HowToFix	Unknown word (Autorun), please fix the error. See https://aka.ms/ci-fix#spell-check path: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1513:33
`❌` HowToFix	Unknown word (Autorun), please fix the error. See https://aka.ms/ci-fix#spell-check path: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1518:33

️️✔️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-workflow-bot · 2024-04-26T18:44:56Z

Hi @zdelacerda-microsoft, this service has enabled ShiftLeft Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth., please review this pull request if it is intentional or reject it if it is not expected. Normally, all the specification or example changes should start with PR created in ADO.

You can refer to ShiftLeft Toolset Introduction for details.

Please contact service focal contacts or ShiftLeft Toolset Support Channel if need further help.

openapi-pipeline-app · 2024-04-26T18:44:57Z

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]

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

⚠️Warning in generating from 4b606b0. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[automation_init.sh]  notice
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.6.0
cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0>
cmderr	[automation_init.sh] npm notice Run `npm install -g npm@10.6.0` to update!
cmderr	[automation_init.sh] npm notice
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️azure-mgmt-imagebuilder [Preview SDK Changes]

azure-mgmt-imagebuilder-1.0.0b1.zip
azure_mgmt_imagebuilder-1.0.0b1-py3-none-any.whl

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model ImageTemplate has a new parameter auto_run
info	[Changelog]   - Model ImageTemplate has a new parameter managed_resource_tags
info	[Changelog]   - Model ImageTemplateUpdateParametersProperties has a new parameter vm_profile
info	[Changelog]   - Model VirtualNetworkConfig has a new parameter container_instance_subnet_id

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

⚠️Warning in generating from 4b606b0. 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]
cmderr	[init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.6.0
cmderr	[init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0>
cmderr	[init.sh] npm notice Run `npm install -g npm@10.6.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-imagebuilder [Preview SDK Changes]
- pom.xml
- azure-resourcemanager-imagebuilder-1.1.0-beta.1-sources.jar
- azure-resourcemanager-imagebuilder-1.1.0-beta.1.jar

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

️✔️Succeeded in generating from 4b606b0. 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/virtualmachineimagebuilder/armvirtualmachineimagebuilder [Preview SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New enum type `AutoRunState` with values `AutoRunStateAutoRunDisabled`, `AutoRunStateAutoRunEnabled`
info	[Changelog] - New struct `ImageTemplateAutoRun`
info	[Changelog] - New field `AutoRun`, `ManagedResourceTags` in struct `ImageTemplateProperties`
info	[Changelog] - New field `VMProfile` in struct `ImageTemplateUpdateParametersProperties`
info	[Changelog] - New field `ContainerInstanceSubnetID` in struct `VirtualNetworkConfig`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 8 additive change(s).

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

️✔️Succeeded in generating from 4b606b0. 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-imagebuilder [Preview SDK Changes]

azure-arm-imagebuilder-4.1.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface ImageTemplateAutoRun
info	[Changelog]   - Added Type Alias AutoRunState
info	[Changelog]   - Interface ImageTemplate has a new optional parameter autoRun
info	[Changelog]   - Interface ImageTemplate has a new optional parameter managedResourceTags
info	[Changelog]   - Interface ImageTemplateUpdateParametersProperties has a new optional parameter vmProfile
info	[Changelog]   - Interface VirtualNetworkConfig has a new optional parameter containerInstanceSubnetId

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

❌Failed in generating from 4b606b0. 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.5.0 -> 10.6.0
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0>
cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.6.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

❌imagebuilder/resource-manager [Preview Schema Changes]

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

️✔️Succeeded in generating from 4b606b0. 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.imagebuilder.DefaultTag [Preview SDK Changes]
- Az.ImageBuilder.0.1.0.nupkg

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

openapi-pipeline-app · 2024-04-26T18:44:57Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/virtualmachineimagebuilder/armvirtualmachineimagebuilder	https://apiview.dev/Assemblies/Review/dc56d37ef7d547f7a33cffe7654b7e91?revisionId=ddd39fb560b74134b89f870653452dac
Java	azure-resourcemanager-imagebuilder	https://apiview.dev/Assemblies/Review/075dfb2a2d224226aa576cabab0e8aed?revisionId=edc9e5f909374d8ab33302f53deb84e7
JavaScript	@azure/arm-imagebuilder	https://apiview.dev/Assemblies/Review/dd5c7cc9baba4cc4a29571a90633c8f3?revisionId=2ab3989ee2c6459b8558712314affc69
Swagger	Microsoft.VirtualMachineImages	https://apiview.dev/Assemblies/Review/656a31f3eca442078e3a683688592c45?revisionId=e98780fa79304e80955a6e7fc8c57290

zdelacerda-microsoft added 3 commits April 26, 2024 13:26

Copy files from stable/2023-07-01

d973062

Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.

Update version to stable/2024-02-01

7961e3e

Updated the API version from stable/2023-07-01 to stable/2024-02-01.

Added tag for 2024-02-01 in readme file

073ed97

openapi-workflow-bot bot added ShiftLeftViolation DoNotMerge <valid label in PR review process> use to hold merge after approval labels Apr 26, 2024

azure-sdk mentioned this pull request Apr 26, 2024

[AutoPR sdk/resourcemanager/virtualmachineimagebuilder/armvirtualmachineimagebuilder] Imagebuilder API Release 2024-02-01 azure-sdk/azure-sdk-for-go#9720

Draft

AzureRestAPISpecReview added the resource-manager label Apr 26, 2024

zdelacerda-microsoft added 2 commits April 26, 2024 15:07

deleted base 2024 and copying from ado repo

6a636a5

adding 2024-02-01

a9d65a1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Imagebuilder API Release 2024-02-01 #28871

Imagebuilder API Release 2024-02-01 #28871

zdelacerda-microsoft commented Apr 26, 2024

openapi-pipeline-app bot commented Apr 26, 2024 •

edited

openapi-pipeline-app bot commented Apr 26, 2024 •

edited

openapi-workflow-bot bot commented Apr 26, 2024

openapi-pipeline-app bot commented Apr 26, 2024 •

edited

openapi-pipeline-app bot commented Apr 26, 2024 •

edited

Imagebuilder API Release 2024-02-01 #28871

Are you sure you want to change the base?

Imagebuilder API Release 2024-02-01 #28871

Conversation

zdelacerda-microsoft commented Apr 26, 2024

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Diagram footnotes

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Apr 26, 2024 • edited

Next Steps to Merge

openapi-pipeline-app bot commented Apr 26, 2024 • edited

Swagger Validation Report

openapi-workflow-bot bot commented Apr 26, 2024

openapi-pipeline-app bot commented Apr 26, 2024 • edited

Swagger Generation Artifacts

openapi-pipeline-app bot commented Apr 26, 2024 • edited

Generated ApiView

openapi-pipeline-app bot commented Apr 26, 2024 •

edited

openapi-pipeline-app bot commented Apr 26, 2024 •

edited

openapi-pipeline-app bot commented Apr 26, 2024 •

edited

openapi-pipeline-app bot commented Apr 26, 2024 •

edited