Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added disableLocalAuth property to Microsoft.AppConfiguration/configurationStores #13407

Conversation

jimmyca15
Copy link
Member

Added the disableLocalAuth property to the latest preview version of Microsoft.AppConfiguration/configurationStores.

The disableLocalAuth property will be required for all Azure Resources that support AAD Authentication and local authentication schemes. When disableLocalAuth is set to true only AAD authentication can be used to access the respective configurationStore.

@openapi-workflow-bot
Copy link

Hi, @jimmyca15 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
    Copy link

    openapi-pipeline-app bot commented Mar 12, 2021

    Swagger Validation Report

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

    Rule Message
    1041 - AddedPropertyInResponse The new version has a new property 'disableLocalAuth' in response that was not found in the old version.
    New: Microsoft.AppConfiguration/preview/2020-07-01-preview/appconfiguration.json#L1067:7
    Old: Microsoft.AppConfiguration/preview/2020-07-01-preview/appconfiguration.json#L1067:7
    1045 - AddedOptionalProperty The new version has a new optional property 'disableLocalAuth' that was not found in the old version.
    New: Microsoft.AppConfiguration/preview/2020-07-01-preview/appconfiguration.json#L1067:7
    Old: Microsoft.AppConfiguration/preview/2020-07-01-preview/appconfiguration.json#L1067:7
    1045 - AddedOptionalProperty The new version has a new optional property 'disableLocalAuth' that was not found in the old version.
    New: Microsoft.AppConfiguration/preview/2020-07-01-preview/appconfiguration.json#L1205:7
    Old: Microsoft.AppConfiguration/preview/2020-07-01-preview/appconfiguration.json#L1201:7
    ️⚠️LintDiff: 2 Warnings warning [Detail]

    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth
    Location: Microsoft.AppConfiguration/preview/2020-07-01-preview/appconfiguration.json#L1120
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableLocalAuth
    Location: Microsoft.AppConfiguration/preview/2020-07-01-preview/appconfiguration.json#L1210
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 4 Warnings warning [Detail]

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"appconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'ErrorDetails' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"appconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"appconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"appconfiguration/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 12, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 81ce7dc6b5a3496fa40421b1ebae13fe3b9d85a6. 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]  [Preview SDK Changes]
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from 81ce7dc6b5a3496fa40421b1ebae13fe3b9d85a6. 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
    • ️✔️azure-mgmt-appconfiguration [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model KeyValue has a new parameter type
      info	[Changelog]   - Model KeyValue has a new parameter name
      info	[Changelog]   - Model KeyValue has a new parameter id
      info	[Changelog]   - Model OperationDefinition has a new parameter origin
      info	[Changelog]   - Model OperationDefinition has a new parameter is_data_action
      info	[Changelog]   - Model OperationDefinition has a new parameter properties
      info	[Changelog]   - Model ConfigurationStoreUpdateParameters has a new parameter disable_local_auth
      info	[Changelog]   - Model ConfigurationStore has a new parameter disable_local_auth
      info	[Changelog]   - Added operation group KeyValuesOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model ConfigurationStoreUpdateParameters no longer has parameter public_network_access
      info	[Changelog]   - Removed operation ConfigurationStoresOperations.list_key_value
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 81ce7dc6b5a3496fa40421b1ebae13fe3b9d85a6. 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]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model KeyValue has a new parameter type
      info	[Changelog]   - Model KeyValue has a new parameter id
      info	[Changelog]   - Model KeyValue has a new parameter name
      info	[Changelog]   - Model ConfigurationStoreUpdateParameters has a new parameter disable_local_auth
      info	[Changelog]   - Model OperationDefinition has a new parameter is_data_action
      info	[Changelog]   - Model OperationDefinition has a new parameter origin
      info	[Changelog]   - Model OperationDefinition has a new parameter properties
      info	[Changelog]   - Model ConfigurationStore has a new parameter disable_local_auth
      info	[Changelog]   - Added operation group KeyValuesOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model ConfigurationStoreUpdateParameters no longer has parameter public_network_access
      info	[Changelog]   - Removed operation ConfigurationStoresOperations.list_key_value
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 81ce7dc6b5a3496fa40421b1ebae13fe3b9d85a6. 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] 2021-03-12 22:10:19 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-appconfiguration"
      cmderr	[generate.py] 2021-03-12 22:10:19 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-03-12 22:10:19 INFO autorest --version=3.1.0 --use=@autorest/[email protected] --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/appconfiguration/azure-resourcemanager-appconfiguration --java.namespace=com.azure.resourcemanager.appconfiguration   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/appconfiguration/resource-manager/readme.md
      cmderr	[generate.py] 2021-03-12 22:10:53 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-03-12 22:10:53 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-03-12 22:10:53 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-03-12 22:10:53 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-03-12 22:10:53 INFO [POM][Skip] pom already has module sdk/appconfiguration
      cmderr	[generate.py] 2021-03-12 22:10:53 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-appconfiguration [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-03-12 22:13:53 DEBUG Got artifact_id: azure-resourcemanager-appconfiguration
      cmderr	[Inst] 2021-03-12 22:13:53 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-03-12 22:13:53 DEBUG Got artifact: azure-resourcemanager-appconfiguration-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-03-12 22:13:53 DEBUG Got artifact: azure-resourcemanager-appconfiguration-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-03-12 22:13:53 DEBUG Got artifact: azure-resourcemanager-appconfiguration-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-12 22:13:53 DEBUG Match jar package: azure-resourcemanager-appconfiguration-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-03-12 22:13:53 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13407/azure-sdk-for-java/azure-resourcemanager-appconfiguration/azure-resourcemanager-appconfiguration-1.0.0-beta.1.jar\" -o azure-resourcemanager-appconfiguration-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-appconfiguration -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-appconfiguration-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 81ce7dc6b5a3496fa40421b1ebae13fe3b9d85a6. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/appconfiguration/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.AppConfiguration [View full logs]  [Preview SDK Changes]
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 81ce7dc6b5a3496fa40421b1ebae13fe3b9d85a6. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/appconfiguration/resource-manager/readme.md
    • ️✔️@azure/arm-appconfiguration [View full logs]  [Preview SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/appConfigurationManagementClient.js → ./dist/arm-appconfiguration.js...
      cmderr	[npmPack] created ./dist/arm-appconfiguration.js in 335ms
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 81ce7dc6b5a3496fa40421b1ebae13fe3b9d85a6. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️appconfiguration/mgmt/2020-06-01/appconfiguration [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️appconfiguration/mgmt/2019-10-01/appconfiguration [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/appconfiguration/mgmt/2020-07-01-preview/appconfiguration [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New field `DisableLocalAuth` in struct `ConfigurationStoreProperties`
      info	[Changelog] - New field `DisableLocalAuth` in struct `ConfigurationStorePropertiesUpdateParameters`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 2 additive change(s).
      info	[Changelog]
    • ️✔️preview/appconfiguration/mgmt/2019-11-01-preview/appconfiguration [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/appconfiguration/mgmt/2019-02-01-preview/appconfiguration [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 81ce7dc6b5a3496fa40421b1ebae13fe3b9d85a6. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/[email protected] --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/appconfiguration/resource-manager/readme.md
    • ️✔️appconfiguration [View full logs]  [Preview Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager] npm WARN [email protected] No repository field.
      cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    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.

    @erich-wang
    Copy link
    Member

    @jimmyca15 , please follow comment posted by @openapi-workflow-bot

    @jimmyca15
    Copy link
    Member Author

    @erich-wang can you point me to the breaking change guidelines? Are we expected to introduce a new api version for any tweak or new property in a preview API version? What if the version is only a week old?

    @erich-wang
    Copy link
    Member

    https://aka.ms/AzBreakingChangesPolicy, basically you need to get exceptional approval by following up policy if you don't want to introduce new api version.

    @erich-wang
    Copy link
    Member

    @jimmyca15, is this PR still valid? Have you gone thru breaking change process?

    @jimmyca15
    Copy link
    Member Author

    @erich-wang this was replaced with the pr #13490 to avoid breaking changes. I'll go ahead and close it.

    @jimmyca15 jimmyca15 closed this Mar 24, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants