Automation/locations api 2024 preview #29961

dhruvesh · 2024-07-25T06:26:31Z

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

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

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!

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:
- edit this with your clarification

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.
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 PR workflow diagram Step 2 (ARM review), 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.

2. updated in readme

2. Add object type of definitions 3. Updated with error response type

openapi-pipeline-app · 2024-07-25T06:26:35Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This is the public specs repo main branch which is not intended for iterative development.
You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
If this is what you intend, add PublishToCustomers label to your PR.
Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
❌ The required check named SDK azure-sdk-for-go has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 3 in the PR workflow diagram

openapi-pipeline-app · 2024-07-25T06:26:35Z

Generated ApiView

Language	Package Name	ApiView Link
JavaScript	@azure/arm-automation	https://apiview.dev/Assemblies/Review/96f003ba012746828eb56c3795863cc4?revisionId=2b3be12ca18d492bbe46dc3d96ccd0fa
Swagger	Microsoft.Automation	https://apiview.dev/Assemblies/Review/00db6caae22e42bf881f05eae1a48849?revisionId=9c86126d635c443c8e41d91b1705eb2e

…into automation/locations-api-2024-preview

dhruvesh · 2024-07-25T09:21:35Z

body-top-level-properties is contraditing with xms-pageable-for-list-calls rule. ARM Reviewer please correct this rule

ajaygit158 · 2024-07-29T08:58:56Z

...n/automation/resource-manager/Microsoft.Automation/preview/2024-08-01-preview/locations.json

