Adding support for child service configuration resource #23116

apmehrotra · 2023-03-15T22:01: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.
March
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
March
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
  -[X] 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.

…iew/2022-05-01-preview to version 2023-03-15

openapi-workflow-bot · 2023-03-15T22:01:06Z

Hi, @apmehrotra 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. [email protected]

openapi-pipeline-app · 2023-03-15T22:01:09Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️Breaking Change(Cross-Version): 1 Warnings warning [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
hybridconnectivity.json	2023-03-15(dfb7965)	2022-05-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Rule	Message
⚠️ 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: common-types/resource-management/v5/types.json#L413:9 Old: common-types/resource-management/v2/types.json#L438:9

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

There is no credential detected.

️⚠️LintDiff: 1 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2023-03	package-2023-03(dfb7965)	default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule	Message	Related RPC [For API reviewers]
⚠️ AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json#L878

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

Validation passes for Avocado.

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

Rule	Message
`❌` API Readiness check failed. Please make sure your service is deployed.	"code: InvalidResourceType, message: The resource type 'Operations' could not be found in the namespace 'Microsoft.HybridConnectivity' for api version '2023-03-15'. The supported api-versions are '2021-07-08-privatepreview, 2021-10-01-privatepreview, 2022-05-01-preview, 2021-10-06-preview, 2023-04-01-preview'."

️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]

Tag package-2023-03; Prod region: Not deployed; Canary region: Not deployed

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

️️✔️CadlAPIView 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.

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

Validation passes for Summary.

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

openapi-workflow-bot · 2023-03-15T22:01:09Z

Hi, @apmehrotra your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

openapi-pipeline-app · 2023-03-15T22:01:10Z

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 5f869da. 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.20230323.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from 5f869da. 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]  notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

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

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

️✔️Succeeded [Logs]Release - Generate from 5f869da. 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
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 5f869da. 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 `NewClientFactory(azcore.TokenCredential, *arm.ClientOptions) (*ClientFactory, error)`
info	[Changelog] - New function `*ClientFactory.NewEndpointsClient() *EndpointsClient`
info	[Changelog] - New function `*ClientFactory.NewOperationsClient() *OperationsClient`
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 `ClientFactory`
info	[Changelog] - New struct `ListCredentialsRequest`
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), 39 additive change(s).

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

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

❌hybridconnectivity/resource-manager [View full logs]

️️✔️ azure-powershell succeeded [Detail] [Expand]

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

️✔️Az.hybridconnectivity.DefaultTag [View full logs] [Release SDK Changes]
- Az.HybridConnectivityApi.0.1.0.nupkg

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

openapi-pipeline-app · 2023-03-15T22:01:11Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/hybridconnectivity/armhybridconnectivity	Create ApiView failed. Please ask PR assignee for help
Java	azure-resourcemanager-hybridconnectivity	https://apiview.dev/Assemblies/Review/ec60f7a965a44a80a4ad224e2abda7ce
.Net	Azure.ResourceManager.HybridConnectivity	https://apiview.dev/Assemblies/Review/88cf4a891b374419b0c86367808056e9
JavaScript	@azure/arm-hybridconnectivity	https://apiview.dev/Assemblies/Review/33e7691c068d40ecb107b6d6d9055d15

openapi-workflow-bot · 2023-03-15T22:09:08Z

Hi, @apmehrotra, 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. Or you could onboard API spec pipeline

custom-words.txt

...vity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json

* Adds base for updating Microsoft.HybridConnectivity from version preview/2022-05-01-preview to version 2023-03-15 * Updates readme * Updates API version in new specs and examples * Adding support for child service configuration resource * Addressing PR comments * Handling camel casing * Updating the examples * Addresing issues

apmehrotra and others added 4 commits March 15, 2023 14:50

Adds base for updating Microsoft.HybridConnectivity from version prev…

74d6c8b

…iew/2022-05-01-preview to version 2023-03-15

Updates readme

7f82940

Updates API version in new specs and examples

a4159d0

Adding support for child service configuration resource

e4556ac

openapi-assignment-bot bot assigned live1206 Mar 15, 2023

openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 15, 2023

