azure-rest-api-specs Azure RedHat OpenShift 2022-09-04

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
- [x] 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. September 7th
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. September 20th
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):

[x] I commit to follow the Breaking Change Policy of "no breaking changes"
[x] 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: :warning:

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:

[x] 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.
[x] 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.
[x] 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.

Aug 30 '22 02:08 ross-bryan

Hi, @ross-bryan 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]

Aug 30 '22 02:08 openapi-workflow-bot[bot]

Swagger Validation Report

️🔄BreakingChange inProgress [Detail]

️🔄Breaking Change(Cross-Version) inProgress [Detail]

️⌛CredScan pending [Detail]

️🔄LintDiff inProgress [Detail]

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

Validation passes for Avocado.

️🔄ApiReadinessCheck inProgress [Detail]

️🔄~[Staging] ServiceAPIReadinessTest inProgress [Detail]

️🔄~[Staging] TrafficValidation inProgress [Detail]

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️⌛PoliCheck pending [Detail]

️🔄SDK Track2 Validation inProgress [Detail]

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

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

Aug 30 '22 02:08 openapi-pipeline-app[bot]

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-python-track2 warning [Detail]

⚠️Warning [Logs] Generate from e40029494a55fff992b833f8cbd7183c306d1b16. 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! 8.15.0 -> 8.19.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice
warn	No file changes detected after generation
warn	No package detected after generation

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

