You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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:
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 - Modify examples
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
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.
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: ⚠️
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.
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)
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]
+ Model DataBoxDiskJobDetails no longer has parameter expected_data_size_in_terabytes
+ Model DataBoxHeavyJobDetails no longer has parameter expected_data_size_in_terabytes
+ Model DataBoxJobDetails no longer has parameter expected_data_size_in_terabytes
+ Model DiskScheduleAvailabilityRequest has a new required parameter expected_data_size_in_tera_bytes
+ Model DiskScheduleAvailabilityRequest no longer has parameter expected_data_size_in_terabytes
+ Model JobDetails no longer has parameter expected_data_size_in_terabytes
info [Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.DataBox.Models.TransportShipmentType> Azure.ResourceManager.DataBox.Models.DataBoxOrderPreferences.TransportPreferencesPreferredShipmentType.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.DataBox.Models.DataBoxOrderPreferences.TransportPreferencesPreferredShipmentType.set(System.Nullable<Azure.ResourceManager.DataBox.Models.TransportShipmentType>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public System.Nullable<Azure.ResourceManager.DataBox.Models.TransportShipmentType> Azure.ResourceManager.DataBox.Models.DataBoxValidateAddressContent.TransportPreferencesPreferredShipmentType.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.DataBox.Models.DataBoxValidateAddressContent.TransportPreferencesPreferredShipmentType.set(System.Nullable<Azure.ResourceManager.DataBox.Models.TransportShipmentType>)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public void Azure.ResourceManager.DataBox.Models.MitigateJobContent..ctor(Azure.ResourceManager.DataBox.Models.CustomerResolutionCode)' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : MembersMustExist : Member 'public Azure.ResourceManager.DataBox.Models.CustomerResolutionCode Azure.ResourceManager.DataBox.Models.MitigateJobContent.CustomerResolutionCode.get()' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0],
info [Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.DataBox/Debug/netstandard2.0/Azure.ResourceManager.DataBox.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/databox/Azure.ResourceManager.DataBox/src/Azure.ResourceManager.DataBox.csproj::TargetFramework=netstandard2.0]
⚠️Warning [Logs]Release - Generate from 17b0396. 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]
cmderr [automation_generate.sh] New minor version of npm available! 9.5.0 -> 9.6.5
cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.5>
cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr [automation_generate.sh] npm notice
info [Changelog] ### Features Added
info [Changelog]
info [Changelog] - Added operation JobsOperations.mark_devices_shipped
info [Changelog] - Added operation group DataBoxManagementClientOperationsMixin
info [Changelog] - Model CopyProgress has a new parameter actions
info [Changelog] - Model CopyProgress has a new parameter error
info [Changelog] - Model DataBoxDiskCopyProgress has a new parameter actions
info [Changelog] - Model DataBoxDiskCopyProgress has a new parameter error
info [Changelog] - Model DataBoxDiskJobDetails has a new parameter actions
info [Changelog] - Model DataBoxDiskJobDetails has a new parameter data_center_code
info [Changelog] - Model DataBoxDiskJobDetails has a new parameter datacenter_address
info [Changelog] - Model DataBoxDiskJobDetails has a new parameter device_erasure_details
info [Changelog] - Model DataBoxDiskJobDetails has a new parameter expected_data_size_in_tera_bytes
info [Changelog] - Model DataBoxDiskJobDetails has a new parameter granular_copy_log_details
info [Changelog] - Model DataBoxDiskJobDetails has a new parameter granular_copy_progress
info [Changelog] - Model DataBoxDiskJobDetails has a new parameter last_mitigation_action_on_job
info [Changelog] - Model DataBoxDiskJobDetails has a new parameter reverse_shipping_details
info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter actions
info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter data_center_code
info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter datacenter_address
info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter device_erasure_details
info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter expected_data_size_in_tera_bytes
info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter last_mitigation_action_on_job
info [Changelog] - Model DataBoxHeavyJobDetails has a new parameter reverse_shipping_details
info [Changelog] - Model DataBoxJobDetails has a new parameter actions
info [Changelog] - Model DataBoxJobDetails has a new parameter data_center_code
info [Changelog] - Model DataBoxJobDetails has a new parameter datacenter_address
info [Changelog] - Model DataBoxJobDetails has a new parameter device_erasure_details
info [Changelog] - Model DataBoxJobDetails has a new parameter expected_data_size_in_tera_bytes
info [Changelog] - Model DataBoxJobDetails has a new parameter last_mitigation_action_on_job
info [Changelog] - Model DataBoxJobDetails has a new parameter reverse_shipping_details
info [Changelog] - Model DataImportDetails has a new parameter log_collection_level
info [Changelog] - Model EncryptionPreferences has a new parameter hardware_encryption
info [Changelog] - Model JobDetails has a new parameter actions
info [Changelog] - Model JobDetails has a new parameter data_center_code
info [Changelog] - Model JobDetails has a new parameter datacenter_address
info [Changelog] - Model JobDetails has a new parameter device_erasure_details
info [Changelog] - Model JobDetails has a new parameter expected_data_size_in_tera_bytes
info [Changelog] - Model JobDetails has a new parameter last_mitigation_action_on_job
info [Changelog] - Model JobDetails has a new parameter reverse_shipping_details
info [Changelog] - Model JobResource has a new parameter reverse_shipping_details_update
info [Changelog] - Model JobResource has a new parameter reverse_transport_preference_update
info [Changelog] - Model JobResource has a new parameter system_data
info [Changelog] - Model Preferences has a new parameter reverse_transport_preferences
info [Changelog] - Model Preferences has a new parameter storage_account_access_tier_preferences
info [Changelog] - Model RegionConfigurationRequest has a new parameter datacenter_address_request
info [Changelog] - Model RegionConfigurationResponse has a new parameter datacenter_address_response
info [Changelog] - Model ShippingAddress has a new parameter skip_address_validation
info [Changelog] - Model ShippingAddress has a new parameter tax_identification_number
info [Changelog] - Model SkuInformation has a new parameter countries_within_commerce_boundary
info [Changelog] - Model TransportPreferences has a new parameter is_updated
info [Changelog] - Model UpdateJobDetails has a new parameter preferences
info [Changelog] - Model UpdateJobDetails has a new parameter return_to_customer_package_details
info [Changelog] - Model UpdateJobDetails has a new parameter reverse_shipping_details
info [Changelog]
info [Changelog] ### Breaking Changes
info [Changelog]
info [Changelog] - Model DataBoxDiskJobDetails no longer has parameter expected_data_size_in_terabytes
info [Changelog] - Model DataBoxHeavyJobDetails no longer has parameter expected_data_size_in_terabytes
info [Changelog] - Model DataBoxJobDetails no longer has parameter expected_data_size_in_terabytes
info [Changelog] - Model DiskScheduleAvailabilityRequest has a new required parameter expected_data_size_in_tera_bytes
info [Changelog] - Model DiskScheduleAvailabilityRequest no longer has parameter expected_data_size_in_terabytes
info [Changelog] - Model JobDetails no longer has parameter expected_data_size_in_terabytes
️✔️Succeeded [Logs]Release - Generate from 17b0396. 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
info [Changelog] ### Breaking Changes
info [Changelog]
info [Changelog] - Field `AccountName` of struct `DiskGranularCopyLogDetails` has been removed
info [Changelog]
info [Changelog] ### Features Added
info [Changelog]
info [Changelog] - New enum type `HardwareEncryption` with values `HardwareEncryptionDisabled`, `HardwareEncryptionEnabled`
info [Changelog] - New enum type `ReverseShippingDetailsEditStatus` with values `ReverseShippingDetailsEditStatusDisabled`, `ReverseShippingDetailsEditStatusEnabled`, `ReverseShippingDetailsEditStatusNotSupported`
info [Changelog] - New enum type `ReverseTransportPreferenceEditStatus` with values `ReverseTransportPreferenceEditStatusDisabled`, `ReverseTransportPreferenceEditStatusEnabled`, `ReverseTransportPreferenceEditStatusNotSupported`
info [Changelog] - New struct `ContactInfo`
info [Changelog] - New struct `ReverseShippingDetails`
info [Changelog] - New field `ReverseShippingDetails` in struct `CommonJobDetails`
info [Changelog] - New field `Actions`, `Error` in struct `CopyProgress`
info [Changelog] - New field `Actions`, `Error` in struct `CustomerDiskCopyProgress`
info [Changelog] - New field `ReverseShippingDetails` in struct `CustomerDiskJobDetails`
info [Changelog] - New field `Actions`, `Error` in struct `DiskCopyProgress`
info [Changelog] - New field `AccountID` in struct `DiskGranularCopyLogDetails`
info [Changelog] - New field `Actions`, `Error` in struct `DiskGranularCopyProgress`
info [Changelog] - New field `GranularCopyLogDetails`, `ReverseShippingDetails` in struct `DiskJobDetails`
info [Changelog] - New field `HardwareEncryption` in struct `EncryptionPreferences`
info [Changelog] - New field `Actions`, `Error` in struct `GranularCopyProgress`
info [Changelog] - New field `ReverseShippingDetails` in struct `HeavyJobDetails`
info [Changelog] - New field `ReverseShippingDetails` in struct `JobDetails`
info [Changelog] - New field `ReverseShippingDetailsUpdate`, `ReverseTransportPreferenceUpdate` in struct `JobProperties`
info [Changelog] - New field `SerialNumberCustomerResolutionMap` in struct `MitigateJobRequest`
info [Changelog] - New field `ReverseTransportPreferences` in struct `Preferences`
info [Changelog] - New field `CountriesWithinCommerceBoundary` in struct `SKUProperties`
info [Changelog] - New field `SkipAddressValidation`, `TaxIdentificationNumber` in struct `ShippingAddress`
info [Changelog] - New field `IsUpdated` in struct `TransportPreferences`
info [Changelog] - New field `Preferences`, `ReverseShippingDetails` in struct `UpdateJobDetails`
info [Changelog]
info [Changelog] Total 1 breaking change(s), 34 additive change(s).
⚠️Warning [Logs]Release - Generate from 17b0396. 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
warn No file changes detected after generation
Hi @vaishnavi-janardhan, 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.
@qiaozha, all the required checks are passing for this PR.
This PR only contains changes to example files. Can you please review and merge the changes if it looks good?
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.