Merge release api management 2023 09 01 preview - Active #29184

solankisamir · 2024-05-21T16:07:02Z

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.

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:
- 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 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.

…023-05-01-preview to version 2023-09-01-preview

* WIP * Update sample * WIP * Add GatewayNameParameter * Clean up * Update sample * Add another sample * Add sample for delete gateway * Remove endpoints * Fix typo * Add list sample * Clean up Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Add disclaimer Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Make it pretty 💄 Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Refer to new file Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Add missing ApiManagementGatewayListResult Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Update sample reference Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Remove ApiManagementGatewayIdentity + List by operation Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Add more sample Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Latest version of common types Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Remove 200 for delete Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Formatting and re-order Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Align with spec Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Align sample with spec Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Error response from common types Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Rename SKU name * Have seperate SKU for patch to not make it mandatory * Remove empty required * Improve note * Rename schema * Remove unused type * sku.capacity should not be required --------- Signed-off-by: Tom Kerkhove <kerkhove.tom@gmail.com>

) * Add loggers to workspaces * Add diagnostics to workspace * Add certificates to workspace * Add backends to workspaces * Change DiagnosticContract to DiagnosticContractProperties in patch * Revert back DiagnosticContractProperties to DiagnosticContract * Fix CI and add files to readme * Fix example * remove reconnect endpoint * Add suppressions * Try different suppression where * Try different suppression * Try other suppression * another test * finally working suppression * remove unwanted line

* md cb contract * modify pool contract * correct the limits --------- Co-authored-by: Samir Solanki <samirsolanki@outlook.com>

* add operation statuses resource * fix api-version

* add operation results * fix spec * operationresults * fix file name

* new skutype * virtualNetworkType * remove default from patch * List skus API * add model for sku * caps enums

* added gateway config resource * removing Head gateway Config call * updates * resolving errors * trying to resolve more model validations * resolving some model validations * resolving model validations * resoloving delete example errors * Swagger Prettier * prettier * updating so patch has same response as get and put * removing path for gateway config * addressing comment * addressing comments * nit * path updatess * updating as per comments * Adding workspaceLinks * resolving some of the errors * resolved some errors * resolving some of the errors * resolving some more errors * npx prettier * addressing comments * updated based on comments * lint updates * nit updates --------- Co-authored-by: Samir Solanki <samirsolanki@outlook.com>

openapi-pipeline-app · 2024-05-21T16:07:07Z

PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

openapi-pipeline-app · 2024-05-21T16:07:08Z

PR validation pipeline restarted successfully. This comment will be populated with the 'Swagger Validation Report'

openapi-pipeline-app · 2024-05-21T16:07:08Z

PR validation pipeline restarted successfully. This comment will be populated with the 'Swagger Generation Artifacts' report

openapi-pipeline-app · 2024-05-21T16:07:09Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

solankisamir · 2024-05-30T23:08:07Z

Thanks @gary-x-li, @tomkerkhove can you work with the SDK for Go team to get signoff on
https://github.com/Azure/azure-rest-api-specs/pull/29184/checks?check_run_id=25609156492

[ERROR] error | PreCheck/DuplicateSchema | Duplicate Schema named 'ErrorResponse' (4 differences):

We should be good to merge then.

solankisamir · 2024-05-31T03:20:04Z

/pr RequestMerge

tomkerkhove · 2024-05-31T05:36:13Z

@solankisamir This will be fixed once we tackle #27012 for our next stable API version

gary-x-li · 2024-05-31T14:35:24Z

Can you please post a message in this channel regarding the azure-sdk-for-go failure? It's blocking the merge.

tomkerkhove · 2024-05-31T14:39:16Z

@gary-x-li This was already approved as part of #27757

tomkerkhove · 2024-05-31T14:43:03Z

Created https://teams.microsoft.com/l/message/19:104f00188bb64ef48d1b4d94ccb7a361@thread.skype/1717166574454?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1717166574454&teamName=Azure%20SDK&channelName=Language%20-%20Go&createdTime=1717166574454 regardless

Alancere · 2024-06-03T02:19:07Z

