16 строки
10 KiB
YAML
16 строки
10 KiB
YAML
### YamlMime:JavaPackage
|
|
uid: "com.azure.data.appconfiguration"
|
|
fullName: "com.azure.data.appconfiguration"
|
|
name: "com.azure.data.appconfiguration"
|
|
summary: "[Azure App Configuration Service][] is a managed service provided by Microsoft Azure that allows developers to centralize configuration settings for their applications.\n\n\n[Azure App Configuration Service]: https://learn.microsoft.com/azure/azure-app-configuration/"
|
|
classes:
|
|
- "com.azure.data.appconfiguration.ConfigurationAsyncClient"
|
|
- "com.azure.data.appconfiguration.ConfigurationClient"
|
|
- "com.azure.data.appconfiguration.ConfigurationClientBuilder"
|
|
enums:
|
|
- "com.azure.data.appconfiguration.ConfigurationServiceVersion"
|
|
desc: "[Azure App Configuration Service][] is a managed service provided by Microsoft Azure that allows developers to centralize configuration settings for their applications. With App Configuration, developers can store and manage application settings, feature flags, and other configuration data in one central location. This simplifies the management of configuration settings and makes it easy to update configuration values for multiple applications.\n\nThe Azure App Configuration library is a client library that provides Java developers with a simple and easy-to-use interface for accessing and using the Azure App Configuration Service. This library allows developers to easily manage their application's configuration settings, feature flags, and other configuration data stored in the Azure App Configuration Service.\n\n## Getting Started ##\n\nIn order to interact with the App Configuration service you'll need to create an instance of the Configuration Client class. To make this possible you'll need the connection string of the configuration store. Alternatively, you can use AAD authentication via [ Azure Identity][Azure Identity] to connect to the service.\n\n1. Connection string, see <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.connectionString(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"connectionString\"></xref>.\n2. Azure Active Directory, see <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder.credential(com.azure.core.credential.TokenCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref>.\n\n**Sample: Construct Asynchronous Configuration Client with Connection String**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\"></xref>, using the <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClientBuilder\"></xref> to configure it with a connection string.\n\n```java\nConfigurationAsyncClient configurationAsyncClient = new ConfigurationClientBuilder()\n .connectionString(connectionString)\n .buildAsyncClient();\n```\n\n**Sample: Construct Synchronous Configuration Client with Connection String**\n\nThe following code sample demonstrates the creation of a <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>, using the <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClientBuilder\"></xref> to configure it with a connection string.\n\n```java\nConfigurationClient configurationClient = new ConfigurationClientBuilder()\n .connectionString(connectionString)\n .buildClient();\n```\n\nApp Configuration support multiple operations, such as create, update, retrieve, and delete a configuration setting. See methods in client level class below to explore all capabilities that library provides.\n\nFor more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\"></xref>.\n\n\n--------------------\n\n## Add Configuration Setting ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient.addConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"addConfigurationSetting\"></xref> method can be used to add a configuration setting in the Azure App Configuration.\n\nThe sample below shows how to add a setting with the key \"prodDBConnection\", label \"westUS\" and value \"db\\_connection\" using <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>.\n\n```java\nConfigurationSetting setting = configurationClient.addConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"db_connection\"));\n System.out.printf(\"Key: %s, Label: %s, Value: %s\", setting.getKey(), setting.getLabel(), setting.getValue());\n```\n\n**Note:** For asynchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\"></xref>.\n\n\n--------------------\n\n## Update Configuration Setting ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient.setConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"setConfigurationSetting\"></xref> method can be used to update a configuration setting in the Azure App Configuration.\n\nThe sample below shows how to update setting's value \"db\\_connection\" to \"updated\\_db\\_connection\"\n\n```java\nConfigurationSetting setting = configurationClient.setConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"db_connection\"));\n System.out.printf(\"Key: %s, Label: %s, Value: %s\", setting.getKey(), setting.getLabel(), setting.getValue());\n\n // Update the value of the setting to \"updated_db_connection\".\n setting = configurationClient.setConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"updated_db_connection\"));\n System.out.printf(\"Key: %s, Label: %s, Value: %s\", setting.getKey(), setting.getLabel(), setting.getValue());\n```\n\n**Note:** For asynchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\"></xref>.\n\n\n--------------------\n\n## Get Configuration Setting ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient.getConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"getConfigurationSetting\"></xref> method can be used to get a configuration setting in the Azure App Configuration.\n\nThe sample below shows how to retrieve the setting with the key \"prodDBConnection\".\n\n```java\nConfigurationSetting setting = configurationClient.getConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"));\n System.out.printf(\"Key: %s, Value: %s\", setting.getKey(), setting.getValue());\n```\n\n**Note:** For asynchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\"></xref>.\n\n\n--------------------\n\n## Delete Configuration Setting ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient.deleteConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"deleteConfigurationSetting\"></xref> method can be used to delete a configuration setting in the Azure App Configuration.\n\nThe sample below shows how to delete the setting with the key \"prodDBConnection\".\n\n```java\nConfigurationSetting setting = configurationClient.deleteConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"));\n System.out.printf(\"Key: %s, Value: %s\", setting.getKey(), setting.getValue());\n```\n\n**Note:** For asynchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\"></xref>.\n\n\n--------------------\n\n## List Configuration Settings ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient.listConfigurationSettings(com.azure.data.appconfiguration.models.SettingSelector)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"listConfigurationSettings\"></xref> method can be used to list configuration settings in the Azure App Configuration.\n\nThe sample below shows how to list all settings that use the key \"prodDBConnection\".\n\n```java\nSettingSelector settingSelector = new SettingSelector().setKeyFilter(\"prodDBConnection\");\n configurationClient.listConfigurationSettings(settingSelector).forEach(setting -> {\n System.out.printf(\"Key: %s, Value: %s\", setting.getKey(), setting.getValue());\n });\n```\n\n**Note:** For asynchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\"></xref>.\n\n\n[Azure App Configuration Service]: https://learn.microsoft.com/azure/azure-app-configuration/\n[Azure Identity]: https://learn.microsoft.com/java/api/overview/azure/identity-readme?view=azure-java-stable"
|
|
metadata: {}
|
|
package: "com.azure.data.appconfiguration"
|
|
artifact: com.azure:azure-data-appconfiguration:1.7.0
|