azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

[Hub Generated] Publish private branch 'release-alertsmanagement-Microsoft.AlertsManagement-2021-07-22-preview'

Open moshemal opened this issue 2 years ago • 9 comments

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

ARM API Information (Control Plane)

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):

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

ARM API Review Checklist

Applicability: :warning:

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.

moshemal avatar Oct 27 '22 07:10 moshemal

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/8591

moshemal avatar Oct 27 '22 07:10 moshemal

Hi, @moshemal 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]

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️❌LintDiff: 2 Errors, 1 Warnings failed [Detail] [must fix]The following errors/warnings are introduced by current PR:
    Rule Message Related RPC [For API reviewers]
    AutoRest exception "location":"specification/alertsmanagement/resource-manager/readme.md",
    "tag":"package-2021-08",
    "details":"swagger-document/compose - FAILED"
    AutoRest exception "location":"specification/alertsmanagement/resource-manager/readme.md",
    "tag":"package-2021-08",
    "details":"Error: '$.definitions.Resource.description' has incompatible values (---An azure resource object,
    --->- Common fields that are returned in the response for all Azure Resource Manager resources)."
    :warning: R4024 - PreviewVersionOverOneYear The API version:2021-07-22-preview having been in a preview state over one year , please move it to GA or retire.
    Location: Microsoft.AlertsManagement/preview/2021-07-22-preview/PrometheusRuleGroups.json#L4
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    :warning: MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/alertsmanagement/resource-manager/readme.md
    tag: specification/alertsmanagement/resource-manager/readme.md#tag-package-2021-08
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

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

    ️️✔️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.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/alertsmanagement/armalertsmanagement - 0.8.0
    +	Type of `ErrorResponseAutoGenerated.Error` has been changed from `*ErrorResponseBodyAutoGenerated` to `*ErrorDetail`
    +	Type of `ErrorResponseAutoGenerated2.Error` has been changed from `*ErrorResponseBodyAutoGenerated2` to `*ErrorResponseBodyAutoGenerated`
    azure-sdk-for-python-track2 - track2_azure-mgmt-alertsmanagement - 2.0.0b1
    +	Model PatchObject no longer has parameter status
    +	Operation AlertsOperations.change_state has a new parameter comment
    +	Removed operation group ActionRulesOperations
    +	Removed operation group SmartDetectorAlertRulesOperations
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from bf08c369abaf0ec65353690bf73a5e6a2d086908. 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
      warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
      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] [91mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:611
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m 611 | [0m         [96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m     | [91m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91m[96m     | [91mFailed to generate sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91mGet-ChildItem: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:698
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m 698 | [0m … rtifacts += [96mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m     | [91m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91m[96m     | [91mCannot find path
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m     | [91m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because it does not exist.
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:611
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m 611 | [0m         [96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [96m     | [91m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [91m[96m     | [91mFailed to generate sdk artifact
      cmderr	[Invoke-GenerateAndBuildV2.ps1] [0m
    • Azure.ResourceManager.AlertsManagement [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bf08c369abaf0ec65353690bf73a5e6a2d086908. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New patch version of npm available! 8.19.2 -> 8.19.3
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.3>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-alertsmanagement [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group AlertProcessingRulesOperations
      info	[Changelog]   - Added operation group PrometheusRuleGroupsOperations
      info	[Changelog]   - Model Condition has a new parameter field
      info	[Changelog]   - Model Essentials has a new parameter action_status
      info	[Changelog]   - Model Essentials has a new parameter description
      info	[Changelog]   - Model Operation has a new parameter origin
      info	[Changelog]   - Model PatchObject has a new parameter enabled
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model PatchObject no longer has parameter status
      info	[Changelog]   - Operation AlertsOperations.change_state has a new parameter comment
      info	[Changelog]   - Removed operation group ActionRulesOperations
      info	[Changelog]   - Removed operation group SmartDetectorAlertRulesOperations
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from bf08c369abaf0ec65353690bf73a5e6a2d086908. 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/alertsmanagement/armalertsmanagement [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `ErrorResponseAutoGenerated2.Error` has been changed from `*ErrorResponseBodyAutoGenerated2` to `*ErrorResponseBodyAutoGenerated`
      info	[Changelog] - Type of `AlertsClientChangeStateOptions.Comment` has been changed from `*string` to `*Comments`
      info	[Changelog] - Type of `ErrorResponseAutoGenerated.Error` has been changed from `*ErrorResponseBodyAutoGenerated` to `*ErrorDetail`
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `*PrometheusRuleGroupsClient.Get(context.Context, string, string, *PrometheusRuleGroupsClientGetOptions) (PrometheusRuleGroupsClientGetResponse, error)`
      info	[Changelog] - New function `*PrometheusRuleGroupsClient.NewListBySubscriptionPager(*PrometheusRuleGroupsClientListBySubscriptionOptions) *runtime.Pager[PrometheusRuleGroupsClientListBySubscriptionResponse]`
      info	[Changelog] - New function `*PrometheusRuleGroupsClient.NewListByResourceGroupPager(string, *PrometheusRuleGroupsClientListByResourceGroupOptions) *runtime.Pager[PrometheusRuleGroupsClientListByResourceGroupResponse]`
      info	[Changelog] - New function `*PrometheusRuleGroupsClient.CreateOrUpdate(context.Context, string, string, PrometheusRuleGroupResource, *PrometheusRuleGroupsClientCreateOrUpdateOptions) (PrometheusRuleGroupsClientCreateOrUpdateResponse, error)`
      info	[Changelog] - New function `*PrometheusRuleGroupsClient.Update(context.Context, string, string, PrometheusRuleGroupResourcePatch, *PrometheusRuleGroupsClientUpdateOptions) (PrometheusRuleGroupsClientUpdateResponse, error)`
      info	[Changelog] - New function `NewPrometheusRuleGroupsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*PrometheusRuleGroupsClient, error)`
      info	[Changelog] - New function `*PrometheusRuleGroupsClient.Delete(context.Context, string, string, *PrometheusRuleGroupsClientDeleteOptions) (PrometheusRuleGroupsClientDeleteResponse, error)`
      info	[Changelog] - New struct `Comments`
      info	[Changelog] - New struct `ErrorAdditionalInfo`
      info	[Changelog] - New struct `ErrorDetail`
      info	[Changelog] - New struct `ErrorResponseAutoGenerated3`
      info	[Changelog] - New struct `PrometheusRule`
      info	[Changelog] - New struct `PrometheusRuleGroupAction`
      info	[Changelog] - New struct `PrometheusRuleGroupProperties`
      info	[Changelog] - New struct `PrometheusRuleGroupResource`
      info	[Changelog] - New struct `PrometheusRuleGroupResourceCollection`
      info	[Changelog] - New struct `PrometheusRuleGroupResourcePatch`
      info	[Changelog] - New struct `PrometheusRuleGroupResourcePatchProperties`
      info	[Changelog] - New struct `PrometheusRuleGroupsClient`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientCreateOrUpdateOptions`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientCreateOrUpdateResponse`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientDeleteOptions`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientDeleteResponse`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientGetOptions`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientGetResponse`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientListByResourceGroupOptions`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientListByResourceGroupResponse`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientListBySubscriptionOptions`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientListBySubscriptionResponse`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientUpdateOptions`
      info	[Changelog] - New struct `PrometheusRuleGroupsClientUpdateResponse`
      info	[Changelog] - New struct `PrometheusRuleResolveConfiguration`
      info	[Changelog] - New struct `ResourceAutoGenerated`
      info	[Changelog] - New struct `TrackedResource`
      info	[Changelog]
      info	[Changelog] Total 3 breaking change(s), 61 additive change(s).
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bf08c369abaf0ec65353690bf73a5e6a2d086908. 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]
      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
    • ️✔️alertsmanagement [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs]Release - Generate from bf08c369abaf0ec65353690bf73a5e6a2d086908. 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.alertsmanagement [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/alertsmanagement/armalertsmanagement Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Python track2_azure-mgmt-alertsmanagement Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @raych1 This PR was approved in the private repo

    moshemal avatar Oct 27 '22 07:10 moshemal

    Hi @moshemal, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    Hi, can you mark the change log properly, so we know how to review the PR? Also please take a look at your pipeline error. When it's ready to be reviewed by ARM, please add back WaitForARMFeedback label. Thanks.

    zizw123 avatar Oct 27 '22 17:10 zizw123

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    Hi, can you mark the change log properly, so we know how to review the PR? Also please take a look at your pipeline error. When it's ready to be reviewed by ARM, please add back WaitForARMFeedback label. Thanks.

    @zizw123 The private repo original PR had a long review process and was approved: https://github.com/Azure/azure-rest-api-specs-pr/pull/8591

    Please merge.

    moshemal avatar Oct 27 '22 23:10 moshemal

    @moshemal , please fix model validation failures.

    @jianyexi , can you confirm on the lintDiff errors in this PR? I saw the previous PR in private repo has approved-lintDiff label.

    raych1 avatar Oct 31 '22 00:10 raych1

    /azp run unifiedPipeline

    moshemal avatar Nov 02 '22 08:11 moshemal

    No pipelines are associated with this pull request.

    azure-pipelines[bot] avatar Nov 02 '22 08:11 azure-pipelines[bot]

    Hi, can you mark the change log properly, so we know how to review the PR? Also please take a look at your pipeline error. When it's ready to be reviewed by ARM, please add back WaitForARMFeedback label. Thanks.

    @zizw123 The private repo original PR had a long review process and was approved: Azure/azure-rest-api-specs-pr#8591

    Please merge.

    This PR was approved by ARM in private repo review process and no extra review need.

    raych1 avatar Nov 07 '22 09:11 raych1