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

Mipatera batch 2022 10 01 control

Open paterasMSFT opened this issue 3 years ago • 7 comments

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
    • [x] 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? November 2022
  3. When do you expect to publish the swagger? ASAP

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:

  • [x] 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.

paterasMSFT avatar Oct 14 '22 21:10 paterasMSFT

Hi, @paterasMSFT 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-workflow-bot[bot] avatar Oct 14 '22 21:10 openapi-workflow-bot[bot]

    Hi, @paterasMSFT your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    openapi-workflow-bot[bot] avatar Oct 14 '22 21:10 openapi-workflow-bot[bot]

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 3 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.7)] new version base version
    BatchManagement.json 2022-10-01(349f789) 2022-06-01(main)

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

    Rule Message
    ❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L2567:9
    Old: Microsoft.Batch/stable/2022-06-01/BatchManagement.json#L2556:9
    ❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L2739:9
    Old: Microsoft.Batch/stable/2022-06-01/BatchManagement.json#L2736:9
    ❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L2567:9
    Old: Microsoft.Batch/stable/2022-06-01/BatchManagement.json#L2556:9
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-10 package-2022-10(349f789) default(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    :warning: R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'applications' with immediate parent 'BatchAccount', must have a list by immediate parent operation.
    Location: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L3175
    :warning: R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'versions' with immediate parent 'Application', must have a list by immediate parent operation.
    Location: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L3209
    :warning: R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'certificates' with immediate parent 'BatchAccount', must have a list by immediate parent operation.
    Location: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L3672
    :warning: R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'detectors' with immediate parent 'BatchAccount', must have a list by immediate parent operation.
    Location: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L3770
    :warning: R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateLinkResources' with immediate parent 'BatchAccount', must have a list by immediate parent operation.
    Location: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L3796
    :warning: R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'privateEndpointConnections' with immediate parent 'BatchAccount', must have a list by immediate parent operation.
    Location: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L3840
    :warning: R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'pools' with immediate parent 'BatchAccount', must have a list by immediate parent operation.
    Location: Microsoft.Batch/stable/2022-10-01/BatchManagement.json#L3989
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ API Readiness check failed. Please make sure your service is deployed. "code: InvalidResourceType,
    message: The resource type 'operations' could not be found in the namespace 'Microsoft.Batch' for api version '2022-10-01'. The supported api-versions are '2015-09-01,
    2015-12-01,
    2017-01-01,
    2017-05-01,
    2017-09-01,
    2018-12-01,
    2019-04-01,
    2019-08-01,
    2020-03-01,
    2020-03-01-preview,
    2020-05-01,
    2020-09-01,
    2021-01-01,
    2021-06-01,
    2022-01-01,
    2022-06-01'."
    ️⚠️~[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.
    ️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/349f78978d4dafc18ccb112e493f8bd9884be3b8/specification/batch/resource-manager/readme.md#tag-package-2022-10">batch/resource-manager/readme.md#package-2022-10
    The following errors/warnings are introduced by current PR:
    Rule Message
    :warning: UnkownSecurityScheme "readme":"batch/resource-manager/readme.md",
    "tag":"package-2022-10",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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?

    openapi-pipeline-app[bot] avatar Oct 14 '22 21:10 openapi-pipeline-app[bot]

    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/batch/armbatch - 2.0.0
    +	Struct `CloudErrorBody` has been removed
+	Struct `CloudError` has been removed


    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 1c32ff067732c0b7d4acfefb971f8e9eb25a5787. 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
    • ️✔️Azure.ResourceManager.Batch [View full logs]  [Preview SDK Changes] 
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 1c32ff067732c0b7d4acfefb971f8e9eb25a5787. 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]  notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.15.0 -> 8.19.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-batch [View full logs]  [Preview SDK Changes] 
      info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model Pool has a new parameter current_node_communication_mode
info	[Changelog]   - Model Pool has a new parameter target_node_communication_mode
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 1c32ff067732c0b7d4acfefb971f8e9eb25a5787. 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] [ForkJoinPool-1-worker-3] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
    • ️✔️azure-resourcemanager-batch [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 1c32ff067732c0b7d4acfefb971f8e9eb25a5787. 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/batch/armbatch [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Struct `CloudError` has been removed
info	[Changelog] - Struct `CloudErrorBody` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `PrivateEndpointConnectionProvisioningStateDeleting`
info	[Changelog] - New const `NodeCommunicationModeDefault`
info	[Changelog] - New const `PrivateEndpointConnectionProvisioningStateCreating`
info	[Changelog] - New const `NodeCommunicationModeClassic`
info	[Changelog] - New const `PrivateEndpointConnectionProvisioningStateCancelled`
info	[Changelog] - New const `NodeCommunicationModeSimplified`
info	[Changelog] - New const `EndpointAccessDefaultActionAllow`
info	[Changelog] - New const `EndpointAccessDefaultActionDeny`
info	[Changelog] - New type alias `NodeCommunicationMode`
info	[Changelog] - New type alias `EndpointAccessDefaultAction`
info	[Changelog] - New function `PossibleEndpointAccessDefaultActionValues() []EndpointAccessDefaultAction`
info	[Changelog] - New function `*PrivateEndpointConnectionClient.BeginDelete(context.Context, string, string, string, *PrivateEndpointConnectionClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionClientDeleteResponse], error)`
info	[Changelog] - New function `PossibleNodeCommunicationModeValues() []NodeCommunicationMode`
info	[Changelog] - New struct `EndpointAccessProfile`
info	[Changelog] - New struct `IPRule`
info	[Changelog] - New struct `NetworkProfile`
info	[Changelog] - New struct `PrivateEndpointConnectionClientBeginDeleteOptions`
info	[Changelog] - New struct `PrivateEndpointConnectionClientDeleteResponse`
info	[Changelog] - New field `NetworkProfile` in struct `AccountProperties`
info	[Changelog] - New field `NodeManagementEndpoint` in struct `AccountProperties`
info	[Changelog] - New field `NetworkProfile` in struct `AccountCreateProperties`
info	[Changelog] - New field `NetworkProfile` in struct `AccountUpdateProperties`
info	[Changelog] - New field `PublicNetworkAccess` in struct `AccountUpdateProperties`
info	[Changelog] - New field `TargetNodeCommunicationMode` in struct `PoolProperties`
info	[Changelog] - New field `CurrentNodeCommunicationMode` in struct `PoolProperties`
info	[Changelog] - New field `GroupIDs` in struct `PrivateEndpointConnectionProperties`
info	[Changelog]
info	[Changelog] Total 4 breaking change(s), 28 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 1c32ff067732c0b7d4acfefb971f8e9eb25a5787. 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-batch [View full logs]  [Preview SDK Changes] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Type Alias NodeCommunicationMode
info	[Changelog]   - Interface Pool has a new optional parameter currentNodeCommunicationMode
info	[Changelog]   - Interface Pool has a new optional parameter targetNodeCommunicationMode
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 1c32ff067732c0b7d4acfefb971f8e9eb25a5787. 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] WARN 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
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 1c32ff067732c0b7d4acfefb971f8e9eb25a5787. 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.Batch [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    openapi-pipeline-app[bot] avatar Oct 14 '22 21:10 openapi-pipeline-app[bot]

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/batch/armbatch https://apiview.dev/Assemblies/Review/3613e03052f442378045ed7fcff1db0a
    Python track2_azure-mgmt-batch https://apiview.dev/Assemblies/Review/ff82985a55c641e7a37b5add263961ca
    Java azure-resourcemanager-batch https://apiview.dev/Assemblies/Review/9b71cac8105b4c8aa3b299d6b9ce0c89
    .Net Azure.ResourceManager.Batch https://apiview.dev/Assemblies/Review/fd9fa4d73840440798af1e935488eb5c
    JavaScript @azure/arm-batch https://apiview.dev/Assemblies/Review/cd9580bfd9034a5981994b63ee62eba4

    openapi-pipeline-app[bot] avatar Oct 14 '22 21:10 openapi-pipeline-app[bot]

    Hi @paterasMSFT, 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[bot] avatar Oct 14 '22 21:10 openapi-workflow-bot[bot]

    @paterasMSFT - This PR is marked for ARM review but is draft and hasn't had activity for quite a while. If/when you are ready for ARM review, set it Open. If you no longer need this PR, please close it.

    mentat9 avatar Jan 05 '23 03:01 mentat9

    @paterasMSFT Hi Pateras, this PR has been stuck in draft status with no activity for a long time. I'm going to go ahead and close it. Please reopen it if you still need it.

    TimLovellSmith avatar Mar 13 '23 16:03 TimLovellSmith