mgmt, imagebuilder, rename java method validate #19248

XiaofeiCao · 2022-05-27T08:42:57Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

https://github.com/Azure/azure-rest-api-specs/blob/main/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2022-02-14/imagebuilder.json#L1210

rename validate to validation to avoid collision with built-in validate method in java.

tested codegen locally

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following appy 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.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-05-27T08:43:00Z

Hi, @XiaofeiCao Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

openapi-pipeline-app · 2022-05-27T08:43:01Z

Swagger Validation Report

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

There are no breaking changes.

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

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- imagebuilder/resource-manager/readme.md tag:default
Linted configuring files (Based on target branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- imagebuilder/resource-manager/readme.md tag:default

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

Validation passed for PoliCheck.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

Validation passes for Lint(RPaaS).

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

openapi-pipeline-app · 2022-05-27T08:43:02Z

Swagger Generation Artifacts

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

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go-track2 - armvirtualmachineimagebuilder - 2.0.0

️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-imagebuilder - 1.0.0
️✔️azure-sdk-for-go - virtualmachineimagebuilder/mgmt/2021-10-01/virtualmachineimagebuilder - v65.0.0
️✔️azure-sdk-for-go - virtualmachineimagebuilder/mgmt/2020-02-14/virtualmachineimagebuilder - v65.0.0
️✔️azure-sdk-for-go - preview/virtualmachineimagebuilder/mgmt/2019-05-01-preview/virtualmachineimagebuilder - v65.0.0
️✔️azure-sdk-for-go - preview/virtualmachineimagebuilder/mgmt/2019-02-01-preview/virtualmachineimagebuilder - v65.0.0
️✔️azure-sdk-for-go - preview/virtualmachineimagebuilder/mgmt/2018-02-01-preview/virtualmachineimagebuilder - v65.0.0
️✔️azure-sdk-for-js - @azure/arm-imagebuilder - 2.0.0

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

⚠️Warning [Logs]Release - Generate from b2de552. 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.
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] npm notice New minor version of npm available! 8.5.5 -> 8.11.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.11.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-imagebuilder [View full logs] [Release SDK Changes]

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model ImageTemplate has a new parameter exact_staging_resource_group
info	[Changelog]   - Model ImageTemplate has a new parameter staging_resource_group
info	[Changelog]   - Model ImageTemplate has a new parameter validate
info	[Changelog]   - Model Resource has a new parameter system_data
info	[Changelog]   - Model RunOutput has a new parameter system_data
info	[Changelog]   - Model TrackedResource has a new parameter system_data

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

⚠️Warning [Logs]Release - Generate from b2de552. 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
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

️✔️azure-resourcemanager-imagebuilder [View full logs] [Release SDK Changes]

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

️✔️Succeeded [Logs]Release - Generate from b2de552. SDK Automation 14.0.0

command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️virtualmachineimagebuilder/mgmt/2021-10-01/virtualmachineimagebuilder [View full logs] [Release SDK Changes]
```
info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
```

️✔️virtualmachineimagebuilder/mgmt/2020-02-14/virtualmachineimagebuilder [View full logs]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️preview/virtualmachineimagebuilder/mgmt/2019-05-01-preview/virtualmachineimagebuilder [View full logs]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️preview/virtualmachineimagebuilder/mgmt/2019-02-01-preview/virtualmachineimagebuilder [View full logs]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️preview/virtualmachineimagebuilder/mgmt/2018-02-01-preview/virtualmachineimagebuilder [View full logs]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

️✔️Succeeded [Logs]Release - Generate from b2de552. 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

