Skip to content

Conversation

@golddove
Copy link
Member

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • Swagger bug fix (to match service behavior)

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@golddove golddove requested a review from JasonYang-MSFT as a code owner June 21, 2024 00:21
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 21, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 21, 2024

Swagger Validation Report

️❌BreakingChange: 10 Errors, 0 Warnings failed [Detail]
Compared specs (v0.10.9) new version base version
storageTaskAssignments.json 2023-05-01(b587b34) 2023-05-01(main)
storageactions.json 2023-01-01(b587b34) 2023-01-01(main)
Rule Message
1023 - TypeFormatChanged The new version has a different format 'int32' than the previous one ''.
New: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L275:11
Old: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L275:11
1023 - TypeFormatChanged The new version has a different format 'int32' than the previous one ''.
New: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L327:11
Old: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L326:11
1023 - TypeFormatChanged The new version has a different format 'int32' than the previous one ''.
New: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L388:11
Old: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L386:11
1023 - TypeFormatChanged The new version has a different format 'int32' than the previous one ''.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L374:11
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L374:11
1023 - TypeFormatChanged The new version has a different format 'int32' than the previous one ''.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L426:11
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L425:11
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'string'.
New: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L275:11
Old: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L275:11
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'string'.
New: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L327:11
Old: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L326:11
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'string'.
New: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L388:11
Old: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L386:11
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'string'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L374:11
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L374:11
1026 - TypeChanged The new version has a different type 'integer' than the previous one 'string'.
New: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L426:11
Old: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L425:11
️️✔️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 specs (v2.2.2) new version base version
package-2023-05 package-2023-05(b587b34) package-2023-05(main)
package-2023-01-01 package-2023-01-01(b587b34) package-2023-01-01(main)

The following errors/warnings exist before current PR submission:

