Update appconfiguration.json #20885

leni-msft · 2022-09-27T09:50:21Z

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 · 2022-09-27T09:50:25Z

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.9.7)]	new version	base version
appconfiguration.json	2022-05-01(29f8f48)	2022-05-01(main)

️️✔️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 v1.13.0)	new version	base version
package-2022-05-01	package-2022-05-01(29f8f48)	package-2022-05-01(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4037 - MissingTypeObject	The schema 'ErrorDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1902
`❌` R4037 - MissingTypeObject	The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1936
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1688
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePurgeProtection Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1319
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePurgeProtection Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1441
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1812
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: purgeProtectionEnabled Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L2205
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L559
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'PrivateEndpointConnections_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L606
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'KeyValues_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L868
⚠️ R4009 - RequiredReadOnlySystemData	The response of operation:'KeyValues_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L915
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ConfigurationStores_CheckNameAvailable Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1191
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ConfigurationStores_CheckNameNotAvailable Location: Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json#L1191

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

Validation passes for Avocado.

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

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

Tag package-2022-05-01; Prod region: Deployed

Test run on region: westcentralus; Operation coverage: total: 24, untested: 0, failed: 7, passed: 17

Service API Readiness Test failed. Check pipeline artifact for detail report.

Rule	Message
`❌` CLIENT_ERROR	"statusCode: 404, errorCode: EntityNotFound, errorMessage: The resource with id 'configstorct2hyi' was not found."
`❌` ASSERTION_ERROR	"expected response code to be 2XX but found 404"
`❌` CLIENT_ERROR	"statusCode: 404, errorCode: EntityNotFound, errorMessage: The resource with id '439AD01B4BE67DB1' was not found."
`❌` ASSERTION_ERROR	"expected response code to be 2XX but found 404"
`❌` CLIENT_ERROR	"statusCode: 404, errorCode: EntityNotFound, errorMessage: The resource with id 'privateendnf4wu4' was not found."
`❌` ASSERTION_ERROR	"expected response code to be 2XX but found 404"
`❌` CLIENT_ERROR	"statusCode: 404, errorCode: EntityNotFound, errorMessage: The resource with id 'privateendnf4wu4' was not found."
`❌` ASSERTION_ERROR	"expected response code to be 2XX but found 404"
`❌` CLIENT_ERROR	"statusCode: 404, errorCode: undefined, errorMessage: undefined"
`❌` ASSERTION_ERROR	"expected response code to be 2XX but found 404"
`❌` INVALID_CONTENT_TYPE	"Invalid Content-Type (application/octet-stream). These are supported: application/json"
`❌` INVALID_RESPONSE_BODY	"Body is required in response but not provided"
`❌` CLIENT_ERROR	"statusCode: 404, errorCode: EntityNotFound, errorMessage: The resource with id 'groupnameau5gp2' was not found."
`❌` ASSERTION_ERROR	"expected response code to be 2XX but found 404"
`❌` CLIENT_ERROR	"statusCode: 404, errorCode: EntityNotFound, errorMessage: The resource with id 'privateendnf4wu4' was not found."
`❌` ASSERTION_ERROR	"expected response code to be 2XX but found 404"

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

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

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

Validation passed for PoliCheck.

️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]

The following tags are being changed in this PR

"https://github.com/Azure/azure-rest-api-specs/blob/29f8f4838ae05e0f3060ff7036f02e1a76849293/specification/appconfiguration/resource-manager/readme.md#tag-package-2022-05-01">appconfiguration/resource-manager/readme.md#package-2022-05-01

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ UnkownSecurityScheme	"readme":"appconfiguration/resource-manager/readme.md", "tag":"package-2022-05-01", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous"

️️✔️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-pipeline-app · 2022-09-27T09:50:25Z

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]Release - Generate from 4b2f5a4. 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

️✔️track2_azure-mgmt-appconfiguration [View full logs] [Release SDK Changes]
- azure_mgmt_appconfiguration-2.2.0-py3-none-any.whl
- azure-mgmt-appconfiguration-2.2.0.zip
```
info	[Changelog]
```

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

️✔️Succeeded [Logs]Release - Generate from 4b2f5a4. 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/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.AppConfiguration [View full logs] [Release SDK Changes]
- Azure.ResourceManager.AppConfiguration.1.1.0-alpha.20220928.1.nupkg
```
info	[Changelog]
```

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

️✔️Succeeded [Logs]Release - Generate from 4b2f5a4. 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-appconfiguration [View full logs] [Release SDK Changes]

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

️✔️Succeeded [Logs]Release - Generate from 4b2f5a4. 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-appconfiguration [View full logs] [Release SDK Changes]

azure-arm-appconfiguration-3.1.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface ConfigurationStore
info	[Changelog]   - Added Interface TrackedResource

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

️✔️Succeeded [Logs]Release - Generate from 4b2f5a4. 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/appconfiguration/armappconfiguration [View full logs] [Release SDK Changes]

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

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

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

️✔️appconfiguration [View full logs]

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

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

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

openapi-pipeline-app · 2022-09-27T09:50:26Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/appconfiguration/armappconfiguration	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Python	track2_azure-mgmt-appconfiguration	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
Java	azure-resourcemanager-appconfiguration	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
JavaScript	@azure/arm-appconfiguration	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
.Net	Azure.ResourceManager.AppConfiguration	Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

leni-msft · 2022-09-27T09:55:30Z

/azp run

azure-pipelines · 2022-09-27T09:55:38Z

Azure Pipelines successfully started running 1 pipeline(s).

This reverts commit 4b2f5a4.

Update appconfiguration.json

29f8f48

openapi-assignment-bot bot assigned akning-ms Sep 27, 2022

leni-msft added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test ARMReview labels Sep 27, 2022

azure-sdk mentioned this pull request Sep 27, 2022

[AutoPR sdk/resourcemanager/appconfiguration/armappconfiguration] Update appconfiguration.json azure-sdk/azure-sdk-for-go#3113

Closed

AzureRestAPISpecReview added the resource-manager label Sep 27, 2022

akning-ms approved these changes Sep 28, 2022

View reviewed changes

akning-ms merged commit 4b2f5a4 into main Sep 28, 2022

akning-ms deleted the leni-msft-patch-2 branch September 28, 2022 10:29

leni-msft added a commit that referenced this pull request Sep 29, 2022

Revert "Update appconfiguration.json (#20885)"

afbb562

This reverts commit 4b2f5a4.

leni-msft mentioned this pull request Sep 29, 2022

Revert "Update appconfiguration.json" #20928

Merged

leni-msft added a commit that referenced this pull request Sep 29, 2022

Revert "Update appconfiguration.json (#20885)" (#20928)

16f3445

This reverts commit 4b2f5a4.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update appconfiguration.json #20885

Update appconfiguration.json #20885

leni-msft commented Sep 27, 2022

openapi-pipeline-app bot commented Sep 27, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 27, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Sep 27, 2022 •

edited

Loading

leni-msft commented Sep 27, 2022

azure-pipelines bot commented Sep 27, 2022

Update appconfiguration.json #20885

Update appconfiguration.json #20885

Conversation

leni-msft commented Sep 27, 2022

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Sep 27, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Sep 27, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Sep 27, 2022 • edited Loading

Generated ApiView

leni-msft commented Sep 27, 2022

azure-pipelines bot commented Sep 27, 2022

openapi-pipeline-app bot commented Sep 27, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 27, 2022 •

edited

Loading

openapi-pipeline-app bot commented Sep 27, 2022 •

edited

Loading