️✔️Succeeded [Logs] Generate from e40029494a55fff992b833f8cbd7183c306d1b16. 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/redhatopenshift/armredhatopenshift [View full logs] [Preview SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New function `*SyncSetsClient.Update(context.Context, string, string, string, SyncSetUpdate, *SyncSetsClientUpdateOptions) (SyncSetsClientUpdateResponse, error)`
info	[Changelog] - New function `*MachinePoolsClient.Delete(context.Context, string, string, string, *MachinePoolsClientDeleteOptions) (MachinePoolsClientDeleteResponse, error)`
info	[Changelog] - New function `*SyncSetsClient.NewListPager(string, string, *SyncSetsClientListOptions) *runtime.Pager[SyncSetsClientListResponse]`
info	[Changelog] - New function `NewOpenShiftVersionsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*OpenShiftVersionsClient, error)`
info	[Changelog] - New function `*SyncSetsClient.Delete(context.Context, string, string, string, *SyncSetsClientDeleteOptions) (SyncSetsClientDeleteResponse, error)`
info	[Changelog] - New function `*SecretsClient.Update(context.Context, string, string, string, SecretUpdate, *SecretsClientUpdateOptions) (SecretsClientUpdateResponse, error)`
info	[Changelog] - New function `*OpenShiftVersionsClient.NewListPager(string, *OpenShiftVersionsClientListOptions) *runtime.Pager[OpenShiftVersionsClientListResponse]`
info	[Changelog] - New function `NewSecretsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SecretsClient, error)`
info	[Changelog] - New function `NewSyncIdentityProvidersClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SyncIdentityProvidersClient, error)`
info	[Changelog] - New function `*MachinePoolsClient.CreateOrUpdate(context.Context, string, string, string, MachinePool, *MachinePoolsClientCreateOrUpdateOptions) (MachinePoolsClientCreateOrUpdateResponse, error)`
info	[Changelog] - New function `*SyncIdentityProvidersClient.NewListPager(string, string, *SyncIdentityProvidersClientListOptions) *runtime.Pager[SyncIdentityProvidersClientListResponse]`
info	[Changelog] - New function `*SyncIdentityProvidersClient.CreateOrUpdate(context.Context, string, string, string, SyncIdentityProvider, *SyncIdentityProvidersClientCreateOrUpdateOptions) (SyncIdentityProvidersClientCreateOrUpdateResponse, error)`
info	[Changelog] - New function `*SyncSetsClient.CreateOrUpdate(context.Context, string, string, string, SyncSet, *SyncSetsClientCreateOrUpdateOptions) (SyncSetsClientCreateOrUpdateResponse, error)`
info	[Changelog] - New function `*SecretsClient.Delete(context.Context, string, string, string, *SecretsClientDeleteOptions) (SecretsClientDeleteResponse, error)`
info	[Changelog] - New function `*MachinePoolsClient.Get(context.Context, string, string, string, *MachinePoolsClientGetOptions) (MachinePoolsClientGetResponse, error)`
info	[Changelog] - New function `*SyncIdentityProvidersClient.Update(context.Context, string, string, string, SyncIdentityProviderUpdate, *SyncIdentityProvidersClientUpdateOptions) (SyncIdentityProvidersClientUpdateResponse, error)`
info	[Changelog] - New function `*MachinePoolsClient.NewListPager(string, string, *MachinePoolsClientListOptions) *runtime.Pager[MachinePoolsClientListResponse]`
info	[Changelog] - New function `*SyncIdentityProvidersClient.Delete(context.Context, string, string, string, *SyncIdentityProvidersClientDeleteOptions) (SyncIdentityProvidersClientDeleteResponse, error)`
info	[Changelog] - New function `NewSyncSetsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SyncSetsClient, error)`
info	[Changelog] - New function `NewMachinePoolsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*MachinePoolsClient, error)`
info	[Changelog] - New function `*SecretsClient.CreateOrUpdate(context.Context, string, string, string, Secret, *SecretsClientCreateOrUpdateOptions) (SecretsClientCreateOrUpdateResponse, error)`
info	[Changelog] - New function `*SecretsClient.Get(context.Context, string, string, string, *SecretsClientGetOptions) (SecretsClientGetResponse, error)`
info	[Changelog] - New function `*MachinePoolsClient.Update(context.Context, string, string, string, MachinePoolUpdate, *MachinePoolsClientUpdateOptions) (MachinePoolsClientUpdateResponse, error)`
info	[Changelog] - New function `*SecretsClient.NewListPager(string, string, *SecretsClientListOptions) *runtime.Pager[SecretsClientListResponse]`
info	[Changelog] - New function `*SyncSetsClient.Get(context.Context, string, string, string, *SyncSetsClientGetOptions) (SyncSetsClientGetResponse, error)`
info	[Changelog] - New function `*SyncIdentityProvidersClient.Get(context.Context, string, string, string, *SyncIdentityProvidersClientGetOptions) (SyncIdentityProvidersClientGetResponse, error)`
info	[Changelog] - New struct `MachinePool`
info	[Changelog] - New struct `MachinePoolList`
info	[Changelog] - New struct `MachinePoolProperties`
info	[Changelog] - New struct `MachinePoolUpdate`
info	[Changelog] - New struct `MachinePoolsClient`
info	[Changelog] - New struct `MachinePoolsClientCreateOrUpdateOptions`
info	[Changelog] - New struct `MachinePoolsClientCreateOrUpdateResponse`
info	[Changelog] - New struct `MachinePoolsClientDeleteOptions`
info	[Changelog] - New struct `MachinePoolsClientDeleteResponse`
info	[Changelog] - New struct `MachinePoolsClientGetOptions`
info	[Changelog] - New struct `MachinePoolsClientGetResponse`
info	[Changelog] - New struct `MachinePoolsClientListOptions`
info	[Changelog] - New struct `MachinePoolsClientListResponse`
info	[Changelog] - New struct `MachinePoolsClientUpdateOptions`
info	[Changelog] - New struct `MachinePoolsClientUpdateResponse`
info	[Changelog] - New struct `OpenShiftVersion`
info	[Changelog] - New struct `OpenShiftVersionList`
info	[Changelog] - New struct `OpenShiftVersionProperties`
info	[Changelog] - New struct `OpenShiftVersionsClient`
info	[Changelog] - New struct `OpenShiftVersionsClientListOptions`
info	[Changelog] - New struct `OpenShiftVersionsClientListResponse`
info	[Changelog] - New struct `ProxyResource`
info	[Changelog] - New struct `Secret`
info	[Changelog] - New struct `SecretList`
info	[Changelog] - New struct `SecretProperties`
info	[Changelog] - New struct `SecretUpdate`
info	[Changelog] - New struct `SecretsClient`
info	[Changelog] - New struct `SecretsClientCreateOrUpdateOptions`
info	[Changelog] - New struct `SecretsClientCreateOrUpdateResponse`
info	[Changelog] - New struct `SecretsClientDeleteOptions`
info	[Changelog] - New struct `SecretsClientDeleteResponse`
info	[Changelog] - New struct `SecretsClientGetOptions`
info	[Changelog] - New struct `SecretsClientGetResponse`
info	[Changelog] - New struct `SecretsClientListOptions`
info	[Changelog] - New struct `SecretsClientListResponse`
info	[Changelog] - New struct `SecretsClientUpdateOptions`
info	[Changelog] - New struct `SecretsClientUpdateResponse`
info	[Changelog] - New struct `SyncIdentityProvider`
info	[Changelog] - New struct `SyncIdentityProviderList`
info	[Changelog] - New struct `SyncIdentityProviderProperties`
info	[Changelog] - New struct `SyncIdentityProviderUpdate`
info	[Changelog] - New struct `SyncIdentityProvidersClient`
info	[Changelog] - New struct `SyncIdentityProvidersClientCreateOrUpdateOptions`
info	[Changelog] - New struct `SyncIdentityProvidersClientCreateOrUpdateResponse`
info	[Changelog] - New struct `SyncIdentityProvidersClientDeleteOptions`
info	[Changelog] - New struct `SyncIdentityProvidersClientDeleteResponse`
info	[Changelog] - New struct `SyncIdentityProvidersClientGetOptions`
info	[Changelog] - New struct `SyncIdentityProvidersClientGetResponse`
info	[Changelog] - New struct `SyncIdentityProvidersClientListOptions`
info	[Changelog] - New struct `SyncIdentityProvidersClientListResponse`
info	[Changelog] - New struct `SyncIdentityProvidersClientUpdateOptions`
info	[Changelog] - New struct `SyncIdentityProvidersClientUpdateResponse`
info	[Changelog] - New struct `SyncSet`
info	[Changelog] - New struct `SyncSetList`
info	[Changelog] - New struct `SyncSetProperties`
info	[Changelog] - New struct `SyncSetUpdate`
info	[Changelog] - New struct `SyncSetsClient`
info	[Changelog] - New struct `SyncSetsClientCreateOrUpdateOptions`
info	[Changelog] - New struct `SyncSetsClientCreateOrUpdateResponse`
info	[Changelog] - New struct `SyncSetsClientDeleteOptions`
info	[Changelog] - New struct `SyncSetsClientDeleteResponse`
info	[Changelog] - New struct `SyncSetsClientGetOptions`
info	[Changelog] - New struct `SyncSetsClientGetResponse`
info	[Changelog] - New struct `SyncSetsClientListOptions`
info	[Changelog] - New struct `SyncSetsClientListResponse`
info	[Changelog] - New struct `SyncSetsClientUpdateOptions`
info	[Changelog] - New struct `SyncSetsClientUpdateResponse`
info	[Changelog] - New field `SystemData` in struct `Resource`
info	[Changelog] - New field `SystemData` in struct `TrackedResource`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 162 additive change(s).

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs] Generate from e40029494a55fff992b833f8cbd7183c306d1b16. 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