️✔️armvirtualmachineimagebuilder [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Struct `SubResource` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `ProvisioningErrorCodeBadStagingResourceGroup`
info	[Changelog] - New const `ProvisioningErrorCodeNoValidatorScript`
info	[Changelog] - New const `RunSubStateValidating`
info	[Changelog] - New const `ProvisioningErrorCodeBadValidatorType`
info	[Changelog] - New const `ProvisioningErrorCodeUnsupportedValidatorType`
info	[Changelog] - New function `ImageTemplatePowerShellValidator.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `ImageTemplatePropertiesValidate.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `*ImageTemplateInVMValidator.GetImageTemplateInVMValidator() *ImageTemplateInVMValidator`
info	[Changelog] - New function `ImageTemplateShellValidator.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `*ImageTemplateShellValidator.UnmarshalJSON([]byte) error`
info	[Changelog] - New function `*ImageTemplatePowerShellValidator.GetImageTemplateInVMValidator() *ImageTemplateInVMValidator`
info	[Changelog] - New function `*ImageTemplatePropertiesValidate.UnmarshalJSON([]byte) error`
info	[Changelog] - New function `*ImageTemplateShellValidator.GetImageTemplateInVMValidator() *ImageTemplateInVMValidator`
info	[Changelog] - New function `*ImageTemplatePowerShellValidator.UnmarshalJSON([]byte) error`
info	[Changelog] - New struct `ImageTemplateInVMValidator`
info	[Changelog] - New struct `ImageTemplatePowerShellValidator`
info	[Changelog] - New struct `ImageTemplatePropertiesValidate`
info	[Changelog] - New struct `ImageTemplateShellValidator`
info	[Changelog] - New struct `ProxyResource`
info	[Changelog] - New field `StagingResourceGroup` in struct `ImageTemplateProperties`
info	[Changelog] - New field `Validate` in struct `ImageTemplateProperties`
info	[Changelog] - New field `ExactStagingResourceGroup` in struct `ImageTemplateProperties`
info	[Changelog] - New field `SystemData` in struct `TrackedResource`
info	[Changelog] - New field `SystemData` in struct `RunOutput`
info	[Changelog] - New field `SystemData` in struct `Resource`
info	[Changelog]
info	[Changelog] Total 2 breaking change(s), 29 additive change(s).

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

⚠️Warning [Logs]Release - Generate from b2de552. 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
cmderr	[automation_init.sh]  deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh]  [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] WARN deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
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 [View full logs] [Release SDK Changes] Breaking Change Detected

azure-arm-imagebuilder-2.0.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface ImageTemplateInVMValidator
info	[Changelog]   - Added Interface ImageTemplatePropertiesValidate
info	[Changelog]   - Added Type Alias ImageTemplateInVMValidatorUnion
info	[Changelog]   - Added Type Alias ImageTemplatePowerShellValidator
info	[Changelog]   - Added Type Alias ImageTemplateShellValidator
info	[Changelog]   - Added Type Alias ProxyResource
info	[Changelog]   - Interface Resource has a new optional parameter systemData
info	[Changelog]   - Add parameters of ProxyResource to TypeAlias RunOutput
info	[Changelog]   - Type Alias ImageTemplate has a new parameter validate
info	[Changelog]   - Type Alias ImageTemplate has a new parameter stagingResourceGroup
info	[Changelog]   - Type Alias ImageTemplate has a new parameter exactStagingResourceGroup
info	[Changelog]   - Enum KnownProvisioningErrorCode has a new value BadStagingResourceGroup
info	[Changelog]   - Enum KnownProvisioningErrorCode has a new value BadValidatorType
info	[Changelog]   - Enum KnownProvisioningErrorCode has a new value NoValidatorScript
info	[Changelog]   - Enum KnownProvisioningErrorCode has a new value UnsupportedValidatorType
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Delete parameters of SubResource in TypeAlias RunOutput
info	[Changelog]   - Type Alias ImageTemplate no longer has parameter systemData

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

⚠️Warning [Logs]Release - Generate from b2de552. 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]  old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
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

️✔️imagebuilder [View full logs]

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

️✔️Succeeded [Logs]Release - Generate from b2de552. 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 [View full logs] [Release SDK Changes]
- Az.ImageBuilder.0.1.0.nupkg

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

XiaofeiCao · 2022-05-27T08:50:32Z

specification/imagebuilder/resource-manager/readme.java.md

+Please also specify `--azure-libraries-for-java-folder=<path to the root directory of your azure-libraries-for-java clone>`.
+
+``` yaml $(java)
+directive:


directive here

specification/imagebuilder/resource-manager/readme.java.md

mgmt, imagebuilder, rename java method validate

becbcbd

openapi-assignment-bot bot assigned honghr May 27, 2022

XiaofeiCao assigned XiaofeiCao and unassigned honghr and XiaofeiCao May 27, 2022

move java specific configurations to readme.java.md

aa2d155

XiaofeiCao commented May 27, 2022

View reviewed changes

XiaofeiCao requested a review from weidongxu-microsoft May 27, 2022 08:50

This was referenced May 27, 2022

[AutoPR azure-resourcemanager-imagebuilder] mgmt, imagebuilder, rename java method validate azure-sdk/azure-sdk-for-java#583

Closed

[AutoPR Az.ImageBuilder] mgmt, imagebuilder, rename java method validate azure-sdk/azure-powershell#858

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go-V2 label May 27, 2022

azure-sdk mentioned this pull request May 27, 2022

[AutoPR @azure/arm-imagebuilder] mgmt, imagebuilder, rename java method validate azure-sdk/azure-sdk-for-js#707

Closed

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label May 27, 2022

weidongxu-microsoft approved these changes May 27, 2022

View reviewed changes

specification/imagebuilder/resource-manager/readme.java.md Outdated Show resolved Hide resolved

remove outdated configs

75eb2ae

weidongxu-microsoft merged commit b2de552 into Azure:main May 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

mgmt, imagebuilder, rename java method validate #19248

mgmt, imagebuilder, rename java method validate #19248

XiaofeiCao commented May 27, 2022 •

edited

Loading

openapi-workflow-bot bot commented May 27, 2022

openapi-pipeline-app bot commented May 27, 2022 •

edited

Loading

openapi-pipeline-app bot commented May 27, 2022 •

edited

Loading

Breaking Changes Tracking

XiaofeiCao May 27, 2022

mgmt, imagebuilder, rename java method validate #19248

mgmt, imagebuilder, rename java method validate #19248

Conversation

XiaofeiCao commented May 27, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 27, 2022

openapi-pipeline-app bot commented May 27, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 27, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

XiaofeiCao May 27, 2022

Choose a reason for hiding this comment

XiaofeiCao commented May 27, 2022 •

edited

Loading

openapi-pipeline-app bot commented May 27, 2022 •

edited

Loading

openapi-pipeline-app bot commented May 27, 2022 •

edited

Loading