Rule Message
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L56
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:enabled.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:description.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:action.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:if.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:condition.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:operations.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L234
AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L696
⚠️ RequiredReadOnlySystemData The response of operation:'StorageTaskAssignments_Create' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L20
⚠️ RequiredReadOnlySystemData The response of operation:'StorageTaskAssignments_Update' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L93
⚠️ RequiredReadOnlySystemData The response of operation:'StorageTaskAssignments_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L157
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L253
⚠️ MissingSegmentsInNestedResourceListOperation A nested resource type's List operation must include all the parent segments in its api path.
Location: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L305
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L436
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L452
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.Storage/stable/2023-05-01/storageTaskAssignments.json#L632
⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'StorageTaskAssignmentModel'. Consider using the plural form of 'StorageTaskAssignment' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L360
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ListStorageTasksByResourceGroup
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L414
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L485
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L576
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.StorageActions/stable/2023-01-01/storageactions.json#L983
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 21, 2024

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed in generating from df728993d9273da02bb5fc140b18e0b0adfde7b9. 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] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  807 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  807 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
    cmderr	[Invoke-GenerateAndBuildV2.ps1]  714 |          GeneratePackage -projectFolder $projectFolder -sdkRootPath $s …
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      |          ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact
  • Azure.ResourceManager.Storage [Preview SDK Changes]
    info	[Changelog]
  • ️✔️Azure.ResourceManager.StorageActions [Preview SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from df728993d9273da02bb5fc140b18e0b0adfde7b9. 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] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
    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
  • ️✔️azure-mgmt-storage [Preview SDK Changes]
    • azure-mgmt-storage-21.2.0.zip
    • azure_mgmt_storage-21.2.0-py3-none-any.whl
    info	[Changelog]
  • ️✔️azure-mgmt-storageactions [Preview SDK Changes]
    • azure_mgmt_storageactions-1.0.0b1-py3-none-any.whl
    • azure-mgmt-storageactions-1.0.0b1.zip
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from df728993d9273da02bb5fc140b18e0b0adfde7b9. 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
  • ️✔️azure-resourcemanager-storage-generated [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-storage-generated-1.0.0-beta.1-sources.jar
    • azure-resourcemanager-storage-generated-1.0.0-beta.1.jar
  • ️✔️azure-resourcemanager-storageactions [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-storageactions-1.0.0-beta.2.jar
    • azure-resourcemanager-storageactions-1.0.0-beta.2-sources.jar
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from df728993d9273da02bb5fc140b18e0b0adfde7b9. 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/storage/armstorage [Preview SDK Changes]
    Only showing 60 items here. Refer to log for details.
    info	[Changelog] - New enum type `RunResult` with values `RunResultFailed`, `RunResultSucceeded`
    info	[Changelog] - New enum type `RunStatusEnum` with values `RunStatusEnumFinished`, `RunStatusEnumInProgress`
    info	[Changelog] - New enum type `Severity` with values `SeverityError`, `SeverityWarning`
    info	[Changelog] - New enum type `TriggerType` with values `TriggerTypeOnSchedule`, `TriggerTypeRunOnce`
    info	[Changelog] - New function `*ClientFactory.NewNetworkSecurityPerimeterConfigurationsClient() *NetworkSecurityPerimeterConfigurationsClient`
    info	[Changelog] - New function `*ClientFactory.NewTaskAssignmentInstancesReportClient() *TaskAssignmentInstancesReportClient`
    info	[Changelog] - New function `*ClientFactory.NewTaskAssignmentsClient() *TaskAssignmentsClient`
    info	[Changelog] - New function `*ClientFactory.NewTaskAssignmentsInstancesReportClient() *TaskAssignmentsInstancesReportClient`
    info	[Changelog] - New function `NewTaskAssignmentInstancesReportClient(string, azcore.TokenCredential, *arm.ClientOptions) (*TaskAssignmentInstancesReportClient, error)`
    info	[Changelog] - New function `*TaskAssignmentInstancesReportClient.NewListPager(string, string, string, *TaskAssignmentInstancesReportClientListOptions) *runtime.Pager[TaskAssignmentInstancesReportClientListResponse]`
    info	[Changelog] - New function `NewTaskAssignmentsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*TaskAssignmentsClient, error)`
    info	[Changelog] - New function `*TaskAssignmentsClient.BeginCreate(context.Context, string, string, string, TaskAssignment, *TaskAssignmentsClientBeginCreateOptions) (*runtime.Poller[TaskAssignmentsClientCreateResponse], error)`
    info	[Changelog] - New function `*TaskAssignmentsClient.BeginDelete(context.Context, string, string, string, *TaskAssignmentsClientBeginDeleteOptions) (*runtime.Poller[TaskAssignmentsClientDeleteResponse], error)`
    info	[Changelog] - New function `*TaskAssignmentsClient.Get(context.Context, string, string, string, *TaskAssignmentsClientGetOptions) (TaskAssignmentsClientGetResponse, error)`
    info	[Changelog] - New function `*TaskAssignmentsClient.NewListPager(string, string, *TaskAssignmentsClientListOptions) *runtime.Pager[TaskAssignmentsClientListResponse]`
    info	[Changelog] - New function `*TaskAssignmentsClient.BeginUpdate(context.Context, string, string, string, TaskAssignmentUpdateParameters, *TaskAssignmentsClientBeginUpdateOptions) (*runtime.Poller[TaskAssignmentsClientUpdateResponse], error)`
    info	[Changelog] - New function `NewTaskAssignmentsInstancesReportClient(string, azcore.TokenCredential, *arm.ClientOptions) (*TaskAssignmentsInstancesReportClient, error)`
    info	[Changelog] - New function `*TaskAssignmentsInstancesReportClient.NewListPager(string, string, *TaskAssignmentsInstancesReportClientListOptions) *runtime.Pager[TaskAssignmentsInstancesReportClientListResponse]`
    info	[Changelog] - New function `NewNetworkSecurityPerimeterConfigurationsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*NetworkSecurityPerimeterConfigurationsClient, error)`
    info	[Changelog] - New function `*NetworkSecurityPerimeterConfigurationsClient.Get(context.Context, string, string, string, *NetworkSecurityPerimeterConfigurationsClientGetOptions) (NetworkSecurityPerimeterConfigurationsClientGetResponse, error)`
    info	[Changelog] - New function `*NetworkSecurityPerimeterConfigurationsClient.NewListPager(string, string, *NetworkSecurityPerimeterConfigurationsClientListOptions) *runtime.Pager[NetworkSecurityPerimeterConfigurationsClientListResponse]`
    info	[Changelog] - New function `*NetworkSecurityPerimeterConfigurationsClient.BeginReconcile(context.Context, string, string, string, *NetworkSecurityPerimeterConfigurationsClientBeginReconcileOptions) (*runtime.Poller[NetworkSecurityPerimeterConfigurationsClientReconcileResponse], error)`
    info	[Changelog] - New struct `ExecutionTarget`
    info	[Changelog] - New struct `ExecutionTrigger`
    info	[Changelog] - New struct `ExecutionTriggerUpdate`
    info	[Changelog] - New struct `NetworkSecurityPerimeter`
    info	[Changelog] - New struct `NetworkSecurityPerimeterConfiguration`
    info	[Changelog] - New struct `NetworkSecurityPerimeterConfigurationList`
    info	[Changelog] - New struct `NetworkSecurityPerimeterConfigurationProperties`
    info	[Changelog] - New struct `NetworkSecurityPerimeterConfigurationPropertiesProfile`
    info	[Changelog] - New struct `NetworkSecurityPerimeterConfigurationPropertiesResourceAssociation`
    info	[Changelog] - New struct `NspAccessRule`
    info	[Changelog] - New struct `NspAccessRuleProperties`
    info	[Changelog] - New struct `NspAccessRulePropertiesSubscriptionsItem`
    info	[Changelog] - New struct `ProvisioningIssue`
    info	[Changelog] - New struct `ProvisioningIssueProperties`
    info	[Changelog] - New struct `ProxyResourceAutoGenerated`
    info	[Changelog] - New struct `ResourceAutoGenerated`
    info	[Changelog] - New struct `TaskAssignment`
    info	[Changelog] - New struct `TaskAssignmentExecutionContext`
    info	[Changelog] - New struct `TaskAssignmentProperties`
    info	[Changelog] - New struct `TaskAssignmentReport`
    info	[Changelog] - New struct `TaskAssignmentUpdateExecutionContext`
    info	[Changelog] - New struct `TaskAssignmentUpdateParameters`
    info	[Changelog] - New struct `TaskAssignmentUpdateProperties`
    info	[Changelog] - New struct `TaskAssignmentUpdateReport`
    info	[Changelog] - New struct `TaskAssignmentsList`
    info	[Changelog] - New struct `TaskReportInstance`
    info	[Changelog] - New struct `TaskReportProperties`
    info	[Changelog] - New struct `TaskReportSummary`
    info	[Changelog] - New struct `TriggerParameters`
    info	[Changelog] - New struct `TriggerParametersUpdate`
    info	[Changelog] - New field `EnableExtendedGroups` in struct `AccountProperties`
    info	[Changelog] - New field `EnableExtendedGroups` in struct `AccountPropertiesCreateParameters`
    info	[Changelog] - New field `EnableExtendedGroups` in struct `AccountPropertiesUpdateParameters`
    info	[Changelog] - New field `AllowACLAuthorization`, `ExtendedGroups`, `GroupID`, `IsNFSv3Enabled`, `UserID` in struct `LocalUserProperties`
    info	[Changelog] - New field `NextLink` in struct `LocalUsers`
    info	[Changelog] - New field `Filter`, `Include`, `Maxpagesize` in struct `LocalUsersClientListOptions`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 123 additive change(s).
  • ️✔️sdk/resourcemanager/storageactions/armstorageactions [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Type of `StorageTaskAssignmentClientListOptions.Maxpagesize` has been changed from `*string` to `*int32`
    info	[Changelog] - Type of `StorageTasksReportClientListOptions.Maxpagesize` has been changed from `*string` to `*int32`
    info	[Changelog]
    info	[Changelog] Total 2 breaking change(s), 0 additive change(s).
    Present SDK breaking changes suppressions
    Type of `StorageTaskAssignmentClientListOptions.Maxpagesize` has been changed from `*string` to `*int32`
    Type of `StorageTasksReportClientListOptions.Maxpagesize` has been changed from `*string` to `*int32`
    Please refer to https://aka.ms/azsdk/sdk-suppression for more information.
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from df728993d9273da02bb5fc140b18e0b0adfde7b9. 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	Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-storage [Preview SDK Changes]
    • azure-arm-storage-18.3.0.tgz
    Only showing 60 items here. Refer to log for details.
    info	[Changelog]   - Added Interface StorageTaskAssignmentsInstancesReportListOptionalParams
    info	[Changelog]   - Added Interface StorageTaskAssignmentsList
    info	[Changelog]   - Added Interface StorageTaskAssignmentsListNextOptionalParams
    info	[Changelog]   - Added Interface StorageTaskAssignmentsListOptionalParams
    info	[Changelog]   - Added Interface StorageTaskAssignmentsUpdateHeaders
    info	[Changelog]   - Added Interface StorageTaskAssignmentsUpdateOptionalParams
    info	[Changelog]   - Added Interface StorageTaskAssignmentUpdateExecutionContext
    info	[Changelog]   - Added Interface StorageTaskAssignmentUpdateParameters
    info	[Changelog]   - Added Interface StorageTaskAssignmentUpdateProperties
    info	[Changelog]   - Added Interface StorageTaskAssignmentUpdateReport
    info	[Changelog]   - Added Interface StorageTaskReportInstance
    info	[Changelog]   - Added Interface StorageTaskReportProperties
    info	[Changelog]   - Added Interface StorageTaskReportSummary
    info	[Changelog]   - Added Interface TriggerParameters
    info	[Changelog]   - Added Interface TriggerParametersUpdate
    info	[Changelog]   - Added Type Alias IssueType
    info	[Changelog]   - Added Type Alias ListLocalUserIncludeParam
    info	[Changelog]   - Added Type Alias NetworkSecurityPerimeterConfigurationProvisioningState
    info	[Changelog]   - Added Type Alias NetworkSecurityPerimeterConfigurationsGetResponse
    info	[Changelog]   - Added Type Alias NetworkSecurityPerimeterConfigurationsListResponse
    info	[Changelog]   - Added Type Alias NetworkSecurityPerimeterConfigurationsReconcileResponse
    info	[Changelog]   - Added Type Alias NspAccessRuleDirection
    info	[Changelog]   - Added Type Alias ResourceAssociationAccessMode
    info	[Changelog]   - Added Type Alias RunResult
    info	[Changelog]   - Added Type Alias RunStatusEnum
    info	[Changelog]   - Added Type Alias Severity
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentInstancesReportListNextResponse
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentInstancesReportListResponse
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentsCreateResponse
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentsDeleteResponse
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentsGetResponse
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentsInstancesReportListNextResponse
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentsInstancesReportListResponse
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentsListNextResponse
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentsListResponse
    info	[Changelog]   - Added Type Alias StorageTaskAssignmentsUpdateResponse
    info	[Changelog]   - Added Type Alias TriggerType
    info	[Changelog]   - Interface LocalUser has a new optional parameter allowAclAuthorization
    info	[Changelog]   - Interface LocalUser has a new optional parameter extendedGroups
    info	[Changelog]   - Interface LocalUser has a new optional parameter groupId
    info	[Changelog]   - Interface LocalUser has a new optional parameter isNFSv3Enabled
    info	[Changelog]   - Interface LocalUser has a new optional parameter userId
    info	[Changelog]   - Interface LocalUsers has a new optional parameter nextLink
    info	[Changelog]   - Interface LocalUsersListOptionalParams has a new optional parameter filter
    info	[Changelog]   - Interface LocalUsersListOptionalParams has a new optional parameter include
    info	[Changelog]   - Interface LocalUsersListOptionalParams has a new optional parameter maxpagesize
    info	[Changelog]   - Interface StorageAccount has a new optional parameter enableExtendedGroups
    info	[Changelog]   - Interface StorageAccountCreateParameters has a new optional parameter enableExtendedGroups
    info	[Changelog]   - Interface StorageAccountUpdateParameters has a new optional parameter enableExtendedGroups
    info	[Changelog]   - Added Enum KnownIssueType
    info	[Changelog]   - Added Enum KnownListLocalUserIncludeParam
    info	[Changelog]   - Added Enum KnownNetworkSecurityPerimeterConfigurationProvisioningState
    info	[Changelog]   - Added Enum KnownNspAccessRuleDirection
    info	[Changelog]   - Added Enum KnownResourceAssociationAccessMode
    info	[Changelog]   - Added Enum KnownRunResult
    info	[Changelog]   - Added Enum KnownRunStatusEnum
    info	[Changelog]   - Added Enum KnownSeverity
    info	[Changelog]   - Enum KnownExpirationAction has a new value Block
    info	[Changelog]   - Enum KnownMinimumTlsVersion has a new value TLS13
    info	[Changelog]   - Enum KnownPublicNetworkAccess has a new value SecuredByPerimeter
  • ️✔️@azure/arm-storageactions [Preview SDK Changes]
    • azure-arm-storageactions-1.0.0.tgz
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️❌ azure-resource-manager-schemas failed [Detail]
  • Code Generator Failed in generating from df728993d9273da02bb5fc140b18e0b0adfde7b9. 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] Submodule 'bicep-types-az' (https://github.com/Azure/bicep-types-az) registered for path 'bicep-types-az'
    cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az'...
    cmderr	[initScript.sh] Submodule 'bicep-types' (https://github.com/Azure/bicep-types) registered for path 'bicep-types-az/bicep-types'
    cmderr	[initScript.sh] Cloning into '/mnt/vss/_work/1/s/azure-resource-manager-schemas/bicep-types-az/bicep-types'...
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
    cmderr	[initScript.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
    cmderr	[initScript.sh] npm notice To update run: npm install -g [email protected]
    cmderr	[initScript.sh] npm notice
    error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/initScript.sh
    warn	Warning: File azure-resource-manager-schemas_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    cmderr	[generateScript.sh] /mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500
    cmderr	[generateScript.sh]     return new TSError(diagnosticText, diagnosticCodes)
    cmderr	[generateScript.sh]            ^
    cmderr	[generateScript.sh] TSError: ⨯ Unable to compile TypeScript:
    cmderr	[generateScript.sh] cmd/generateall.ts(6,20): error TS2307: Cannot find module 'colors' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(10,19): error TS2307: Cannot find module 'yargs' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(11,18): error TS2307: Cannot find module 'path' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(13,35): error TS2307: Cannot find module 'fs' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(14,23): error TS2307: Cannot find module 'strip-ansi' or its corresponding type declarations.
    cmderr	[generateScript.sh] cmd/generateall.ts(42,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(53,9): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(69,67): error TS7006: Parameter 'x' implicitly has an 'any' type.
    cmderr	[generateScript.sh] cmd/generateall.ts(70,49): error TS7006: Parameter 'f' implicitly has an 'any' type.
    cmderr	[generateScript.sh] cmd/generateall.ts(94,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(105,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(106,21): error TS2584: Cannot find name 'console'. Do you need to change your target library? Try changing the 'lib' compiler option to include 'dom'.
    cmderr	[generateScript.sh] cmd/generateall.ts(157,13): error TS2591: Cannot find name 'process'. Do you need to install type definitions for node? Try `npm i --save-dev @types/node` and then add 'node' to the types field in your tsconfig.
    cmderr	[generateScript.sh]     at createTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:500:12)
    cmderr	[generateScript.sh]     at reportTSError (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:504:19)
    cmderr	[generateScript.sh]     at getOutput (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:739:36)
    cmderr	[generateScript.sh]     at Object.compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:955:32)
    cmderr	[generateScript.sh]     at Module.m._compile (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1043:43)
    cmderr	[generateScript.sh]     at Module._extensions..js (node:internal/modules/cjs/loader:1422:10)
    cmderr	[generateScript.sh]     at Object.require.extensions.<computed> [as .ts] (/mnt/vss/_work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/[email protected][email protected]/node_modules/ts-node/src/index.ts:1046:12)
    cmderr	[generateScript.sh]     at Module.load (node:internal/modules/cjs/loader:1203:32)
    cmderr	[generateScript.sh]     at Function.Module._load (node:internal/modules/cjs/loader:1019:12)
    cmderr	[generateScript.sh]     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:128:12)
    error	Script return with result [failed] code [1] signal [null] cwd [azure-resource-manager-schemas]: .sdkauto/generateScript.sh
    warn	Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    warn		Warning: azure-resource-manager-schemas cannot be found in specification/storageactions/resource-manager/readme.md. This SDK will be skipped from SDK generation. Please add the right config to the readme file according to this guidance https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/code-gen/configure-go-sdk.md#swagger-to-sdk.
    error	ConfigError: the 'breakingChangesLabel' configuration is missing or is incorrect from the 'swagger_to_sdk_config.json file. Please correct the value or report this issue through https://aka.ms/azsdk/support/specreview-channel.
    error	ConfigError: the 'breakingChangesLabel' configuration is missing or is incorrect from the 'swagger_to_sdk_config.json file. Please correct the value or report this issue through https://aka.ms/azsdk/support/specreview-channel.
️️✔️ azure-powershell succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from df728993d9273da02bb5fc140b18e0b0adfde7b9. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    warn		Warning: azure-powershell cannot be found in specification/storageactions/resource-manager/readme.md. This SDK will be skipped from SDK generation. Please add the right config to the readme file according to this guidance https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/code-gen/configure-go-sdk.md#swagger-to-sdk.
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
  • ️✔️Az.storage.DefaultTag [Preview SDK Changes]
    • Az.Storage.0.1.0.nupkg
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jun 21, 2024

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager labels Jun 21, 2024
@triciarosario triciarosario added BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview labels Jun 21, 2024
@golddove
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Commenter does not have sufficient privileges for PR 29534 in repo Azure/azure-rest-api-specs

@triciarosario
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 21, 2024
Copy link
Member

@blueww blueww left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a swagger only fix. Server already works with maxpagesize as integer.

@weidongxu-microsoft
Copy link
Member

@msyyc and @raych1 for Go/Python break

@msyyc
Copy link
Member

msyyc commented Jun 21, 2024

@razvanbadea-msft
Copy link
Member

I see that the $maxpagesize is still of type string in blob.json, file.json, queue.json. Shouldnt you modify also the type there?

@blueww
Copy link
Member

blueww commented Jun 21, 2024

I see that the $maxpagesize is still of type string in blob.json, file.json, queue.json. Shouldnt you modify also the type there?

Thanks @razvanbadea-msft for the review!
For blob.json, file.json, queue.json, they are already released in GA SDK, change the type now will be a breaking change for SDK. (We might can consider in a future API version.)
However, as this is the first time "StorageTaskAssignments_List" released in PSH/CLI/SDK, change it now can avoid breaking in the future.
And StorageAction RP is in public preview , so only beta SDK is released. SDK team has confirmed this breaking in beta SDK is OK.

@blueww
Copy link
Member

blueww commented Jun 24, 2024

@mentat9 , @razvanbadea-msft

Would you please help to look at the swagger PR?
Feel free to let us know if any action needed from us to make it merged.

This is a swagger only fix (no server change), and PSH/CLI/SDK release are blocked for this fix.
It would be great if you could help to finish the ARM review ASAP.

@razvanbadea-msft razvanbadea-msft added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 24, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 24, 2024
@ramoka178 ramoka178 merged commit db377f4 into Azure:main Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior BreakingChange-Go-Sdk-Suppression BreakingChange-Go-Sdk-Suppression-Approved BreakingChange-Python-Sdk BreakingChange-Python-Sdk-Approved BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.