️✔️redhatopenshift [View full logs] [Preview Schema Changes]

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

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

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

Aug 30 '22 02:08 openapi-pipeline-app[bot]

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

Aug 30 '22 02:08 openapi-pipeline-app[bot]

Thank you for your contribution ross-bryan! We will review the pull request and get back to you soon.

Aug 30 '22 02:08 ghost

Hi @ross-bryan, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

Aug 30 '22 02:08 openapi-workflow-bot[bot]

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

Aug 30 '22 02:08 openapi-workflow-bot[bot]

Pleae follow the instructions in the checklist before sumitting the PR. This PR is not created correctly :

In reply to: 1232049880

Aug 30 '22 19:08 raosuhas

Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

Aug 30 '22 19:08 openapi-workflow-bot[bot]

@raosuhas thank you for the feedback. I was still working on some of the definitions/descriptions. I wasn't aware that the PR was adding/removing the labels for you to review it so soon. I will address all your comments in my next push

Aug 31 '22 21:08 ross-bryan

@raosuhas thank you for the feedback. I was still working on some of the definitions/descriptions. I wasn't aware that the PR was adding/removing the labels for you to review it so soon. I will address all your comments in my next push

np .. there seems to be a bug in the label setting alogrithm which the team is working on , so I am just manually checking PRs for now .. so I might be looking at some PRs incorrectly

In reply to: 1233459263

Aug 31 '22 21:08 raosuhas

Fixed the labels , please remove ARMCHangesRequested label when you want the ARM reviewer to look at this again.

In reply to: 1235153633

Sep 02 '22 07:09 raosuhas

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.

Sep 02 '22 21:09 openapi-workflow-bot[bot]

/azp run