Skip to content

Commit 41cfda9

Browse files
azure-sdkazure-sdk
committed
Update docs metadata
1 parent d8a696a commit 41cfda9

2 files changed

Lines changed: 49 additions & 79 deletions

File tree

‎api/overview/azure/latest/data.appconfiguration-readme.md‎

Lines changed: 47 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,21 @@
11
---
22
title: Azure App Configuration client library for .NET
33
keywords: Azure, dotnet, SDK, API, Azure.Data.AppConfiguration, appconfiguration
4-
author: ramya-rao-a
5-
ms.author: ramyar
6-
ms.date: 10/04/2021
4+
author: ShivangiReja
5+
ms.author: shreja
6+
ms.date: 09/12/2023
77
ms.topic: reference
8-
ms.prod: azure
9-
ms.technology: azure
108
ms.devlang: dotnet
119
ms.service: appconfiguration
1210
---
13-
14-
# Azure App Configuration client library for .NET - version 1.2.0
11+
# Azure App Configuration client library for .NET - version 1.2.1
1512

1613

1714
Azure App Configuration is a managed service that helps developers centralize their application and feature settings simply and securely.
1815

1916
Use the client library for App Configuration to:
2017

2118
* [Create and manage centrally stored application configuration settings][azconfig_setting_concepts]
22-
* [Retrieve configuration settings from a specific point in time][azconfig_asof_snapshot]
2319

2420
[Source code][source_root] | [Package (NuGet)][package] | [API reference documentation][reference_docs] | [Product documentation][azconfig_docs] | [Samples][source_samples]
2521

@@ -29,14 +25,14 @@ Use the client library for App Configuration to:
2925

3026
Install the Azure App Configuration client library for .NET with [NuGet][nuget]:
3127

32-
```PowerShell
33-
Install-Package Azure.Data.AppConfiguration
28+
```dotnetcli
29+
dotnet add package Azure.Data.AppConfiguration
3430
```
3531

36-
### Prerequisites
32+
### Prerequisites
3733

3834
* An [Azure subscription][azure_sub].
39-
* An existing [Configuration Store][configuration_store].
35+
* An existing [Configuration Store][configuration_store].
4036

4137
If you need to create a Configuration Store, you can use the Azure Portal or [Azure CLI][azure_cli].
4238

@@ -74,8 +70,8 @@ var client = new ConfigurationClient(connectionString);
7470
Client subscription key authentication is used in most of the examples in this getting started guide, but you can also authenticate with Azure Active Directory using the [Azure Identity library][azure_identity]. To use the [DefaultAzureCredential][azure_identity_dac] provider shown below,
7571
or other credential providers provided with the Azure SDK, please install the Azure.Identity package:
7672

77-
```PowerShell
78-
Install-Package Azure.Identity
73+
```dotnetcli
74+
dotnet add package Azure.Identity
7975
```
8076

8177
You will also need to [register a new AAD application][aad_register_app] and [grant access][aad_grant_access] to Configuration Store by assigning the `"App Configuration Data Reader"` or `"App Configuration Data Owner"` role to your service principal.
@@ -98,34 +94,35 @@ The [Label][label_concept] property of a Configuration Setting provides a way to
9894
For example, MaxRequests may be 100 in "NorthAmerica" and 200 in "WestEurope". By creating a Configuration Setting named MaxRequests with a label of "NorthAmerica" and another, only with a different value, with a "WestEurope" label, an application can seamlessly retrieve Configuration Settings as it runs in these two dimensions.
9995

10096
### Thread safety
97+
10198
We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads.
10299

103100
### Additional concepts
104101
<!-- CLIENT COMMON BAR -->
105-
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
106-
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
107-
[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) |
108-
[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
109-
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/core/Azure.Core/samples/Diagnostics.md) |
110-
[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/core/Azure.Core/README.md#mocking) |
102+
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
103+
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
104+
[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) |
105+
[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
106+
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/core/Azure.Core/samples/Diagnostics.md) |
107+
[Mocking](https://learn.microsoft.com/dotnet/azure/sdk/unit-testing-mocking) |
111108
[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
112109
<!-- CLIENT COMMON BAR -->
113110

114111
## Examples
115112

116113
The following sections provide several code snippets covering some of the most common Configuration Service tasks. Note that there are sync and async methods available for both.
117114

118-
- [Create a Configuration Setting](#create-a-configuration-setting)
119-
- [Retrieve a Configuration Setting](#retrieve-a-configuration-setting)
120-
- [Update an existing Configuration Setting](#update-an-existing-configuration-setting)
121-
- [Delete a Configuration Setting](#delete-a-configuration-setting)
115+
* [Create a Configuration Setting](#create-a-configuration-setting)
116+
* [Retrieve a Configuration Setting](#retrieve-a-configuration-setting)
117+
* [Update an existing Configuration Setting](#update-an-existing-configuration-setting)
118+
* [Delete a Configuration Setting](#delete-a-configuration-setting)
122119

123120
### Create a Configuration Setting
124121

125122
Create a Configuration Setting to be stored in the Configuration Store. There are two ways to store a Configuration Setting:
126123

127-
- AddConfigurationSetting creates a setting only if the setting does not already exist in the store.
128-
- SetConfigurationSetting creates a setting if it doesn't exist or overrides an existing setting.
124+
* AddConfigurationSetting creates a setting only if the setting does not already exist in the store.
125+
* SetConfigurationSetting creates a setting if it doesn't exist or overrides an existing setting.
129126

130127
```C# Snippet:CreateConfigurationSetting
131128
string connectionString = "<connection_string>";
@@ -166,47 +163,23 @@ client.DeleteConfigurationSetting("some_key");
166163

167164
## Troubleshooting
168165

169-
When you interact with Azure App Configuration using the .NET SDK, errors returned by the service correspond to the same HTTP status codes returned for [REST API][azconfig_rest] requests.
170-
171-
For example, if you try to retrieve a Configuration Setting that doesn't exist in your Configuration Store, a `404` error is returned, indicating `Not Found`.
172-
173-
```C# Snippet:ThrowNotFoundError
174-
string connectionString = "<connection_string>";
175-
var client = new ConfigurationClient(connectionString);
176-
ConfigurationSetting setting = client.GetConfigurationSetting("nonexistent_key");
177-
```
178-
179-
You will notice that additional information is logged, like the Client Request ID of the operation.
180-
181-
```
182-
Message: Azure.RequestFailedException : StatusCode: 404, ReasonPhrase: 'Not Found', Version: 1.1, Content: System.Net.Http.NoWriteNoSeekStreamContent, Headers:
183-
{
184-
Connection: keep-alive
185-
Date: Thu, 11 Apr 2019 00:16:57 GMT
186-
Server: nginx/1.13.9
187-
x-ms-client-request-id: cc49570c-9143-411e-a6c8-3287dd114034
188-
x-ms-request-id: 2ad025f7-1fe8-4da0-8648-8290e774ed61
189-
x-ms-correlation-request-id: 2ad025f7-1fe8-4da0-8648-8290e774ed61
190-
Strict-Transport-Security: max-age=15724800; includeSubDomains;
191-
Content-Length: 0
192-
}
193-
```
166+
See our [troubleshooting guide](https://github.com/Azure/azure-sdk-for-net/tree/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios.
194167

195168
## Next steps
196169

197170
### More sample code
198171

199-
Several App Configuration client library samples are available to you in this GitHub repository. These include:
200-
- [Hello world](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample1_HelloWorld.md): Create and delete a configuration setting.
201-
- [Hello world async with labels](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample2_HelloWorldExtended.md): Asynchronously create, update and delete configuration settings with labels.
202-
- [Make a configuration setting readonly](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample3_SetClearReadOnly.md): Make a configuration setting read-only, and then return it to a read-write state.
203-
- [Read revision history](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample4_ReadRevisionHistory.md): Read the revision history of a configuration setting that has been changed.
204-
- [Get a setting if changed](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample5_GetSettingIfChanged.md): Save bandwidth by using a conditional request to retrieve a setting only if it is different from your local copy.
205-
- [Update a setting if it hasn't changed](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample6_UpdateSettingIfUnchanged.md): Prevent lost updates by using optimistic concurrency to update a setting only if your local updates were applied to the same version as the resource in the configuration store.
206-
- [Create a mock client](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample7_MockClient.md): Mock a client for testing using the [Moq library][moq].
172+
Several App Configuration client library samples are available to you in this GitHub repository. These include:
207173

208-
For more details see the [samples README][samples_readme].
174+
* [Hello world](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample1_HelloWorld.md): Create and delete a configuration setting.
175+
* [Hello world async with labels](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample2_HelloWorldExtended.md): Asynchronously create, update and delete configuration settings with labels.
176+
* [Make a configuration setting readonly](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample3_SetClearReadOnly.md): Make a configuration setting read-only, and then return it to a read-write state.
177+
* [Read revision history](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample4_ReadRevisionHistory.md): Read the revision history of a configuration setting that has been changed.
178+
* [Get a setting if changed](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample5_GetSettingIfChanged.md): Save bandwidth by using a conditional request to retrieve a setting only if it is different from your local copy.
179+
* [Update a setting if it hasn't changed](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/Sample6_UpdateSettingIfUnchanged.md): Prevent lost updates by using optimistic concurrency to update a setting only if your local updates were applied to the same version as the resource in the configuration store.
180+
* [Create a mock client](https://learn.microsoft.com/dotnet/azure/sdk/unit-testing-mocking): Mock a client for testing.
209181

182+
For more details see the [samples README][samples_readme].
210183

211184
## Contributing
212185

@@ -221,28 +194,25 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
221194
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fappconfiguration%2FAzure.Data.AppConfiguration%2FREADME.png)
222195

223196
<!-- LINKS -->
224-
[azconfig_docs]: https://docs.microsoft.com/azure/azure-app-configuration/
225-
[azconfig_contrib]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/CONTRIBUTING.md
226-
[azconfig_setting_concepts]: https://docs.microsoft.com/azure/azure-app-configuration/concept-key-value
227-
[azconfig_asof_snapshot]: https://docs.microsoft.com/azure/azure-app-configuration/concept-point-time-snapshot
228-
[aad_grant_access]: https://docs.microsoft.com/powershell/module/az.Resources/New-azRoleAssignment?view=azps-1.8.0
229-
[aad_register_app]: https://docs.microsoft.com/azure/app-service/configure-authentication-provider-aad#-configure-with-advanced-settings
230-
[azure_identity]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/identity/Azure.Identity
231-
[azure_identity_dac]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/identity/Azure.Identity/README.md#defaultazurecredential
197+
[azconfig_docs]: /azure/azure-app-configuration/
198+
[azconfig_contrib]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/CONTRIBUTING.md
199+
[azconfig_setting_concepts]: /azure/azure-app-configuration/concept-key-value
200+
[aad_grant_access]: /powershell/module/az.Resources/New-azRoleAssignment?view=azps-1.8.0
201+
[aad_register_app]: /azure/app-service/configure-authentication-provider-aad#-configure-with-advanced-settings
202+
[azure_identity]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/identity/Azure.Identity
203+
[azure_identity_dac]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/identity/Azure.Identity/README.md#defaultazurecredential
232204
[azure_portal]: https://portal.azure.com
233-
[source_root]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/src
234-
[source_samples]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/samples
205+
[source_root]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/src
206+
[source_samples]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/samples
235207
[reference_docs]: https://azure.github.io/azure-sdk-for-net/appconfiguration.html
236-
[azconfig_rest]: https://docs.microsoft.com/azure/azure-app-configuration/rest-api
237-
[azure_cli]: https://docs.microsoft.com/cli/azure
208+
[azure_cli]: /cli/azure
238209
[azure_sub]: https://azure.microsoft.com/free/dotnet/
239-
[configuration_client_class]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/src/ConfigurationClient.cs
240-
[configuration_store]: https://docs.microsoft.com/azure/azure-app-configuration/quickstart-dotnet-core-app#create-an-app-configuration-store
241-
[label_concept]: https://docs.microsoft.com/azure/azure-app-configuration/concept-key-value#label-keys
210+
[configuration_client_class]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/src/ConfigurationClient.cs
211+
[configuration_store]: /azure/azure-app-configuration/quickstart-dotnet-core-app#create-an-app-configuration-store
212+
[label_concept]: /azure/azure-app-configuration/concept-key-value#label-keys
242213
[nuget]: https://www.nuget.org/
243214
[package]: https://www.nuget.org/packages/Azure.Data.AppConfiguration/
244-
[samples_readme]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.0/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/README.md
245-
[moq]: https://github.com/Moq/moq4/
215+
[samples_readme]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.Data.AppConfiguration_1.2.1/sdk/appconfiguration/Azure.Data.AppConfiguration/samples/README.md
246216
[cla]: https://cla.microsoft.com
247217
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
248218
[code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/

‎metadata/latest/Azure.Data.AppConfiguration.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"Name": "Azure.Data.AppConfiguration",
3-
"Version": "1.2.0",
3+
"Version": "1.2.1",
44
"DevVersion": null,
55
"DirectoryPath": "sdk/appconfiguration/Azure.Data.AppConfiguration",
66
"ServiceDirectory": "appconfiguration",
@@ -10,7 +10,7 @@
1010
"SdkType": "client",
1111
"IsNewSdk": true,
1212
"ArtifactName": "Azure.Data.AppConfiguration",
13-
"ReleaseStatus": "2021-10-05",
13+
"ReleaseStatus": "2023-09-13",
1414
"Namespaces": [
1515
"Azure.Data.AppConfiguration",
1616
"Microsoft.Extensions.Azure"

0 commit comments

Comments
 (0)