Hi @solankisamir, please fix Go CI issue: Duplicate Schema named 'ErrorResponse',
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" conflicts with ErrorResponse

solankisamir · 2024-06-03T04:02:55Z

Hi @solankisamir, please fix Go CI issue: Duplicate Schema named 'ErrorResponse', "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" conflicts with ErrorResponse

@tomkerkhove can you take a look at this?

…n schema

tomkerkhove · 2024-06-03T07:33:51Z

@Alancere The fix is in.

Go is now failing with the following error, but I have no clue how this name is determined:

client APIManagementGatewayClient was renamed to GatewayClient which collides with an existing client name

Likely this is because we already have a Gateway subresource of service which is unrelated to I'd say we need to tell the SDK to use another name than GatewayClient for our new top-level resource. Any guidance on this would be appreciated.

Alancere · 2024-06-03T08:55:49Z

@Alancere The fix is in.

Go is now failing with the following error, but I have no clue how this name is determined:
client APIManagementGatewayClient was renamed to GatewayClient which collides with an existing client name
Likely this is because we already have a Gateway subresource of service which is unrelated to I'd say we need to tell the SDK to use another name than GatewayClient for our new top-level resource. Any guidance on this would be appreciated.

When generating the GO SDK, the service name prefix(apimanagement) is removed, so APIManagementGateway will be renamed to Gateway, causing a conflict. Please use a better name.

…ed gateway" This reverts commit 8d4753d.

tomkerkhove · 2024-06-03T10:49:17Z

Commit 8d4753d fixes it but we have to rename the operation IDs which are used to define this after talking to @Alancere.

@solankisamir I have reverted this as we did not discuss it but please have a look at the suggestion and apply the commit again or use another prefix. We cannot use Gateway_ either given self-hosted gateway already relies on this.

I have already updated GatewayConfigConnection, though, to remove the ApiManagement prefix in 3e8197f as this is not supposed to be added

solankisamir and others added 12 commits January 3, 2024 07:35

Adds base for updating Microsoft.ApiManagement from version preview/2…

9fae00d

…023-05-01-preview to version 2023-09-01-preview

Updates readme

a3d7d4e

Updates API version in new specs and examples

7da91b7

