azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
batch: the storageAccountId field is no longer required
This needs to be Optional so that it can be null during an Update to remove this value
The current Azure SDK outputs this as *string rather than string which is a bug in the SDK Generator: https://github.com/Azure/azure-sdk-for-go/blob/297f2c8b6d448f01b09fbc5c7fad393922c9ccda/services/batch/mgmt/2022-01-01/batch/models.go#L872
However since this needs to be null we should make this Optional
Hi, @tombuildsstuff Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| BatchManagement.json | 2022-01-01(d8b02ea) | 2022-01-01(main) |
| Rule | Message |
|---|---|
|
The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.Batch/stable/2022-01-01/BatchManagement.json#L2497:7 Old: Microsoft.Batch/stable/2022-01-01/BatchManagement.json#L2497:7 |
|
The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.Batch/stable/2022-01-01/BatchManagement.json#L2685:7 Old: Microsoft.Batch/stable/2022-01-01/BatchManagement.json#L2688:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️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-01 | package-2022-01(d8b02ea) | package-2022-01(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Missing identifier registryServers in array item property Location: Microsoft.Batch/stable/2022-01-01/BatchManagement.json#L4516 |
| :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-01-01/BatchManagement.json#L3091 |
| :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-01-01/BatchManagement.json#L3125 |
| :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-01-01/BatchManagement.json#L3500 |
| :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-01-01/BatchManagement.json#L3599 |
| :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-01-01/BatchManagement.json#L3625 |
| :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-01-01/BatchManagement.json#L3669 |
| :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-01-01/BatchManagement.json#L3793 |
️️✔️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.
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.Batch/stable/2022-01-01/BatchManagement.json#L198:22 ExampleUrl: stable/2022-01-01/examples/BatchAccountDelete.json |
|
Respond to the initial request of a long running operation, Patch/Post call must return 201 or 202, Delete call must return 202 or 204, Put call must return 202 or 201 or 200, but 204 being returned Url: Microsoft.Batch/stable/2022-01-01/BatchManagement.json#L1953:22 ExampleUrl: stable/2022-01-01/examples/PrivateEndpointConnectionUpdate.json |
️️✔️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.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
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- Type of `ContainerConfiguration.Type` has been changed from `*string` to `*ContainerType` + Field `ActionRequired` of struct `PrivateLinkServiceConnectionState` has been removed + Field `DynamicVNetAssignmentScope` of struct `NetworkConfiguration` has been removed + Field `Username` of struct `CIFSMountConfiguration` has been removed + Struct `CloudErrorBody` has been removed + Struct `CloudError` has been removed
❌azure-sdk-for-python-track2 - track2_azure-mgmt-batch - Approved - 16.2.0+ Model CIFSMountConfiguration no longer has parameter username + Model NetworkConfiguration no longer has parameter dynamic_v_net_assignment_scope + Model PrivateLinkServiceConnectionState no longer has parameter action_required
❌azure-sdk-for-js - @azure/arm-batch - 8.0.0+ Interface CifsMountConfiguration no longer has parameter username + Interface NetworkConfiguration no longer has parameter dynamicVNetAssignmentScope + Interface PrivateLinkServiceConnectionState no longer has parameter actionRequired
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs] Generate from 999f2d3706c86ce460c2817f52f684110f2a8b30. SDK Automation 14.0.0command 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:517 cmderr [Invoke-GenerateAndBuildV2.ps1] [96mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [96m 517 | [0m [96mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [96m | [91m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [91m[96m | [91mFailed to build sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.ResourceManager.Batch [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.Batch.Models.BatchCifsMountConfiguration.Username.set(System.String)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/batch/Azure.ResourceManager.Batch/src/Azure.ResourceManager.Batch.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.Batch.Models.BatchFileShareConfiguration..ctor(System.String, System.Uri, System.String, System.String)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/batch/Azure.ResourceManager.Batch/src/Azure.ResourceManager.Batch.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.Batch.Models.DynamicVNetAssignmentScope> Azure.ResourceManager.Batch.Models.BatchNetworkConfiguration.DynamicVNetAssignmentScope.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/batch/Azure.ResourceManager.Batch/src/Azure.ResourceManager.Batch.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.Batch.Models.BatchNetworkConfiguration.DynamicVNetAssignmentScope.set(System.Nullable<Azure.ResourceManager.Batch.Models.DynamicVNetAssignmentScope>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/batch/Azure.ResourceManager.Batch/src/Azure.ResourceManager.Batch.csproj], info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.String Azure.ResourceManager.Batch.Models.BatchPrivateLinkServiceConnectionState.ActionRequired.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/batch/Azure.ResourceManager.Batch/src/Azure.ResourceManager.Batch.csproj], 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.ResourceManager.Batch/Debug/netstandard2.0/Azure.ResourceManager.Batch.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/batch/Azure.ResourceManager.Batch/src/Azure.ResourceManager.Batch.csproj]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 999f2d3706c86ce460c2817f52f684110f2a8b30. SDK Automation 14.0.0command 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
️✔️track2_azure-mgmt-batch [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Model CIFSMountConfiguration has a new parameter user_name info [Changelog] - Model NetworkConfiguration has a new parameter dynamic_vnet_assignment_scope info [Changelog] - Model Pool has a new parameter current_node_communication_mode info [Changelog] - Model Pool has a new parameter target_node_communication_mode info [Changelog] - Model PrivateLinkServiceConnectionState has a new parameter actions_required info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Model CIFSMountConfiguration no longer has parameter username info [Changelog] - Model NetworkConfiguration no longer has parameter dynamic_v_net_assignment_scope info [Changelog] - Model PrivateLinkServiceConnectionState no longer has parameter action_required
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 999f2d3706c86ce460c2817f52f684110f2a8b30. SDK Automation 14.0.0command ./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 999f2d3706c86ce460c2817f52f684110f2a8b30. SDK Automation 14.0.0command 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 Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Struct `CloudError` has been removed info [Changelog] - Struct `CloudErrorBody` has been removed info [Changelog] - Field `ActionRequired` of struct `PrivateLinkServiceConnectionState` has been removed info [Changelog] - Field `DynamicVNetAssignmentScope` of struct `NetworkConfiguration` has been removed info [Changelog] - Field `Username` of struct `CIFSMountConfiguration` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New const `EndpointAccessDefaultActionAllow` info [Changelog] - New const `NodeCommunicationModeDefault` info [Changelog] - New const `NodeCommunicationModeClassic` info [Changelog] - New const `PrivateEndpointConnectionProvisioningStateDeleting` info [Changelog] - New const `PrivateEndpointConnectionProvisioningStateCreating` info [Changelog] - New const `PrivateEndpointConnectionProvisioningStateCancelled` info [Changelog] - New const `NodeCommunicationModeSimplified` info [Changelog] - New const `EndpointAccessDefaultActionDeny` info [Changelog] - New type alias `EndpointAccessDefaultAction` info [Changelog] - New type alias `NodeCommunicationMode` info [Changelog] - New function `*PrivateEndpointConnectionClient.BeginDelete(context.Context, string, string, string, *PrivateEndpointConnectionClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionClientDeleteResponse], error)` info [Changelog] - New function `PossibleEndpointAccessDefaultActionValues() []EndpointAccessDefaultAction` 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 `DynamicVnetAssignmentScope` in struct `NetworkConfiguration` info [Changelog] - New field `NodeManagementEndpoint` in struct `AccountProperties` info [Changelog] - New field `NetworkProfile` in struct `AccountProperties` info [Changelog] - New field `ActionsRequired` in struct `PrivateLinkServiceConnectionState` info [Changelog] - New field `NetworkProfile` in struct `AccountUpdateProperties` info [Changelog] - New field `PublicNetworkAccess` in struct `AccountUpdateProperties` info [Changelog] - New field `UserName` in struct `CIFSMountConfiguration` info [Changelog] - New field `GroupIDs` in struct `PrivateEndpointConnectionProperties` info [Changelog] - New field `NetworkProfile` in struct `AccountCreateProperties` info [Changelog] - New field `TargetNodeCommunicationMode` in struct `PoolProperties` info [Changelog] - New field `CurrentNodeCommunicationMode` in struct `PoolProperties` info [Changelog] info [Changelog] Total 7 breaking change(s), 31 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 999f2d3706c86ce460c2817f52f684110f2a8b30. SDK Automation 14.0.0command 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] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added Type Alias NodeCommunicationMode info [Changelog] - Interface CifsMountConfiguration has a new optional parameter userName info [Changelog] - Interface NetworkConfiguration has a new optional parameter dynamicVnetAssignmentScope info [Changelog] - Interface Pool has a new optional parameter currentNodeCommunicationMode info [Changelog] - Interface Pool has a new optional parameter targetNodeCommunicationMode info [Changelog] - Interface PrivateLinkServiceConnectionState has a new optional parameter actionsRequired info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Interface CifsMountConfiguration no longer has parameter username info [Changelog] - Interface NetworkConfiguration no longer has parameter dynamicVNetAssignmentScope info [Changelog] - Interface PrivateLinkServiceConnectionState no longer has parameter actionRequired
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from 999f2d3706c86ce460c2817f52f684110f2a8b30. Schema Automation 14.0.0command .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
️✔️batch [View full logs] [Preview Schema Changes]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 999f2d3706c86ce460c2817f52f684110f2a8b30. SDK Automation 14.0.0command 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]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/batch/armbatch | 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-batch | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| .Net | Azure.ResourceManager.Batch | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| JavaScript | @azure/arm-batch | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Java | azure-resourcemanager-batch | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon.
Hi @tombuildsstuff, 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.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Trying to remove storageAccountId with an empty string results in this error:
{
"error": {
"code": "LinkedInvalidPropertyId",
"message": "Property id '' at path 'properties.autoStorage.storageAccountId' is invalid. Expect fully qualified resource Id that start with '/subscriptions/{subscriptionId}' or '/providers/{resourceProviderNamespace}/'."
}
}
Hi, @tombuildsstuff. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi @tombuildsstuff - I'm from the Batch team and I can confirm that this property isn't nullable (at least from a REST API perspective). The way to remove auto-storage from a Batch account would be to set the entire autoStorage object to null.
Valid:
"properties": {
"autoStorage": null
}
Invalid:
"properties": {
"autoStorage": {
"storageAccountId": null
}
}
Hi, @tombuildsstuff. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @tombuildsstuff. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Next Steps to Merge
Next steps that must be taken to merge this PR:- ❌ Your PR has breaking changes in the generated SDK for javascript (label:
CI-BreakingChange-JavaScript). Refer to step 3 in the PR workflow diagram (even if your PR is for data plane, not ARM).