+        },
+        "parameters": [
+          {
+            "name": "locationName",


Can we reference LocationParameter from common-types ?

azure-rest-api-specs/specification/common-types/resource-management/v6/types.json

Line 655 in a651ba2

"LocationParameter": {

Makes sense done the changes

ajaygit158 · 2024-07-29T09:06:48Z

...n/automation/resource-manager/Microsoft.Automation/preview/2024-08-01-preview/locations.json

+          }
+        },
+        "x-ms-pageable": {
+          "nextLinkName": null,


Why is this set to null?

we don't want to paginate here

ajaygit158 · 2024-07-29T09:09:21Z

...ce-manager/Microsoft.Automation/preview/2024-08-01-preview/examples/getUsagesOfLocation.json

+        "value": [
+          {
+            "name": {
+              "value": "BasicRegionalAutomationAccounts",


Can you add what will be the value of Id here

This we want to keep dynamic, the value will change based on localization

ajaygit158 · 2024-07-29T09:10:32Z

...n/automation/resource-manager/Microsoft.Automation/preview/2024-08-01-preview/locations.json

+          "description": "Gets or sets the id of the resource."
+        },
+        "name": {
+          "$ref": "#/definitions/UsageCounterName",


Candidates for Enum

This we want to keep dynamic, the value will change based on localization

ajaygit158 · 2024-07-29T09:11:10Z

...n/automation/resource-manager/Microsoft.Automation/preview/2024-08-01-preview/locations.json

+        "throttleStatus": {
+          "type": "string",
+          "description": "Gets or sets the throttle  status."
+        }


This also looks like a candidate for enum

Sure will make the changes

ajaygit158

Added a couple of comments.

…eview' into automation/locations-api-2024-preview

viveksheelsingh · 2024-07-27T04:42:55Z

...ce-manager/Microsoft.Automation/preview/2024-08-01-preview/examples/getUsagesOfLocation.json

@@ -0,0 +1,26 @@
+{
+  "parameters": {
+    "subscriptionId": "subid",


its better to use a guid here, to illustrate the real format

viveksheelsingh · 2024-07-27T05:12:53Z

...n/automation/resource-manager/Microsoft.Automation/preview/2024-08-01-preview/locations.json

+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Gets or sets the id of the resource."


you dont have a PUT on this ... I see only a GET above ?

All the Usage properties should be readonly ?

ajaygit158

Please work with the SDK team on the Go SDK failure.

microsoft-github-policy-service · 2024-08-26T01:41:19Z

Hi, @dhruvesh. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

microsoft-github-policy-service · 2024-09-09T13:24:45Z

Hi, @dhruvesh. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

Dhruvesh Parikh and others added 12 commits July 18, 2024 21:55

Locations API exposed at Subscription level

dc85021

Locations API exposed at Subscription level

89ec162

Merge branch 'main' into dhruvesh/locations-api

27e6197

Removing changes from stable version

fb994e8

Removing changes from stable version

02b7516

1. removing resource group name from locations api

bd40ccf

2. updated in readme

1. Adding location name pattern

b3779a5

2. Add object type of definitions 3. Updated with error response type

added new preview version

fb3082a

added new preview version

999cb03

added new preview version

434bca0

added new preview version

b0b70c8

added new preview version

f5b643e

Merge branch 'main' of https://github.com/Azure/azure-rest-api-specs …

8739086

…into automation/locations-api-2024-preview

This was referenced Jul 25, 2024

[AutoPR Azure.ResourceManager.Automation] Automation/locations api 2024 preview azure-sdk/azure-sdk-for-net#8540

Closed

[AutoPR @azure/arm-automation] Automation/locations api 2024 preview azure-sdk/azure-sdk-for-js#10803

Closed

AzureRestAPISpecReview added ARMReview new-api-version resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 25, 2024

azure-sdk mentioned this pull request Jul 25, 2024

[AutoPR azure-mgmt-automation] Automation/locations api 2024 preview azure-sdk/azure-sdk-for-python#7753

Closed

honoring: BodyTopLevelProperties

a2d9b3b

azure-sdk mentioned this pull request Jul 25, 2024

[AutoPR Az.automation.DefaultTag] Automation/locations api 2024 preview azure-sdk/azure-powershell#7279

Closed

dhruvesh added 6 commits July 25, 2024 12:34

honoring: CollectionObjectPropertiesNaming

2d1d72b

AutoRest exception

b3ee006

Locations pageable extension

65c2554

Locations pageable extension

50fe19a

fixed the example

8ec19a2

updated reference in readme.md

a0c02f9

added required property value

664aace

dhruvesh added the AzCoreIDC label Jul 25, 2024

Merge branch 'main' into automation/locations-api-2024-preview

d073098

ajaygit158 reviewed Jul 29, 2024

View reviewed changes

ajaygit158 requested changes Jul 29, 2024

View reviewed changes

ajaygit158 added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 29, 2024

dhruvesh mentioned this pull request Jul 29, 2024

The BodyTopLevelProperties rule is mistakenly flagging paged responses Azure/azure-openapi-validator#722

Open

dhruvesh added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Jul 29, 2024

dhruvesh added 5 commits July 29, 2024 18:44

reusing already defined type

46dd177

Merge remote-tracking branch 'origin/automation/locations-api-2024-pr…

dd90e1c

…eview' into automation/locations-api-2024-preview

reusing already defined type

7196123

npx prettier

d95f8e8

update location parameter in uri

407be69

viveksheelsingh reviewed Jul 30, 2024

View reviewed changes

update location parameter in uri

c5ebfed

AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Jul 30, 2024

ajaygit158 approved these changes Jul 30, 2024

View reviewed changes

ajaygit158 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jul 30, 2024

openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 30, 2024

microsoft-github-policy-service bot added the no-recent-activity There has been no recent activity on this issue. label Aug 26, 2024

microsoft-github-policy-service bot closed this Sep 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automation/locations api 2024 preview #29961

Automation/locations api 2024 preview #29961

dhruvesh commented Jul 25, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 25, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 25, 2024 •

edited

Loading

dhruvesh commented Jul 25, 2024 •

edited

Loading

ajaygit158 Jul 29, 2024

dhruvesh Jul 29, 2024

ajaygit158 Jul 29, 2024

dhruvesh Jul 29, 2024

ajaygit158 Jul 29, 2024

dhruvesh Jul 29, 2024

ajaygit158 Jul 29, 2024

dhruvesh Jul 29, 2024

ajaygit158 Jul 29, 2024

dhruvesh Jul 29, 2024

dhruvesh Jul 29, 2024

ajaygit158 left a comment

viveksheelsingh Jul 27, 2024

viveksheelsingh Jul 27, 2024

viveksheelsingh Jul 30, 2024

ajaygit158 left a comment

microsoft-github-policy-service bot commented Aug 26, 2024

microsoft-github-policy-service bot commented Sep 9, 2024

Automation/locations api 2024 preview #29961

Automation/locations api 2024 preview #29961

Conversation

dhruvesh commented Jul 25, 2024 • edited Loading

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Diagram footnotes

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented Jul 25, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Jul 25, 2024 • edited Loading

Generated ApiView

dhruvesh commented Jul 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajaygit158 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ajaygit158 left a comment

Choose a reason for hiding this comment

microsoft-github-policy-service bot commented Aug 26, 2024

microsoft-github-policy-service bot commented Sep 9, 2024

dhruvesh commented Jul 25, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 25, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jul 25, 2024 •

edited

Loading

dhruvesh commented Jul 25, 2024 •

edited

Loading