remove secret examples (#28409)

18911f4

Modify CircuitBreaker and BackendPool Contract (#28397)

94e41b3

* md cb contract * modify pool contract * correct the limits --------- Co-authored-by: Samir Solanki <samirsolanki@outlook.com>

Common Error Response (#28408)

3bf0935

add operation statuses resource (#28591)

74f4309

* add operation statuses resource * fix api-version

Add locations/operationsResults endpoint for DELETE workflow (#28808)

203adb5

* add operation results * fix spec * operationresults * fix file name

feat(Workspace): Add new SkuType for Workspace (#28903)

18bed31

* new skutype * virtualNetworkType * remove default from patch * List skus API * add model for sku * caps enums

solankisamir added the 2023-09-01-apim Changes targetting 2023-09-01-preview for API Management label May 21, 2024

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

0e783e4

azure-sdk mentioned this pull request May 21, 2024

[AutoPR Azure.ResourceManager.ApiManagement] Merge release api management 2023 09 01 preview - Active azure-sdk/azure-sdk-for-net#8031

Draft

This was referenced May 21, 2024

[AutoPR @azure/arm-apimanagement] Merge release api management 2023 09 01 preview - Active azure-sdk/azure-sdk-for-js#9996

Draft

[AutoPR Az.apimanagement.DefaultTag] Merge release api management 2023 09 01 preview - Active azure-sdk/azure-powershell#6694

Draft

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

dd3a9f7

solankisamir changed the title ~~Merge release api management 2023 09 01 preview~~ Merge release api management 2023 09 01 preview - Active May 21, 2024

tomkerkhove assigned gary-x-li May 30, 2024

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

50216de

gary-x-li added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 30, 2024

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

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

f4096f3

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

4f1af3d

microsoft-github-policy-service bot added the MergeRequested Part of the ARM PR review workflow label May 31, 2024

solankisamir added 2 commits May 31, 2024 07:59

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

19bff23

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

1f7954f

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

6a8f682

tomkerkhove mentioned this pull request Jun 3, 2024

fix(apim): Remove duplicate ErrorResponse schema due to move to common schema #29299

Closed

5 tasks

fix(apim): Remove duplicate ErrorResponse schema due to move to commo…

5c2f871

…n schema

azure-sdk mentioned this pull request Jun 3, 2024

[AutoPR azure-mgmt-apimanagement] Merge release api management 2023 09 01 preview - Active azure-sdk/azure-sdk-for-python#7263

Draft

azure-sdk added the BreakingChange-Python-Sdk label Jun 3, 2024

Gateway -> ApiGateway to prevent SDK collision with self-hosted gateway

8d4753d

azure-sdk mentioned this pull request Jun 3, 2024

[AutoPR sdk/resourcemanager/apimanagement/armapimanagement] Merge release api management 2023 09 01 preview - Active azure-sdk/azure-sdk-for-go#9981

Draft

Revert "Gateway -> ApiGateway to prevent SDK collision with self-host…

3073226

…ed gateway" This reverts commit 8d4753d.

tomkerkhove and others added 2 commits June 3, 2024 11:55

Remove ApiManagement Prefix for GatewayConfigConnections

3e8197f

Merge branch 'main' into merge-release-ApiManagement-2023-09-01-preview

bf9cf3c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge release api management 2023 09 01 preview - Active #29184

Merge release api management 2023 09 01 preview - Active #29184

solankisamir commented May 21, 2024 •

edited by tomkerkhove

openapi-pipeline-app bot commented May 21, 2024 •

edited

openapi-pipeline-app bot commented May 21, 2024 •

edited

openapi-pipeline-app bot commented May 21, 2024 •

edited

openapi-pipeline-app bot commented May 21, 2024 •

edited

solankisamir commented May 30, 2024 •

edited

solankisamir commented May 31, 2024

tomkerkhove commented May 31, 2024

gary-x-li commented May 31, 2024

tomkerkhove commented May 31, 2024

tomkerkhove commented May 31, 2024

Alancere commented Jun 3, 2024 •

edited

solankisamir commented Jun 3, 2024

tomkerkhove commented Jun 3, 2024

Alancere commented Jun 3, 2024 •

edited

tomkerkhove commented Jun 3, 2024 •

edited

Merge release api management 2023 09 01 preview - Active #29184

Are you sure you want to change the base?

Merge release api management 2023 09 01 preview - Active #29184

Conversation

solankisamir commented May 21, 2024 • edited by tomkerkhove

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Additional information

Getting help

openapi-pipeline-app bot commented May 21, 2024 • edited

openapi-pipeline-app bot commented May 21, 2024 • edited

openapi-pipeline-app bot commented May 21, 2024 • edited

openapi-pipeline-app bot commented May 21, 2024 • edited

solankisamir commented May 30, 2024 • edited

solankisamir commented May 31, 2024

tomkerkhove commented May 31, 2024

gary-x-li commented May 31, 2024

tomkerkhove commented May 31, 2024

tomkerkhove commented May 31, 2024

Alancere commented Jun 3, 2024 • edited

solankisamir commented Jun 3, 2024

tomkerkhove commented Jun 3, 2024

Alancere commented Jun 3, 2024 • edited

tomkerkhove commented Jun 3, 2024 • edited

solankisamir commented May 21, 2024 •

edited by tomkerkhove

openapi-pipeline-app bot commented May 21, 2024 •

edited

openapi-pipeline-app bot commented May 21, 2024 •

edited

openapi-pipeline-app bot commented May 21, 2024 •

edited

openapi-pipeline-app bot commented May 21, 2024 •

edited

solankisamir commented May 30, 2024 •

edited

Alancere commented Jun 3, 2024 •

edited

Alancere commented Jun 3, 2024 •

edited

tomkerkhove commented Jun 3, 2024 •

edited