Update ARM Common type versions for branch release-app-Microsoft.App-…

[anandanthony]

…2022-11-01-preview

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

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

1. 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
2. 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.
3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

• 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 apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

  • Adding a new service
  • Adding new API(s)
  • Adding a new API version
    -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.

• Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

• If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

[openapi-workflow-bot]

Hi, @anandanthony 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. vscswagger@microsoft.com

[openapi-pipeline-app]

Swagger Validation Report

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

compared swaggers (via Oad v0.10.2)]	new version	base version
types.json	3.0(64dd986)	3.0(main)
customermanagedkeys.json	4.0(64dd986)	4.0(main)
types.json	4.0(64dd986)	4.0(main)
managedidentity.json	5.0(64dd986)	5.0(main)

Rule

Message

❌ Runtime Exception

"new":"https://github.com/Azure/azure-rest-api-specs/blob/64dd986564cbdff8bc674c03dae24a8d761d74ef/specification/common-types/resource-management/v4/privatelinks.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/common-types/resource-management/v4/privatelinks.json", "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.46/common/temp/node_modules/.pnpm/@Azure+oad@0.10.2/node_modules/autorest/dist/app.js --v2 --input-file=/mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/common-types/resource-management/v4/privatelinks.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nFATAL: swagger-document/loader - FAILED\nFATAL: Error: Error retrieving '$.definitions.Resource' (Error: Trying to retrieve 'Resource' from mapping that contains no such key)\n Error: Error retrieving '$.definitions.Resource' (Error: Trying to retrieve 'Resource' from mapping that contains no such key)\n"

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

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

Validation passes for LintDiff.

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

Validation passes for Avocado.

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

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

[openapi-pipeline-app]

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-js - @azure/arm-appcontainers - 2.0.0-beta.3

+	Interface ContainerAppsRevisionsListRevisionsNextOptionalParams no longer has parameter filter
+	Type of parameter customDomainVerificationFailureInfo of interface CustomHostnameAnalysisResult is changed from DefaultErrorResponse to CustomHostnameAnalysisResultCustomDomainVerificationFailureInfo
+	Type of parameter value of interface DaprSecretsCollection is changed from Secret[] to DaprSecret[]

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

[openapi-pipeline-app]

Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

[openapi-workflow-bot]

Hi @anandanthony, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

[openapi-workflow-bot]

Hi, @anandanthony, 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. Or you could onboard API spec pipeline

[TimLovellSmith]

@anandanthony Hi, updating common-types is kind of a big deal, could you please give us a fuller explanation of the changes?

[anandanthony]

@anandanthony Hi, updating common-types is kind of a big deal, could you please give us a fuller explanation of the changes?

@TimLovellSmith the change is here is aimed to include the new/updated versions in "../common-types/resource-management/" to the "release-app-Microsoft.App-2022-11-01-preview" branch. This recommendation came up in another PR - #21916. In case this is not mandatory we can use the current available versions since we are using the same for other resource types.

[TimLovellSmith]

@anandanthony It looks like you've authored some new commits to do the updates, instead of just merging the branches? If you are just trying to 'snap to the latest' common types definitions, and not actually change them, maybe you could replace this PR with another that is obviously just a merge commit from 'master' branch to your target branch, Azure:release-app-Microsoft.App-2022-11-01-preview?

[TimLovellSmith]

@anandanthony... or it might even be preferable just to rebase your working branch on latest azure-rest-api-specs master.

[trajkobal]

@TimLovellSmith, I heard from @vinisoto that @ruslany is planning to merge this branch to main soon. Like you said merging to main is a big deal. So, what @anandanthony is trying to do here is to get what is needed (common types, identities etc from latter versions ) to resolve one other PR, merge it to this version branch and get it all merged when @ruslany merges this branch to main. It is ARM signed off. The hold up there is main had braking SDK changes