[Hub Generated] Review request for Microsoft.Insights to add version preview/2023-05-01-preview

[gulopesd]

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

• Link to API Spec engagement record issue:

Is this review for (select one):

• a private preview
• a public preview
• GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

• Design Document:
• Previous API Spec Doc:
• Updated paths:

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

• 💬 Teams Channel
• 💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting
• Open API Hub

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Azure DevTools Wiki

[openapi-workflow-bot]

Hi, @gulopesd 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 succeeded [Detail] [Expand]

There are no breaking changes.

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

compared swaggers (via Oad v0.10.4)]	new version	base version
metricBatch.json	2023-05-01-preview(03d7e01)	2023-03-01-preview(main)

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

Rule	Message
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'TimespanParameter' removed or renamed? New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L120:3 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L99:3
⚠️ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L250:7 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L221:7
⚠️ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L254:11 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L225:11
⚠️ 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'timespan' renamed or removed? New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L300:13 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L264:13
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'starttime' that was not found in the old version. New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L300:13 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L264:13
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'endtime' that was not found in the old version. New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L300:13 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L264:13
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'starttime, endtime' that was not found in the old version. New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L298:11 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L262:11
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'code, message' that was not found in the old version. New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L251:9 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L222:9
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'error' that was not found in the old version. New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L107:13 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L86:13
⚠️ 1034 - AddedRequiredProperty	The new version has new required property 'error' that was not found in the old version. New: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L247:5 Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L218:5
⚠️ 1046 - RemovedOptionalParameter	The optional parameter 'timespan' was removed in the new version. Old: Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json#L36:9

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.1)	new version	base version
package-preview-2023-05	package-preview-2023-05(03d7e01)	default(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L48
⚠️ PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json#L55

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

Validation passes for Avocado.

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

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

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

️️✔️CadlAPIView 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.

️️✔️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).

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

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️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-net-track2 inProgress [Detail]

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

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.Insights	https://apiview.dev/Assemblies/Review/cf50767cfb5744259afc8573a4e06cd5

[mikekistler]

Looks good. 👍

I left a few comments on minor issues flagged by the Spectral linter.

[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-net-track2 failed [Detail]

• ❌Failed [Logs]Release - Generate from 5948af5. 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	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:712
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 712 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:712
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 712 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to packe sdk. exit code: False
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:800
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 800 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:712
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 712 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
  cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

• ❌Azure.Monitor.Ingestion [View full logs]  [Release SDK Changes] Breaking Change Detected

  info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.Monitor.Ingestion.LogsUploadFailedEventArgs' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/monitor/Azure.Monitor.Ingestion/src/Azure.Monitor.Ingestion.csproj::TargetFramework=netstandard2.0],
  info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.Monitor.Ingestion.LogsUploadOptions' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/monitor/Azure.Monitor.Ingestion/src/Azure.Monitor.Ingestion.csproj::TargetFramework=netstandard2.0],
  info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Microsoft.Extensions.Azure.IngestionClientBuilderExtensions' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/monitor/Azure.Monitor.Ingestion/src/Azure.Monitor.Ingestion.csproj::TargetFramework=netstandard2.0],
  info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.Monitor.Ingestion/Debug/netstandard2.0/Azure.Monitor.Ingestion.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/monitor/Azure.Monitor.Ingestion/src/Azure.Monitor.Ingestion.csproj::TargetFramework=netstandard2.0]

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