apmehrotra changed the title ~~Apmehrotra hybridconnectivity microsoft.hybrid connectivity 2023 03 15 apoorv childresource~~ Adding support for child service configuration resource Mar 15, 2023

AzureRestAPISpecReview added CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS labels Mar 15, 2023

TimLovellSmith reviewed Mar 17, 2023

View reviewed changes

custom-words.txt Outdated Show resolved Hide resolved

TimLovellSmith reviewed Mar 17, 2023

View reviewed changes

...vity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json Outdated Show resolved Hide resolved

TimLovellSmith reviewed Mar 17, 2023

View reviewed changes

...vity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json Outdated Show resolved Hide resolved

TimLovellSmith reviewed Mar 17, 2023

View reviewed changes

...vity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json Outdated Show resolved Hide resolved

TimLovellSmith reviewed Mar 17, 2023

View reviewed changes

...vity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json Show resolved Hide resolved

apmehrotra force-pushed the apmehrotra-hybridconnectivity-Microsoft.HybridConnectivity-2023-03-15-apoorv-childresource branch from d3b0bcd to 576c43a Compare March 20, 2023 22:48

Handling camel casing

2955946

apmehrotra force-pushed the apmehrotra-hybridconnectivity-Microsoft.HybridConnectivity-2023-03-15-apoorv-childresource branch from 576c43a to 2955946 Compare March 20, 2023 23:03

openapi-pipeline-app bot added the CI-BreakingChange-Go label Mar 20, 2023

apmehrotra force-pushed the apmehrotra-hybridconnectivity-Microsoft.HybridConnectivity-2023-03-15-apoorv-childresource branch 3 times, most recently from 521794c to fe102f7 Compare March 21, 2023 00:05

Updating the examples

30046ba

apmehrotra force-pushed the apmehrotra-hybridconnectivity-Microsoft.HybridConnectivity-2023-03-15-apoorv-childresource branch from fe102f7 to 30046ba Compare March 21, 2023 00:39

AzureRestAPISpecReview added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 21, 2023

apmehrotra removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 21, 2023

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 21, 2023

apmehrotra requested a review from TimLovellSmith March 21, 2023 15:50

apmehrotra force-pushed the apmehrotra-hybridconnectivity-Microsoft.HybridConnectivity-2023-03-15-apoorv-childresource branch from 13995fb to c816f12 Compare March 21, 2023 17:08

Addresing issues

dfb7965

apmehrotra force-pushed the apmehrotra-hybridconnectivity-Microsoft.HybridConnectivity-2023-03-15-apoorv-childresource branch from c816f12 to dfb7965 Compare March 22, 2023 19:43

azure-sdk mentioned this pull request Mar 22, 2023

[AutoPR Az.hybridconnectivity.DefaultTag] Adding support for child service configuration resource azure-sdk/azure-powershell#4913

Closed

raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Mar 22, 2023

openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 22, 2023

live1206 approved these changes Mar 23, 2023

View reviewed changes

live1206 merged commit 5f869da into main Mar 23, 2023

live1206 deleted the apmehrotra-hybridconnectivity-Microsoft.HybridConnectivity-2023-03-15-apoorv-childresource branch March 23, 2023 04:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding support for child service configuration resource #23116

Adding support for child service configuration resource #23116

apmehrotra commented Mar 15, 2023

openapi-workflow-bot bot commented Mar 15, 2023

openapi-pipeline-app bot commented Mar 15, 2023 •

edited

Loading

openapi-workflow-bot bot commented Mar 15, 2023

openapi-pipeline-app bot commented Mar 15, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Mar 15, 2023 •

edited

Loading

openapi-workflow-bot bot commented Mar 15, 2023

Adding support for child service configuration resource #23116

Adding support for child service configuration resource #23116

Conversation

apmehrotra commented Mar 15, 2023

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Mar 15, 2023

openapi-pipeline-app bot commented Mar 15, 2023 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Mar 15, 2023

openapi-pipeline-app bot commented Mar 15, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Mar 15, 2023 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Mar 15, 2023

openapi-pipeline-app bot commented Mar 15, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 15, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 15, 2023 •

edited

Loading