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
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
Adding a new service
Adding new API(s)
Adding a new API version
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
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 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. vsswagger@microsoft.com
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.
⚠️Warning [Logs] Generate from 283bb0fd7fc60f913379d9457f15c04253ff1d55. 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] npm notice New minor version of npm available! 8.1.2 -> 8.4.1
cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.4.1>
cmderr [automation_generate.sh] npm notice Run `npm install -g npm@8.4.1` to update!
cmderr [automation_generate.sh] npm notice
Only show 3 items here, please refer to log for details.
info [Changelog] - New field `BillingType` in struct `ExpressRoutePortPropertiesFormat`
info [Changelog]
info [Changelog] Total 0 breaking change(s), 4 additive change(s).
Only show 3 items here, please refer to log for details.
info [Changelog] - New field `ResourceGUID` in struct `PrivateLinkServiceProperties`
info [Changelog]
info [Changelog] Total 0 breaking change(s), 6 additive change(s).
Only show 3 items here, please refer to log for details.
info [Changelog] - New field `ExtendedLocation` in struct `VirtualNetworkGateway`
info [Changelog]
info [Changelog] Total 2 breaking change(s), 35 additive change(s).
Only show 3 items here, please refer to log for details.
info [Changelog] - New field `Type` in struct `InterfaceIPConfiguration`
info [Changelog]
info [Changelog] Total 2 breaking change(s), 27 additive change(s).
info [Changelog] ### Breaking Changes
info [Changelog]
info [Changelog] - Type of `BastionActiveSession.StartTime` has been changed from `map[string]interface{}` to `interface{}`
info [Changelog] - Function `VirtualHubEffectiveRouteList.MarshalJSON` has been removed
info [Changelog] - Function `VirtualHubEffectiveRoute.MarshalJSON` has been removed
info [Changelog] - Function `CloudErrorBody.MarshalJSON` has been removed
info [Changelog] - Function `Error.MarshalJSON` has been removed
info [Changelog] - Struct `AzureAsyncOperationResult` has been removed
info [Changelog] - Struct `CloudError` has been removed
info [Changelog] - Struct `CloudErrorBody` has been removed
info [Changelog] - Struct `Error` has been removed
info [Changelog] - Struct `ErrorDetails` has been removed
info [Changelog] - Struct `ErrorResponse` has been removed
info [Changelog] - Struct `VPNSiteID` has been removed
info [Changelog] - Struct `VirtualHubEffectiveRoute` has been removed
info [Changelog] - Struct `VirtualHubEffectiveRouteList` has been removed
info [Changelog]
info [Changelog] ### Features Added
info [Changelog]
info [Changelog] - New const `ApplicationGatewayProtocolTCP`
info [Changelog] - New const `ApplicationGatewayProtocolTLS`
info [Changelog] - New function `ApplicationGatewayBackendSettingsPropertiesFormat.MarshalJSON() ([]byte, error)`
info [Changelog] - New struct `ApplicationGatewayBackendSettings`
info [Changelog] - New struct `ApplicationGatewayBackendSettingsPropertiesFormat`
info [Changelog] - New struct `ApplicationGatewayListener`
info [Changelog] - New struct `ApplicationGatewayListenerPropertiesFormat`
info [Changelog] - New struct `ApplicationGatewayRoutingRule`
info [Changelog] - New struct `ApplicationGatewayRoutingRulePropertiesFormat`
info [Changelog] - New field `Listeners` in struct `ApplicationGatewayPropertiesFormat`
info [Changelog] - New field `BackendSettingsCollection` in struct `ApplicationGatewayPropertiesFormat`
info [Changelog] - New field `RoutingRules` in struct `ApplicationGatewayPropertiesFormat`
info [Changelog] - New field `PickHostNameFromBackendSettings` in struct `ApplicationGatewayProbePropertiesFormat`
info [Changelog]
info [Changelog] Total 23 breaking change(s), 17 additive change(s).
⚠️Warning [Logs] Generate from 283bb0fd7fc60f913379d9457f15c04253ff1d55. 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
cmderr [automation_init.sh] read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr [automation_init.sh] uuid@3.4.0: Please upgrade to version 7 or higher. Older versions may use Math.random() in certain circumstances, which is known to be problematic. See https://v8.dev/blog/math-random for details.
cmderr [automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr [automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
cmderr [automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
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] **Features**
info [Changelog]
info [Changelog] - Added Type Alias ApplicationGatewayBackendSettings
info [Changelog] - Added Type Alias ApplicationGatewayListener
info [Changelog] - Added Type Alias ApplicationGatewayRoutingRule
info [Changelog] - Added Type Alias SingleQueryResultDirection
info [Changelog] - Added Type Alias SingleQueryResultMode
info [Changelog] - Added Type Alias SingleQueryResultSeverity
info [Changelog] - Type Alias ApplicationGateway has a new parameter backendSettingsCollection
info [Changelog] - Type Alias ApplicationGateway has a new parameter listeners
info [Changelog] - Type Alias ApplicationGateway has a new parameter routingRules
info [Changelog] - Type Alias ApplicationGatewayProbe has a new parameter pickHostNameFromBackendSettings
info [Changelog] - Added Enum KnownSingleQueryResultDirection
info [Changelog] - Added Enum KnownSingleQueryResultMode
info [Changelog] - Added Enum KnownSingleQueryResultSeverity
info [Changelog] - Enum KnownApplicationGatewayProtocol has a new value Tcp
info [Changelog] - Enum KnownApplicationGatewayProtocol has a new value Tls
info [Changelog]
info [Changelog] **Breaking Changes**
info [Changelog]
info [Changelog] - Removed Enum KnownEnum69
info [Changelog] - Removed Enum KnownEnum70
info [Changelog] - Removed Enum KnownEnum71
⚠️Warning [Logs] Generate from 283bb0fd7fc60f913379d9457f15c04253ff1d55. 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
warn Skip detect changed packages
Hi @nimaller, 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.
A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.
EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.
@nimaller, as you are working on the branch of network-2021-08-01, why are you changing the file for the api version of 2021-03-01? It would cause breaking changes to the existing version.
This file contains hidden or 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
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
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.
Please follow the link to find more details on PR review process.