Add "serviceName" to ListIngressGatewayCredentialsRequest #23819

pruthvidhodda · 2023-05-04T20:12:02Z

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:

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

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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

openapi-pipeline-app · 2023-05-04T20:12:06Z

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
hybridconnectivity.json	2023-03-15(d328347)	2023-03-15(main)

Rule	Message
`❌` 1043 - AddingOptionalParameter	The optional parameter 'ListIngressGatewayCredentialsRequest' was added in the new version. New: Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json#L640:11

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.1)	new version	base version
package-2023-03	package-2023-03(d328347)	package-2023-03(main)

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json#L886

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2023-05-04T20:12:06Z

Hi, @pruthvidhodda Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

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. vscswagger@microsoft.com

openapi-pipeline-app · 2023-05-04T20:12:07Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 17aa6a1. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.HybridConnectivity [View full logs] [Release SDK Changes]
- Azure.ResourceManager.HybridConnectivity.1.0.0-alpha.20230508.1.nupkg
```
info	[Changelog]
```

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 17aa6a1. 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] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.6
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.6` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-hybridconnectivity [View full logs] [Release SDK Changes]
- azure_mgmt_hybridconnectivity-1.0.0b1-py3-none-any.whl
- azure-mgmt-hybridconnectivity-1.0.0b1.zip
```
info	[Changelog]   - Initial Release
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 17aa6a1. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-hybridconnectivity [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 17aa6a1. 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
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/hybridconnectivity/armhybridconnectivity [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New enum type `ProvisioningState` with values `ProvisioningStateCanceled`, `ProvisioningStateCreating`, `ProvisioningStateFailed`, `ProvisioningStateSucceeded`, `ProvisioningStateUpdating`
info	[Changelog] - New enum type `ServiceName` with values `ServiceNameSSH`, `ServiceNameWAC`
info	[Changelog] - New function `*ClientFactory.NewServiceConfigurationsClient() *ServiceConfigurationsClient`
info	[Changelog] - New function `*EndpointsClient.ListIngressGatewayCredentials(context.Context, string, string, *EndpointsClientListIngressGatewayCredentialsOptions) (EndpointsClientListIngressGatewayCredentialsResponse, error)`
info	[Changelog] - New function `NewServiceConfigurationsClient(azcore.TokenCredential, *arm.ClientOptions) (*ServiceConfigurationsClient, error)`
info	[Changelog] - New function `*ServiceConfigurationsClient.CreateOrupdate(context.Context, string, string, string, ServiceConfigurationResource, *ServiceConfigurationsClientCreateOrupdateOptions) (ServiceConfigurationsClientCreateOrupdateResponse, error)`
info	[Changelog] - New function `*ServiceConfigurationsClient.Delete(context.Context, string, string, string, *ServiceConfigurationsClientDeleteOptions) (ServiceConfigurationsClientDeleteResponse, error)`
info	[Changelog] - New function `*ServiceConfigurationsClient.Get(context.Context, string, string, string, *ServiceConfigurationsClientGetOptions) (ServiceConfigurationsClientGetResponse, error)`
info	[Changelog] - New function `*ServiceConfigurationsClient.NewListByEndpointResourcePager(string, string, *ServiceConfigurationsClientListByEndpointResourceOptions) *runtime.Pager[ServiceConfigurationsClientListByEndpointResourceResponse]`
info	[Changelog] - New function `*ServiceConfigurationsClient.Update(context.Context, string, string, string, ServiceConfigurationResourcePatch, *ServiceConfigurationsClientUpdateOptions) (ServiceConfigurationsClientUpdateResponse, error)`
info	[Changelog] - New struct `ListCredentialsRequest`
info	[Changelog] - New struct `ListIngressGatewayCredentialsRequest`
info	[Changelog] - New struct `ServiceConfigurationList`
info	[Changelog] - New struct `ServiceConfigurationProperties`
info	[Changelog] - New struct `ServiceConfigurationPropertiesPatch`
info	[Changelog] - New struct `ServiceConfigurationResource`
info	[Changelog] - New struct `ServiceConfigurationResourcePatch`
info	[Changelog] - New field `ListCredentialsRequest` in struct `EndpointsClientListCredentialsOptions`
info	[Changelog] - New field `ServiceName` in struct `ManagedProxyRequest`
info	[Changelog] - New field `SystemData` in struct `ProxyResource`
info	[Changelog] - New field `ServiceConfigurationToken` in struct `RelayNamespaceAccessProperties`
info	[Changelog] - New field `SystemData` in struct `Resource`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 36 additive change(s).

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 17aa6a1. 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

️✔️@azure/arm-hybridconnectivity [View full logs] [Release SDK Changes]
- azure-arm-hybridconnectivity-1.0.0.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️❌ azure-resource-manager-schemas failed [Detail]

❌Failed [Logs]Release - Generate from 17aa6a1. 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]
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

❌hybridconnectivity/resource-manager [View full logs]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from 17aa6a1. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

️✔️Az.hybridconnectivity.DefaultTag [View full logs]

Az.HybridConnectivityApi.0.1.0.nupkg

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.hybridconnectivity.DefaultTag

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-05-04T20:12:07Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/hybridconnectivity/armhybridconnectivity	https://apiview.dev/Assemblies/Review/76dd5372d61848a28e137f6fd7f8ce7f
Java	azure-resourcemanager-hybridconnectivity	https://apiview.dev/Assemblies/Review/568ad58020164bb7b0dff94869f7f313
.Net	Azure.ResourceManager.HybridConnectivity	https://apiview.dev/Assemblies/Review/b4332dec5cc9418da9f92d1d8795e30e
JavaScript	@azure/arm-hybridconnectivity	https://apiview.dev/Assemblies/Review/75dbd719db2d431d8b6b624eca318c85

openapi-workflow-bot · 2023-05-04T20:19:50Z

NewApiVersionRequired reason:

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.

pruthvidhodda · 2023-05-04T20:23:13Z

@JackTn this API is consumed by our Azure first party partner teams and the service side changes for this particular API for version (2023-03-15) is not rolled out yet. We also didn't announce this new API version to our partner team that uses it and confirmed with them that it is not being used.

Would this data be enough to ignore the Swagger BreakingChange check? Let me know if you need further clarification on this.

JackTn · 2023-05-05T07:45:53Z

/azp run

azure-pipelines · 2023-05-05T07:46:02Z

Azure Pipelines successfully started running 1 pipeline(s).

JackTn · 2023-05-05T08:05:36Z

@JackTn this API is consumed by our Azure first party partner teams and the service side changes for this particular API for version (2023-03-15) is not rolled out yet. We also didn't announce this new API version to our partner team that uses it and confirmed with them that it is not being used.

Would this data be enough to ignore the Swagger BreakingChange check? Let me know if you need further clarification on this.

@mikekistler can you review this breaking change? This is a new version that has no release yet!

mikekistler · 2023-05-05T16:34:35Z

This is a new version that has no release yet!

Please do not merge API definitions to main in the public repo until they are ready to release. If you are still developing/testing this API then we should hold off merging this PR until all the changes are done. Ping me when you are ready to release and I'll review any breaking changes at that point.

pruthvidhodda · 2023-05-05T18:50:14Z

This is a new version that has no release yet!

Please do not merge API definitions to main in the public repo until they are ready to release. If you are still developing/testing this API then we should hold off merging this PR until all the changes are done. Ping me when you are ready to release and I'll review any breaking changes at that point.

@mikekistler the PR(link) for this API in our service is now ready to be merged and rolled out.

mikekistler · 2023-05-05T22:37:06Z

@pruthvidhodda Okay, I'll give you a mulligan this time. But going forward, please do not merge any API definition to main until it is thoroughly tested and ready to release.

JackTn · 2023-05-06T07:38:23Z

approved

JackTn · 2023-05-06T07:39:30Z

@msyyc take a look on this pr and can you merge it ? Thanks

pruthvidhodda · 2023-05-08T17:14:24Z

Thanks @mikekistler . Will not happen again.

Add "serviceName" to ListIngressGatewayCredentialsRequest

d328347

openapi-assignment-bot bot assigned JackTn May 4, 2023

azure-sdk mentioned this pull request May 4, 2023

[AutoPR sdk/resourcemanager/hybridconnectivity/armhybridconnectivity] Add "serviceName" to ListIngressGatewayCredentialsRequest azure-sdk/azure-sdk-for-go#5570

Closed

AzureRestAPISpecReview added NewApiVersionRequired resource-manager RPaaS labels May 4, 2023

azure-sdk mentioned this pull request May 4, 2023

[AutoPR Azure.ResourceManager.HybridConnectivity] Add "serviceName" to ListIngressGatewayCredentialsRequest azure-sdk/azure-sdk-for-net#3772

Closed

JackTn requested a review from mikekistler May 5, 2023 08:05

mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 5, 2023

JackTn added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 6, 2023

msyyc approved these changes May 8, 2023

View reviewed changes

msyyc merged commit 17aa6a1 into main May 8, 2023

msyyc deleted the pruthvidhodda-hybridconnectivity-Microsoft.HybridConnectivity-2023-03-15-listIngressGatewayCredentials-main branch May 8, 2023 02:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "serviceName" to ListIngressGatewayCredentialsRequest #23819

Add "serviceName" to ListIngressGatewayCredentialsRequest #23819

pruthvidhodda commented May 4, 2023

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 4, 2023

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

openapi-workflow-bot bot commented May 4, 2023

pruthvidhodda commented May 4, 2023

JackTn commented May 5, 2023

azure-pipelines bot commented May 5, 2023

JackTn commented May 5, 2023

mikekistler commented May 5, 2023

pruthvidhodda commented May 5, 2023

mikekistler commented May 5, 2023

JackTn commented May 6, 2023

JackTn commented May 6, 2023

pruthvidhodda commented May 8, 2023

Add "serviceName" to ListIngressGatewayCredentialsRequest #23819

Add "serviceName" to ListIngressGatewayCredentialsRequest #23819

Conversation

pruthvidhodda commented May 4, 2023

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented May 4, 2023 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented May 4, 2023

openapi-pipeline-app bot commented May 4, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented May 4, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented May 4, 2023

pruthvidhodda commented May 4, 2023

JackTn commented May 5, 2023

azure-pipelines bot commented May 5, 2023

JackTn commented May 5, 2023

mikekistler commented May 5, 2023

pruthvidhodda commented May 5, 2023

mikekistler commented May 5, 2023

JackTn commented May 6, 2023

JackTn commented May 6, 2023

pruthvidhodda commented May 8, 2023

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 4, 2023 •

edited

Loading