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
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process. IMPORTANT This applies even if:
The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
You believe there is no need for you to request breaking change approval, for any reason.
Such claims must be reviewed, and the process is the same.
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
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 generated using OpenAPI Hub).
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:
As mentioned in this thread. We got the stable version merged a day ago which is not yet added in the ARM manifest, we got the intimation that the GA of the service might be delayed with indefinite date as of today so we don't want to maintain a stable version unnecessarily, hence moving it back to preview.
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.
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.
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.
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.
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}' removed or restructured? Old: Microsoft.AzurePlaywrightService/stable/2024-02-01/playwrighttesting.json#L328:5
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}/quotas' removed or restructured? Old: Microsoft.AzurePlaywrightService/stable/2024-02-01/playwrighttesting.json#L571:5
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzurePlaywrightService/accounts/{accountName}/quotas/{quotaName}' removed or restructured? Old: Microsoft.AzurePlaywrightService/stable/2024-02-01/playwrighttesting.json#L623:5
+ Interface FreeTrialProperties no longer has parameter allocatedValue
+ Interface FreeTrialProperties no longer has parameter createdAt
+ Interface FreeTrialProperties no longer has parameter expiryAt
+ Interface FreeTrialProperties no longer has parameter percentageUsed
+ Interface FreeTrialProperties no longer has parameter usedValue
⚠️Warning [Logs] Generate from 70688bc4d3bf0b1ef56efbff23f51faef4d9d158. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr [automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
warn specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
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! 10.2.3 -> 10.4.0
cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.4.0>
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 AccountsOperations.check_name_availability
info [Changelog] - Added operation group AccountQuotasOperations
info [Changelog] - Model Account has a new parameter properties
info [Changelog] - Model AccountUpdate has a new parameter properties
info [Changelog] - Model Quota has a new parameter properties
info [Changelog]
info [Changelog] ### Breaking Changes
info [Changelog]
info [Changelog] - Model Account no longer has parameter dashboard_uri
info [Changelog] - Model Account no longer has parameter provisioning_state
info [Changelog] - Model Account no longer has parameter regional_affinity
info [Changelog] - Model Account no longer has parameter reporting
info [Changelog] - Model Account no longer has parameter scalable_execution
info [Changelog] - Model AccountUpdate no longer has parameter regional_affinity
info [Changelog] - Model AccountUpdate no longer has parameter reporting
info [Changelog] - Model AccountUpdate no longer has parameter scalable_execution
info [Changelog] - Model FreeTrialProperties no longer has parameter allocated_value
info [Changelog] - Model FreeTrialProperties no longer has parameter created_at
info [Changelog] - Model FreeTrialProperties no longer has parameter expiry_at
info [Changelog] - Model FreeTrialProperties no longer has parameter percentage_used
info [Changelog] - Model FreeTrialProperties no longer has parameter used_value
info [Changelog] - Model Quota no longer has parameter free_trial
info [Changelog] - Model Quota no longer has parameter provisioning_state
info [Changelog] - Operation AccountsOperations.begin_create_or_update has a new required parameter account_name
info [Changelog] - Operation AccountsOperations.begin_create_or_update no longer has parameter name
info [Changelog] - Operation AccountsOperations.begin_delete has a new required parameter account_name
info [Changelog] - Operation AccountsOperations.begin_delete no longer has parameter name
info [Changelog] - Operation AccountsOperations.get has a new required parameter account_name
info [Changelog] - Operation AccountsOperations.get no longer has parameter name
info [Changelog] - Operation AccountsOperations.update has a new required parameter account_name
info [Changelog] - Operation AccountsOperations.update no longer has parameter name
info [Changelog] - Operation QuotasOperations.get has a new required parameter quota_name
info [Changelog] - Operation QuotasOperations.get no longer has parameter name
️✔️Succeeded [Logs] Generate from 70688bc4d3bf0b1ef56efbff23f51faef4d9d158. 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
warn specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
info [Changelog] ### Breaking Changes
info [Changelog]
info [Changelog] - Field `AllocatedValue`, `CreatedAt`, `ExpiryAt`, `PercentageUsed`, `UsedValue` of struct `FreeTrialProperties` has been removed
info [Changelog]
info [Changelog] ### Features Added
info [Changelog]
info [Changelog] - New value `FreeTrialStateNotEligible`, `FreeTrialStateNotRegistered` added to enum type `FreeTrialState`
info [Changelog] - New value `ProvisioningStateCreating` added to enum type `ProvisioningState`
info [Changelog] - New enum type `CheckNameAvailabilityReason` with values `CheckNameAvailabilityReasonAlreadyExists`, `CheckNameAvailabilityReasonInvalid`
info [Changelog] - New function `NewAccountQuotasClient(string, azcore.TokenCredential, *arm.ClientOptions) (*AccountQuotasClient, error)`
info [Changelog] - New function `*AccountQuotasClient.Get(context.Context, string, string, QuotaNames, *AccountQuotasClientGetOptions) (AccountQuotasClientGetResponse, error)`
info [Changelog] - New function `*AccountQuotasClient.NewListByAccountPager(string, string, *AccountQuotasClientListByAccountOptions) *runtime.Pager[AccountQuotasClientListByAccountResponse]`
info [Changelog] - New function `*AccountsClient.CheckNameAvailability(context.Context, CheckNameAvailabilityRequest, *AccountsClientCheckNameAvailabilityOptions) (AccountsClientCheckNameAvailabilityResponse, error)`
info [Changelog] - New function `*ClientFactory.NewAccountQuotasClient() *AccountQuotasClient`
info [Changelog] - New struct `AccountFreeTrialProperties`
info [Changelog] - New struct `AccountQuota`
info [Changelog] - New struct `AccountQuotaListResult`
info [Changelog] - New struct `AccountQuotaProperties`
info [Changelog] - New struct `CheckNameAvailabilityRequest`
info [Changelog] - New struct `CheckNameAvailabilityResponse`
info [Changelog]
info [Changelog] Total 1 breaking change(s), 23 additive change(s).
️✔️Succeeded [Logs] Generate from 70688bc4d3bf0b1ef56efbff23f51faef4d9d158. 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] **Features**
info [Changelog]
info [Changelog] - Added operation group AccountQuotas
info [Changelog] - Added operation Accounts.checkNameAvailability
info [Changelog] - Added Interface AccountFreeTrialProperties
info [Changelog] - Added Interface AccountProperties
info [Changelog] - Added Interface AccountQuota
info [Changelog] - Added Interface AccountQuotaListResult
info [Changelog] - Added Interface AccountQuotaProperties
info [Changelog] - Added Interface AccountQuotasGetOptionalParams
info [Changelog] - Added Interface AccountQuotasListByAccountNextOptionalParams
info [Changelog] - Added Interface AccountQuotasListByAccountOptionalParams
info [Changelog] - Added Interface AccountsCheckNameAvailabilityOptionalParams
info [Changelog] - Added Interface AccountUpdateProperties
info [Changelog] - Added Interface CheckNameAvailabilityRequest
info [Changelog] - Added Interface CheckNameAvailabilityResponse
info [Changelog] - Added Interface QuotaProperties
info [Changelog] - Added Type Alias AccountQuotasGetResponse
info [Changelog] - Added Type Alias AccountQuotasListByAccountNextResponse
info [Changelog] - Added Type Alias AccountQuotasListByAccountResponse
info [Changelog] - Added Type Alias AccountsCheckNameAvailabilityResponse
info [Changelog] - Added Type Alias CheckNameAvailabilityReason
info [Changelog] - Interface Account has a new optional parameter properties
info [Changelog] - Interface AccountUpdate has a new optional parameter properties
info [Changelog] - Interface Quota has a new optional parameter properties
info [Changelog] - Added Enum KnownCheckNameAvailabilityReason
info [Changelog] - Enum KnownFreeTrialState has a new value NotEligible
info [Changelog] - Enum KnownFreeTrialState has a new value NotRegistered
info [Changelog] - Enum KnownProvisioningState has a new value Creating
info [Changelog]
info [Changelog] **Breaking Changes**
info [Changelog]
info [Changelog] - Interface Account no longer has parameter dashboardUri
info [Changelog] - Interface Account no longer has parameter provisioningState
info [Changelog] - Interface Account no longer has parameter regionalAffinity
info [Changelog] - Interface Account no longer has parameter reporting
info [Changelog] - Interface Account no longer has parameter scalableExecution
info [Changelog] - Interface AccountUpdate no longer has parameter regionalAffinity
info [Changelog] - Interface AccountUpdate no longer has parameter reporting
info [Changelog] - Interface AccountUpdate no longer has parameter scalableExecution
info [Changelog] - Interface FreeTrialProperties no longer has parameter allocatedValue
info [Changelog] - Interface FreeTrialProperties no longer has parameter createdAt
info [Changelog] - Interface FreeTrialProperties no longer has parameter expiryAt
info [Changelog] - Interface FreeTrialProperties no longer has parameter percentageUsed
info [Changelog] - Interface FreeTrialProperties no longer has parameter usedValue
info [Changelog] - Interface Quota no longer has parameter freeTrial
info [Changelog] - Interface Quota no longer has parameter provisioningState
⚠️Warning [Logs] Generate from 70688bc4d3bf0b1ef56efbff23f51faef4d9d158. SDK Automation 14.0.0
command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
warn specification/playwrighttesting/PlaywrightTesting.Management/tspconfig.yaml skipped due to azure-powershell not found in tspconfig.yaml
command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
Please address or respond to feedback from the ARM API reviewer. When you are ready to continue the ARM API review, please remove the ARMChangesRequested label. This will notify the reviewer to have another look. If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel. Please include [ARM Query] in the title of your question to indicate that it is ARM-related.
Hi @mjmadhu! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 (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.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
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:
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
Purpose of this PR
andDue diligence checklist
.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.and https://aka.ms/ci-fix.
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.