[Hub Generated] Publish private branch 'jakebillings/add-matching-resource-sync-rule' #19034

jake-billings · 2022-05-11T21:42:02Z

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

I am working on a change to modify the CustomLocations FindTargetResourceGroup action to return the matchedResourceSyncRule property.

I have also updated a few x-ms-identifiers fields we were missing.

ARM API Information (Control Plane)

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.

ASAP

When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.

May 2022

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- 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.

jake-billings · 2022-05-11T21:42:03Z

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/7120

openapi-workflow-bot · 2022-05-11T21:42:05Z

Hi, @jake-billings 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 · 2022-05-11T21:42:06Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.9.5)
- current:preview/2021-08-31-preview/customlocations.json compared with base:preview/2021-08-31-preview/customlocations.json

Rule	Message
`❌` 1040 - AddedReadOnlyPropertyInResponse	The new version has a new read-only property 'matchedResourceSyncRule' in response that was not found in the old version. New: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L904:7 Old: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L896:7

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- extendedlocation/resource-manager/readme.md tag:package-2021-08-31-preview
Linted configuring files (Based on target branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- extendedlocation/resource-manager/readme.md tag:package-2021-08-31-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'resourceSyncRules' with immediate parent 'customLocation', must have a list by immediate parent operation. Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L1151
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L948
⚠️ R4014 - AllResourcesMustHaveGetOperation	The resource 'EnabledResourceType' does not have get operation, please add it. Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L751
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Custom Location Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L395
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Custom Location Location: Microsoft.ExtendedLocation/preview/2021-08-31-preview/customlocations.json#L542

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

Validation passes for Avocado.

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

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

Validation passed for PoliCheck.

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

extendedlocation/resource-manager/readme.md#package-2021-08-31-preview

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

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

openapi-pipeline-app · 2022-05-11T21:42: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-go-track2 - armextendedlocation - 1.0.1
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-extendedlocation - 1.0.0
️✔️azure-sdk-for-go - extendedlocation/mgmt/2021-08-15/extendedlocation - v64.2.0
️✔️azure-sdk-for-go - preview/extendedlocation/mgmt/2021-08-31-preview/extendedlocation - v64.2.0
️✔️azure-sdk-for-go - preview/extendedlocation/mgmt/2021-03-15-preview/extendedlocation - v64.2.0

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

️✔️Succeeded [Logs]Release - Generate from e81add1. 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
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

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

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

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

️✔️track2_azure-mgmt-extendedlocation [View full logs] [Release SDK Changes]

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation CustomLocationsOperations.find_target_resource_group
info	[Changelog]   - Added operation group ResourceSyncRulesOperations

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

⚠️Warning [Logs]Release - Generate from e81add1. 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
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

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

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

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

command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️extendedlocation/mgmt/2021-08-15/extendedlocation [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️preview/extendedlocation/mgmt/2021-08-31-preview/extendedlocation [View full logs]
```
info	[Changelog] This is a new package
info	[Changelog]
```

️✔️preview/extendedlocation/mgmt/2021-03-15-preview/extendedlocation [View full logs]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

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

️✔️armextendedlocation [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

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

⚠️Warning [Logs]Release - Generate from e81add1. 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
cmderr	[automation_init.sh] deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
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-extendedlocation [View full logs] [Release SDK Changes]
- azure-arm-extendedlocation-1.0.0.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

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

️✔️Succeeded [Logs]Release - Generate from e81add1. 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.CustomLocations [View full logs] [Release SDK Changes]
- Az.CustomLocations.0.1.0.nupkg

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

openapi-workflow-bot · 2022-05-11T21:45:08Z

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.

openapi-workflow-bot · 2022-05-11T21:46:02Z

Hi, @jake-billings your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

tadelesh · 2022-05-24T01:49:46Z

/azp run

azure-pipelines · 2022-05-24T01:49:54Z

Azure Pipelines successfully started running 1 pipeline(s).

tadelesh · 2022-05-24T03:24:38Z

Already reviewed by this PR, approved and merged.

…ource-sync-rule' (#19034) * add matchingResourceSyncRule to CustomLocationsFindTargetResourceGroup * matching -> matched * add missing x-ms-identifiers fields * do a better job of fixing x-ms-identifiers identifier fields

jake-billings added 4 commits May 9, 2022 08:46

add matchingResourceSyncRule to CustomLocationsFindTargetResourceGroup

1965df5

matching -> matched

bf103da

add missing x-ms-identifiers fields

3e43c15

do a better job of fixing x-ms-identifiers identifier fields

3873c01

openapi-assignment-bot bot assigned tadelesh May 11, 2022

openapi-pipeline-app bot added the NewApiVersionRequired label May 11, 2022

openapi-workflow-bot bot added FixS360 ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 11, 2022

jake-billings closed this May 13, 2022

jake-billings reopened this May 20, 2022

azure-sdk mentioned this pull request May 20, 2022

[AutoPR Azure.ResourceManager.ExtendedLocation] [Hub Generated] Publish private branch 'jakebillings/add-matching-resource-sync-rule' azure-sdk/azure-sdk-for-net#133

Closed

tadelesh approved these changes May 24, 2022

View reviewed changes

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

tadelesh merged commit e81add1 into main May 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Hub Generated] Publish private branch 'jakebillings/add-matching-resource-sync-rule' #19034

[Hub Generated] Publish private branch 'jakebillings/add-matching-resource-sync-rule' #19034

jake-billings commented May 11, 2022 •

edited

Loading

jake-billings commented May 11, 2022

openapi-workflow-bot bot commented May 11, 2022

openapi-pipeline-app bot commented May 11, 2022 •

edited

Loading

openapi-pipeline-app bot commented May 11, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented May 11, 2022

openapi-workflow-bot bot commented May 11, 2022

tadelesh commented May 24, 2022

azure-pipelines bot commented May 24, 2022

tadelesh commented May 24, 2022

[Hub Generated] Publish private branch 'jakebillings/add-matching-resource-sync-rule' #19034

[Hub Generated] Publish private branch 'jakebillings/add-matching-resource-sync-rule' #19034

Conversation

jake-billings commented May 11, 2022 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

jake-billings commented May 11, 2022

openapi-workflow-bot bot commented May 11, 2022

openapi-pipeline-app bot commented May 11, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 11, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented May 11, 2022

openapi-workflow-bot bot commented May 11, 2022

tadelesh commented May 24, 2022

azure-pipelines bot commented May 24, 2022

tadelesh commented May 24, 2022

jake-billings commented May 11, 2022 •

edited

Loading

openapi-pipeline-app bot commented May 11, 2022 •

edited

Loading

openapi-pipeline-app bot commented May 11, 2022 •

edited

Loading