/
com.azure.data.appconfiguration.ConfigurationAsyncClient.yml
505 lines (505 loc) · 102 KB
/
com.azure.data.appconfiguration.ConfigurationAsyncClient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
### YamlMime:JavaType
uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient"
name: "ConfigurationAsyncClient"
nameWithType: "ConfigurationAsyncClient"
summary: "This class provides a client that contains all the operations for <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSettings\"></xref>, <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> or <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref> in Azure App Configuration Store."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **ConfigurationAsyncClient**"
methods:
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.addConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.addConfigurationSetting(ConfigurationSetting setting)"
name: "addConfigurationSetting(ConfigurationSetting setting)"
nameWithType: "ConfigurationAsyncClient.addConfigurationSetting(ConfigurationSetting setting)"
summary: "Adds a configuration value in the service if that key and label does not exist."
parameters:
- description: "The setting to add based on its key and optional label combination."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<ConfigurationSetting> addConfigurationSetting(ConfigurationSetting setting)"
desc: "Adds a configuration value in the service if that key and label does not exist. The label value of the ConfigurationSetting is optional. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>.\n\n**Code Samples**\n\nAdd a setting with the key \"prodDBConnection\", label \"westUS\", and value \"db\\_connection\".\n\n```java\nclient.addConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"db_connection\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```"
returns:
description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that was created, or <code>null</code> if a key collision occurs or the key\n is an invalid value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.addConfigurationSetting(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.addConfigurationSetting(String key, String label, String value)"
name: "addConfigurationSetting(String key, String label, String value)"
nameWithType: "ConfigurationAsyncClient.addConfigurationSetting(String key, String label, String value)"
summary: "Adds a configuration value in the service if that key does not exist."
parameters:
- description: "The key of the configuration setting to add."
name: "key"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The label of the configuration setting to add. If <code>null</code> no label will be used."
name: "label"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The value associated with this configuration setting key."
name: "value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<ConfigurationSetting> addConfigurationSetting(String key, String label, String value)"
desc: "Adds a configuration value in the service if that key does not exist. The `label` is optional.\n\n**Code Samples**\n\nAdd a setting with the key \"prodDBConnection\", label \"westUS\" and value \"db\\_connection\".\n\n```java\nclient.addConfigurationSetting(\"prodDBConnection\", \"westUS\", \"db_connection\")\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```"
returns:
description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that was created, or <code>null</code> if a key collision occurs or the key\n is an invalid value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.addConfigurationSettingWithResponse(com.azure.data.appconfiguration.models.ConfigurationSetting)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.addConfigurationSettingWithResponse(ConfigurationSetting setting)"
name: "addConfigurationSettingWithResponse(ConfigurationSetting setting)"
nameWithType: "ConfigurationAsyncClient.addConfigurationSettingWithResponse(ConfigurationSetting setting)"
summary: "Adds a configuration value in the service if that key and label does not exist."
parameters:
- description: "The setting to add based on its key and optional label combination."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<ConfigurationSetting>> addConfigurationSettingWithResponse(ConfigurationSetting setting)"
desc: "Adds a configuration value in the service if that key and label does not exist. The label value of the ConfigurationSetting is optional. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>.\n\n**Code Samples**\n\nAdd a setting with the key \"prodDBConnection\", label \"westUS\", and value \"db\\_connection\".\n\n```java\nclient.addConfigurationSettingWithResponse(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"db_connection\"))\n .subscribe(response -> {\n ConfigurationSetting responseSetting = response.getValue();\n System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n responseSetting.getKey(), responseSetting.getLabel(), responseSetting.getValue());\n });\n```"
returns:
description: "A REST response containing the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that was created, if a key collision occurs\n or the key is an invalid value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.archiveSnapshot(java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.archiveSnapshot(String snapshotName)"
name: "archiveSnapshot(String snapshotName)"
nameWithType: "ConfigurationAsyncClient.archiveSnapshot(String snapshotName)"
summary: "Update a snapshot status from <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.READY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#READY\"></xref> to <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.ARCHIVED\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#ARCHIVED\"></xref>."
parameters:
- description: "The snapshot name."
name: "snapshotName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<ConfigurationSnapshot> archiveSnapshot(String snapshotName)"
desc: "Update a snapshot status from <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.READY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#READY\"></xref> to <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.ARCHIVED\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#ARCHIVED\"></xref>.\n\n**Code Samples**\n\n```java\nString snapshotName = \"{snapshotName}\";\n client.archiveSnapshot(snapshotName).subscribe(\n archivedSnapshot -> {\n System.out.printf(\"Archived snapshot name=%s is created at %s, snapshot status is %s.%n\",\n archivedSnapshot.getName(), archivedSnapshot.getCreatedAt(), archivedSnapshot.getStatus());\n }\n );\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot?alt=com.azure.data.appconfiguration.models.ConfigurationSnapshot&text=ConfigurationSnapshot\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.archiveSnapshotWithResponse(java.lang.String,com.azure.core.http.MatchConditions)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.archiveSnapshotWithResponse(String snapshotName, MatchConditions matchConditions)"
name: "archiveSnapshotWithResponse(String snapshotName, MatchConditions matchConditions)"
nameWithType: "ConfigurationAsyncClient.archiveSnapshotWithResponse(String snapshotName, MatchConditions matchConditions)"
summary: "Update a snapshot status from <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.READY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#READY\"></xref> to <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.ARCHIVED\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#ARCHIVED\"></xref>."
parameters:
- description: "The snapshot name."
name: "snapshotName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Specifies HTTP options for conditional requests."
name: "matchConditions"
type: "<xref href=\"com.azure.core.http.MatchConditions?alt=com.azure.core.http.MatchConditions&text=MatchConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<ConfigurationSnapshot>> archiveSnapshotWithResponse(String snapshotName, MatchConditions matchConditions)"
desc: "Update a snapshot status from <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.READY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#READY\"></xref> to <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.ARCHIVED\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#ARCHIVED\"></xref>.\n\nTo turn on using 'if-match' header, set the second parameter 'ifUnchanged' to true. It used to perform an operation only if the targeted resource's ETag matches the value provided. Otherwise, it will throw an exception '412 Precondition Failed'.\n\n**Code Samples**\n\n```java\nString snapshotName = \"{snapshotName}\";\n MatchConditions matchConditions = new MatchConditions().setIfMatch(\"{etag}\");\n client.archiveSnapshotWithResponse(snapshotName, matchConditions)\n .subscribe(\n response -> {\n ConfigurationSnapshot archivedSnapshot = response.getValue();\n System.out.printf(\"Archived snapshot name=%s is created at %s, snapshot status is %s.%n\",\n archivedSnapshot.getName(), archivedSnapshot.getCreatedAt(), archivedSnapshot.getStatus());\n }\n );\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot?alt=com.azure.data.appconfiguration.models.ConfigurationSnapshot&text=ConfigurationSnapshot\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.beginCreateSnapshot(java.lang.String,com.azure.data.appconfiguration.models.ConfigurationSnapshot)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.beginCreateSnapshot(String snapshotName, ConfigurationSnapshot snapshot)"
name: "beginCreateSnapshot(String snapshotName, ConfigurationSnapshot snapshot)"
nameWithType: "ConfigurationAsyncClient.beginCreateSnapshot(String snapshotName, ConfigurationSnapshot snapshot)"
summary: "Create a <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref> by providing a snapshot name and a <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>."
parameters:
- description: "The name of the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref> to create."
name: "snapshotName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref> to create."
name: "snapshot"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot?alt=com.azure.data.appconfiguration.models.ConfigurationSnapshot&text=ConfigurationSnapshot\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PollerFlux<PollOperationDetails,ConfigurationSnapshot> beginCreateSnapshot(String snapshotName, ConfigurationSnapshot snapshot)"
desc: "Create a <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref> by providing a snapshot name and a <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>.\n\n**Code Samples**\n\n```java\nList<ConfigurationSettingsFilter> filters = new ArrayList<>();\n // Key Name also supports RegExp but only support prefix end with \"*\", such as \"k*\" and is case-sensitive.\n filters.add(new ConfigurationSettingsFilter(\"{keyName}\"));\n String snapshotName = \"{snapshotName}\";\n client.beginCreateSnapshot(snapshotName, new ConfigurationSnapshot(filters)\n .setRetentionPeriod(Duration.ofHours(1)))\n .flatMap(result -> result.getFinalResult())\n .subscribe(\n snapshot -> System.out.printf(\"Snapshot name=%s is created at %s%n\",\n snapshot.getName(), snapshot.getCreatedAt()),\n ex -> System.out.printf(\"Error on creating a snapshot=%s, with error=%s.%n\", snapshotName,\n ex.getMessage()),\n () -> System.out.println(\"Successfully created a snapshot.\"));\n```"
returns:
description: "A <xref uid=\"com.azure.core.util.polling.PollerFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PollerFlux\"></xref> that polls the creating snapshot operation until it has completed or\n has failed. The completed operation returns a <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>."
type: "<xref href=\"com.azure.core.util.polling.PollerFlux?alt=com.azure.core.util.polling.PollerFlux&text=PollerFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.polling.PollOperationDetails?alt=com.azure.core.util.polling.PollOperationDetails&text=PollOperationDetails\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot?alt=com.azure.data.appconfiguration.models.ConfigurationSnapshot&text=ConfigurationSnapshot\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.deleteConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.deleteConfigurationSetting(ConfigurationSetting setting)"
name: "deleteConfigurationSetting(ConfigurationSetting setting)"
nameWithType: "ConfigurationAsyncClient.deleteConfigurationSetting(ConfigurationSetting setting)"
summary: "Deletes the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> with a matching <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref>, and optional <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref> and optional ETag combination from the service."
parameters:
- description: "The setting to delete based on its key, optional label and optional ETag combination."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<ConfigurationSetting> deleteConfigurationSetting(ConfigurationSetting setting)"
desc: "Deletes the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> with a matching <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref>, and optional <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref> and optional ETag combination from the service. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>. If <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getETag()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ETag\"></xref> is specified and is not the wildcard character (`\"*\"`), then the setting is **only** deleted if the ETag matches the current ETag; this means that no one has updated the ConfigurationSetting yet.\n\n**Code Samples**\n\nDelete the setting with the key \"prodDBConnection\".\n\n```java\nclient.deleteConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getValue()));\n```"
returns:
description: "The deleted ConfigurationSetting or an empty Mono is also returned if the <code>key</code> is an invalid value\n (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.deleteConfigurationSetting(java.lang.String,java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.deleteConfigurationSetting(String key, String label)"
name: "deleteConfigurationSetting(String key, String label)"
nameWithType: "ConfigurationAsyncClient.deleteConfigurationSetting(String key, String label)"
summary: "Deletes the Configuration<wbr>Setting with a matching `key` and optional `label` combination."
parameters:
- description: "The key of configuration setting to delete."
name: "key"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The label of configuration setting to delete. If <code>null</code> no label will be used."
name: "label"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<ConfigurationSetting> deleteConfigurationSetting(String key, String label)"
desc: "Deletes the ConfigurationSetting with a matching `key` and optional `label` combination.\n\n**Code Samples**\n\nDelete the setting with the key \"prodDBConnection\".\n\n```java\nclient.deleteConfigurationSetting(\"prodDBConnection\", \"westUS\")\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```"
returns:
description: "The deleted ConfigurationSetting or an empty Mono is also returned if the <code>key</code> is an invalid value\n (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.deleteConfigurationSettingWithResponse(com.azure.data.appconfiguration.models.ConfigurationSetting,boolean)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.deleteConfigurationSettingWithResponse(ConfigurationSetting setting, boolean ifUnchanged)"
name: "deleteConfigurationSettingWithResponse(ConfigurationSetting setting, boolean ifUnchanged)"
nameWithType: "ConfigurationAsyncClient.deleteConfigurationSettingWithResponse(ConfigurationSetting setting, boolean ifUnchanged)"
summary: "Deletes the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> with a matching <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref>, and optional <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref> and optional ETag combination from the service."
parameters:
- description: "The setting to delete based on its key, optional label and optional ETag combination."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
- description: "Flag indicating if the <code>setting</code> <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getETag*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ETag\"></xref> is used as a\n IF-MATCH header."
name: "ifUnchanged"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<ConfigurationSetting>> deleteConfigurationSettingWithResponse(ConfigurationSetting setting, boolean ifUnchanged)"
desc: "Deletes the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> with a matching <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref>, and optional <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref> and optional ETag combination from the service. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>. If <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getETag()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ETag\"></xref> is specified and is not the wildcard character (`\"*\"`), then the setting is **only** deleted if the ETag matches the current ETag; this means that no one has updated the ConfigurationSetting yet.\n\n**Code Samples**\n\nDelete the setting with the key-label \"prodDBConnection\"-\"westUS\"\n\n```java\nclient.deleteConfigurationSettingWithResponse(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"),\n false)\n .contextWrite(Context.of(key1, value1, key2, value2))\n .subscribe(response -> {\n ConfigurationSetting responseSetting = response.getValue();\n System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n responseSetting.getKey(), responseSetting.getLabel(), responseSetting.getValue());\n });\n```"
returns:
description: "A REST response containing the deleted ConfigurationSetting or <code>null</code> if didn't exist. <code>null</code>\n is also returned if the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref> is an invalid value or\n <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getETag()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ETag\"></xref> is set but does not match the current ETag\n (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getConfigurationSetting(ConfigurationSetting setting)"
name: "getConfigurationSetting(ConfigurationSetting setting)"
nameWithType: "ConfigurationAsyncClient.getConfigurationSetting(ConfigurationSetting setting)"
summary: "Attempts to get the Configuration<wbr>Setting with a matching <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref>, and optional <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref>, optional `acceptDateTime` and optional ETag combination."
parameters:
- description: "The setting to retrieve."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<ConfigurationSetting> getConfigurationSetting(ConfigurationSetting setting)"
desc: "Attempts to get the ConfigurationSetting with a matching <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref>, and optional <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref>, optional `acceptDateTime` and optional ETag combination. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>.\n\n**Code Samples**\n\nRetrieve the setting with the key \"prodDBConnection\" and a time that one minute before now at UTC-Zone\n\n```java\nclient.getConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```"
returns:
description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> stored in the service, or an empty Mono if the configuration value does\n not exist or the key is an invalid value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getConfigurationSetting(java.lang.String,java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getConfigurationSetting(String key, String label)"
name: "getConfigurationSetting(String key, String label)"
nameWithType: "ConfigurationAsyncClient.getConfigurationSetting(String key, String label)"
summary: "Attempts to get a Configuration<wbr>Setting that matches the `key`, and the optional `label` combination."
parameters:
- description: "The key of the setting to retrieve."
name: "key"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The label of the configuration setting to retrieve. If <code>null</code> no label will be used."
name: "label"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<ConfigurationSetting> getConfigurationSetting(String key, String label)"
desc: "Attempts to get a ConfigurationSetting that matches the `key`, and the optional `label` combination.\n\n**Code Samples**\n\nRetrieve the setting with the key \"prodDBConnection\".\n\n```java\nclient.getConfigurationSetting(\"prodDBConnection\", \"westUS\")\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```"
returns:
description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> stored in the service, or an empty Mono if the configuration value does\n not exist or the key is an invalid value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getConfigurationSetting(java.lang.String,java.lang.String,java.time.OffsetDateTime)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getConfigurationSetting(String key, String label, OffsetDateTime acceptDateTime)"
name: "getConfigurationSetting(String key, String label, OffsetDateTime acceptDateTime)"
nameWithType: "ConfigurationAsyncClient.getConfigurationSetting(String key, String label, OffsetDateTime acceptDateTime)"
summary: "Attempts to get a Configuration<wbr>Setting that matches the `key`, the optional `label`, and the optional `acceptDateTime` combination."
parameters:
- description: "The key of the setting to retrieve."
name: "key"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The label of the configuration setting to retrieve. If <code>null</code> no label will be used."
name: "label"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Datetime to access a past state of the configuration setting. If <code>null</code>\n then the current state of the configuration setting will be returned."
name: "acceptDateTime"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public Mono<ConfigurationSetting> getConfigurationSetting(String key, String label, OffsetDateTime acceptDateTime)"
desc: "Attempts to get a ConfigurationSetting that matches the `key`, the optional `label`, and the optional `acceptDateTime` combination.\n\n**Code Samples**\n\nRetrieve the setting with the key \"prodDBConnection\" and a time that one minute before now at UTC-Zone\n\n```java\nclient.getConfigurationSetting(\n \"prodDBConnection\", \"westUS\", OffsetDateTime.now(ZoneOffset.UTC).minusMinutes(1))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```"
returns:
description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> stored in the service, or an empty Mono if the configuration value does\n not exist or the key is an invalid value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getConfigurationSettingWithResponse(com.azure.data.appconfiguration.models.ConfigurationSetting,java.time.OffsetDateTime,boolean)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getConfigurationSettingWithResponse(ConfigurationSetting setting, OffsetDateTime acceptDateTime, boolean ifChanged)"
name: "getConfigurationSettingWithResponse(ConfigurationSetting setting, OffsetDateTime acceptDateTime, boolean ifChanged)"
nameWithType: "ConfigurationAsyncClient.getConfigurationSettingWithResponse(ConfigurationSetting setting, OffsetDateTime acceptDateTime, boolean ifChanged)"
summary: "Attempts to get the Configuration<wbr>Setting with a matching <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref>, and optional <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref>, optional `acceptDateTime` and optional ETag combination."
parameters:
- description: "The setting to retrieve."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
- description: "Datetime to access a past state of the configuration setting. If <code>null</code>\n then the current state of the configuration setting will be returned."
name: "acceptDateTime"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- description: "Flag indicating if the <code>setting</code> <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getETag*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ETag\"></xref> is used as a\n If-None-Match header."
name: "ifChanged"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<ConfigurationSetting>> getConfigurationSettingWithResponse(ConfigurationSetting setting, OffsetDateTime acceptDateTime, boolean ifChanged)"
desc: "Attempts to get the ConfigurationSetting with a matching <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref>, and optional <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLabel()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"label\"></xref>, optional `acceptDateTime` and optional ETag combination. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>.\n\n**Code Samples**\n\nRetrieve the setting with the key-label \"prodDBConnection\"-\"westUS\".\n\n```java\nclient.getConfigurationSettingWithResponse(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"),\n null,\n false)\n .contextWrite(Context.of(key1, value1, key2, value2))\n .subscribe(response -> {\n ConfigurationSetting result = response.getValue();\n System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n result.getKey(), result.getLabel(), result.getValue());\n });\n```"
returns:
description: "A REST response containing the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> stored in the service, or <code>null</code> if\n didn't exist. <code>null</code> is also returned if the configuration value does not exist or the key is an invalid\n value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getEndpoint()"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getEndpoint()"
name: "getEndpoint()"
nameWithType: "ConfigurationAsyncClient.getEndpoint()"
summary: "Gets the service endpoint for the Azure App Configuration instance."
syntax: "public String getEndpoint()"
desc: "Gets the service endpoint for the Azure App Configuration instance."
returns:
description: "the service endpoint for the Azure App Configuration instance."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getSnapshot(java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getSnapshot(String snapshotName)"
name: "getSnapshot(String snapshotName)"
nameWithType: "ConfigurationAsyncClient.getSnapshot(String snapshotName)"
summary: "Get a <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref> by given the snapshot name."
parameters:
- description: "the snapshot name."
name: "snapshotName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<ConfigurationSnapshot> getSnapshot(String snapshotName)"
desc: "Get a <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref> by given the snapshot name.\n\n**Code Samples**\n\n```java\nString snapshotName = \"{snapshotName}\";\n client.getSnapshot(snapshotName).subscribe(\n getSnapshot -> {\n System.out.printf(\"Snapshot name=%s is created at %s, snapshot status is %s.%n\",\n getSnapshot.getName(), getSnapshot.getCreatedAt(), getSnapshot.getStatus());\n }\n );\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot?alt=com.azure.data.appconfiguration.models.ConfigurationSnapshot&text=ConfigurationSnapshot\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getSnapshotWithResponse(java.lang.String,java.util.List<com.azure.data.appconfiguration.models.SnapshotFields>)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.getSnapshotWithResponse(String snapshotName, List<SnapshotFields> fields)"
name: "getSnapshotWithResponse(String snapshotName, List<SnapshotFields> fields)"
nameWithType: "ConfigurationAsyncClient.getSnapshotWithResponse(String snapshotName, List<SnapshotFields> fields)"
summary: "Get a <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref> by given the snapshot name."
parameters:
- description: "The snapshot name."
name: "snapshotName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Used to select what fields are present in the returned resource(s)."
name: "fields"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.data.appconfiguration.models.SnapshotFields?alt=com.azure.data.appconfiguration.models.SnapshotFields&text=SnapshotFields\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public Mono<Response<ConfigurationSnapshot>> getSnapshotWithResponse(String snapshotName, List<SnapshotFields> fields)"
desc: "Get a <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref> by given the snapshot name.\n\n**Code Samples**\n\n```java\nString snapshotName = \"{snapshotName}\";\n\n client.getSnapshotWithResponse(snapshotName, Arrays.asList(SnapshotFields.NAME, SnapshotFields.CREATED_AT,\n SnapshotFields.STATUS, SnapshotFields.FILTERS))\n .subscribe(\n response -> {\n ConfigurationSnapshot getSnapshot = response.getValue();\n // Only properties `name`, `createAt`, `status` and `filters` have value, and expect null or\n // empty value other than the `fields` specified in the request.\n System.out.printf(\"Snapshot name=%s is created at %s, snapshot status is %s.%n\",\n getSnapshot.getName(), getSnapshot.getCreatedAt(), getSnapshot.getStatus());\n List<ConfigurationSettingsFilter> filters = getSnapshot.getFilters();\n for (ConfigurationSettingsFilter filter : filters) {\n System.out.printf(\"Snapshot filter key=%s, label=%s.%n\", filter.getKey(), filter.getLabel());\n }\n });\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> of <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot?alt=com.azure.data.appconfiguration.models.ConfigurationSnapshot&text=ConfigurationSnapshot\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listConfigurationSettings(com.azure.data.appconfiguration.models.SettingSelector)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listConfigurationSettings(SettingSelector selector)"
name: "listConfigurationSettings(SettingSelector selector)"
nameWithType: "ConfigurationAsyncClient.listConfigurationSettings(SettingSelector selector)"
summary: "Fetches the configuration settings that match the `selector`."
parameters:
- description: "Optional. Selector to filter configuration setting results from the service."
name: "selector"
type: "<xref href=\"com.azure.data.appconfiguration.models.SettingSelector?alt=com.azure.data.appconfiguration.models.SettingSelector&text=SettingSelector\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedFlux<ConfigurationSetting> listConfigurationSettings(SettingSelector selector)"
desc: "Fetches the configuration settings that match the `selector`. If `selector` is `null`, then all the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"configuration settings\"></xref> are fetched with their current values.\n\n**Code Samples**\n\nRetrieve all settings that use the key \"prodDBConnection\".\n\n```java\nclient.listConfigurationSettings(new SettingSelector().setKeyFilter(\"prodDBConnection\"))\n .contextWrite(Context.of(key1, value1, key2, value2))\n .subscribe(setting ->\n System.out.printf(\"Key: %s, Value: %s\", setting.getKey(), setting.getValue()));\n```"
returns:
description: "A Flux of ConfigurationSettings that matches the <code>selector</code>. If no options were provided, the Flux\n contains all of the current settings in the service."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listConfigurationSettingsForSnapshot(java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listConfigurationSettingsForSnapshot(String snapshotName)"
name: "listConfigurationSettingsForSnapshot(String snapshotName)"
nameWithType: "ConfigurationAsyncClient.listConfigurationSettingsForSnapshot(String snapshotName)"
summary: "Fetches the configuration settings in a snapshot that matches the `snapshotName`."
parameters:
- description: "Optional. A filter used get <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref>s for a snapshot. The value should\n be the name of the snapshot."
name: "snapshotName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PagedFlux<ConfigurationSetting> listConfigurationSettingsForSnapshot(String snapshotName)"
desc: "Fetches the configuration settings in a snapshot that matches the `snapshotName`. If `snapshotName` is `null`, then all the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"configuration settings\"></xref> are fetched with their current values.\n\n**Code Samples**\n\n```java\nString snapshotName = \"{snapshotName}\";\n client.listConfigurationSettingsForSnapshot(snapshotName)\n .subscribe(setting ->\n System.out.printf(\"Key: %s, Value: %s\", setting.getKey(), setting.getValue()));\n```"
returns:
description: "A Flux of ConfigurationSettings that matches the <code>selector</code>. If no options were provided, the Flux\n contains all of the current settings in the service."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listConfigurationSettingsForSnapshot(java.lang.String,java.util.List<com.azure.data.appconfiguration.models.SettingFields>)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listConfigurationSettingsForSnapshot(String snapshotName, List<SettingFields> fields)"
name: "listConfigurationSettingsForSnapshot(String snapshotName, List<SettingFields> fields)"
nameWithType: "ConfigurationAsyncClient.listConfigurationSettingsForSnapshot(String snapshotName, List<SettingFields> fields)"
summary: "Fetches the configuration settings in a snapshot that matches the `snapshotName`."
parameters:
- description: "Optional. A filter used get <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref>s for a snapshot. The value should\n be the name of the snapshot."
name: "snapshotName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. The fields to select for the query response. If none are set, the service will return the\n ConfigurationSettings with a default set of properties."
name: "fields"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.data.appconfiguration.models.SettingFields?alt=com.azure.data.appconfiguration.models.SettingFields&text=SettingFields\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public PagedFlux<ConfigurationSetting> listConfigurationSettingsForSnapshot(String snapshotName, List<SettingFields> fields)"
desc: "Fetches the configuration settings in a snapshot that matches the `snapshotName`. If `snapshotName` is `null`, then all the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"configuration settings\"></xref> are fetched with their current values.\n\n**Code Samples**\n\n```java\nString snapshotName = \"{snapshotName}\";\n List<SettingFields> fields = Arrays.asList(SettingFields.KEY);\n client.listConfigurationSettingsForSnapshot(snapshotName, fields)\n .subscribe(setting ->\n System.out.printf(\"Key: %s, Value: %s\", setting.getKey(), setting.getValue()));\n```"
returns:
description: "A Flux of ConfigurationSettings that matches the <code>selector</code>. If no options were provided, the Flux\n contains all of the current settings in the service."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listRevisions(com.azure.data.appconfiguration.models.SettingSelector)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listRevisions(SettingSelector selector)"
name: "listRevisions(SettingSelector selector)"
nameWithType: "ConfigurationAsyncClient.listRevisions(SettingSelector selector)"
summary: "Lists chronological/historical representation of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> resource(s)."
parameters:
- description: "Optional. Used to filter configuration setting revisions from the service."
name: "selector"
type: "<xref href=\"com.azure.data.appconfiguration.models.SettingSelector?alt=com.azure.data.appconfiguration.models.SettingSelector&text=SettingSelector\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedFlux<ConfigurationSetting> listRevisions(SettingSelector selector)"
desc: "Lists chronological/historical representation of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> resource(s). Revisions are provided in descending order from their <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getLastModified()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"lastModified\"></xref> date. Revisions expire after a period of time, see [Pricing][] for more information. If `selector` is `null`, then all the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSettings\"></xref> are fetched in their current state. Otherwise, the results returned match the parameters given in `selector`.\n\n**Code Samples**\n\nRetrieve all revisions of the setting that has the key \"prodDBConnection\".\n\n```java\nclient.listRevisions(new SettingSelector().setKeyFilter(\"prodDBConnection\"))\n .contextWrite(Context.of(key1, value1, key2, value2))\n .subscribe(setting ->\n System.out.printf(\"Key: %s, Value: %s\", setting.getKey(), setting.getValue()));\n```\n\n\n[Pricing]: https://azure.microsoft.com/pricing/details/app-configuration/"
returns:
description: "Revisions of the ConfigurationSetting"
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listSnapshots(com.azure.data.appconfiguration.models.SnapshotSelector)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.listSnapshots(SnapshotSelector selector)"
name: "listSnapshots(SnapshotSelector selector)"
nameWithType: "ConfigurationAsyncClient.listSnapshots(SnapshotSelector selector)"
summary: "List snapshots by given <xref uid=\"com.azure.data.appconfiguration.models.SnapshotSelector\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SnapshotSelector\"></xref>."
parameters:
- description: "Optional. Used to filter <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref> from the service."
name: "selector"
type: "<xref href=\"com.azure.data.appconfiguration.models.SnapshotSelector?alt=com.azure.data.appconfiguration.models.SnapshotSelector&text=SnapshotSelector\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedFlux<ConfigurationSnapshot> listSnapshots(SnapshotSelector selector)"
desc: "List snapshots by given <xref uid=\"com.azure.data.appconfiguration.models.SnapshotSelector\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SnapshotSelector\"></xref>.\n\n**Code Samples**\n\n```java\nString snapshotNameFilter = \"{snapshotNamePrefix}*\";\n client.listSnapshots(new SnapshotSelector().setNameFilter(snapshotNameFilter))\n .subscribe(recoveredSnapshot -> {\n System.out.printf(\"Recovered snapshot name=%s is created at %s, snapshot status is %s.%n\",\n recoveredSnapshot.getName(), recoveredSnapshot.getCreatedAt(), recoveredSnapshot.getStatus());\n });\n```"
returns:
description: "A <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref> of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot?alt=com.azure.data.appconfiguration.models.ConfigurationSnapshot&text=ConfigurationSnapshot\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.recoverSnapshot(java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.recoverSnapshot(String snapshotName)"
name: "recoverSnapshot(String snapshotName)"
nameWithType: "ConfigurationAsyncClient.recoverSnapshot(String snapshotName)"
summary: "Update a snapshot status from <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.ARCHIVED\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#ARCHIVED\"></xref> to <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.READY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#READY\"></xref>."
parameters:
- description: "The snapshot name."
name: "snapshotName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<ConfigurationSnapshot> recoverSnapshot(String snapshotName)"
desc: "Update a snapshot status from <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.ARCHIVED\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#ARCHIVED\"></xref> to <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.READY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#READY\"></xref>.\n\n**Code Samples**\n\n```java\nString snapshotName = \"{snapshotName}\";\n client.recoverSnapshot(snapshotName).subscribe(\n recoveredSnapshot -> {\n System.out.printf(\"Recovered snapshot name=%s is created at %s, snapshot status is %s.%n\",\n recoveredSnapshot.getName(), recoveredSnapshot.getCreatedAt(), recoveredSnapshot.getStatus());\n }\n );\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot?alt=com.azure.data.appconfiguration.models.ConfigurationSnapshot&text=ConfigurationSnapshot\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.recoverSnapshotWithResponse(java.lang.String,com.azure.core.http.MatchConditions)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.recoverSnapshotWithResponse(String snapshotName, MatchConditions matchConditions)"
name: "recoverSnapshotWithResponse(String snapshotName, MatchConditions matchConditions)"
nameWithType: "ConfigurationAsyncClient.recoverSnapshotWithResponse(String snapshotName, MatchConditions matchConditions)"
summary: "Update a snapshot status from <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.ARCHIVED\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#ARCHIVED\"></xref> to <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.READY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#READY\"></xref>."
parameters:
- description: "The snapshot name."
name: "snapshotName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Specifies HTTP options for conditional requests."
name: "matchConditions"
type: "<xref href=\"com.azure.core.http.MatchConditions?alt=com.azure.core.http.MatchConditions&text=MatchConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<ConfigurationSnapshot>> recoverSnapshotWithResponse(String snapshotName, MatchConditions matchConditions)"
desc: "Update a snapshot status from <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.ARCHIVED\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#ARCHIVED\"></xref> to <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshotStatus.READY\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshotStatus#READY\"></xref>.\n\nTo turn on using 'if-match' header, set the second parameter 'ifUnchanged' to true. It used to perform an operation only if the targeted resource's ETag matches the value provided. Otherwise, it will throw an exception '412 Precondition Failed'.\n\n**Code Samples**\n\n```java\nString snapshotName = \"{snapshotName}\";\n MatchConditions matchConditions = new MatchConditions().setIfMatch(\"{etag}\");\n client.recoverSnapshotWithResponse(snapshotName, matchConditions).subscribe(\n response -> {\n ConfigurationSnapshot recoveredSnapshot = response.getValue();\n System.out.printf(\"Recovered snapshot name=%s is created at %s, snapshot status is %s.%n\",\n recoveredSnapshot.getName(), recoveredSnapshot.getCreatedAt(), recoveredSnapshot.getStatus());\n }\n );\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> of <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSnapshot\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSnapshot?alt=com.azure.data.appconfiguration.models.ConfigurationSnapshot&text=ConfigurationSnapshot\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setConfigurationSetting(ConfigurationSetting setting)"
name: "setConfigurationSetting(ConfigurationSetting setting)"
nameWithType: "ConfigurationAsyncClient.setConfigurationSetting(ConfigurationSetting setting)"
summary: "Creates or updates a configuration value in the service."
parameters:
- description: "The setting to add based on its key and optional label combination."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<ConfigurationSetting> setConfigurationSetting(ConfigurationSetting setting)"
desc: "Creates or updates a configuration value in the service. Partial updates are not supported and the entire configuration setting is updated. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>.\n\n**Code Samples**\n\nAdd a setting with the key \"prodDBConnection\", \"westUS\" and value \"db\\_connection\"\n\nUpdate setting's value \"db\\_connection\" to \"updated\\_db\\_connection\"\n\n```java\nclient.setConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n // Update the value of the setting to \"updated_db_connection\"\n client.setConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"updated_db_connection\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```"
returns:
description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that was created or updated, or an empty Mono if the key is an invalid\n value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setConfigurationSetting(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setConfigurationSetting(String key, String label, String value)"
name: "setConfigurationSetting(String key, String label, String value)"
nameWithType: "ConfigurationAsyncClient.setConfigurationSetting(String key, String label, String value)"
summary: "Creates or updates a configuration value in the service with the given key."
parameters:
- description: "The key of the configuration setting to create or update."
name: "key"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The label of the configuration setting to create or update, If <code>null</code> no label will be used."
name: "label"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The value of this configuration setting."
name: "value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<ConfigurationSetting> setConfigurationSetting(String key, String label, String value)"
desc: "Creates or updates a configuration value in the service with the given key. the `label` is optional.\n\n**Code Samples**\n\nAdd a setting with the key \"prodDBConnection\", \"westUS\" and value \"db\\_connection\"\n\nUpdate setting's value \"db\\_connection\" to \"updated\\_db\\_connection\"\n\n```java\nclient.setConfigurationSetting(\"prodDBConnection\", \"westUS\", \"db_connection\")\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n // Update the value of the setting to \"updated_db_connection\"\n client.setConfigurationSetting(\"prodDBConnection\", \"westUS\", \"updated_db_connection\")\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```"
returns:
description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that was created or updated, or an empty Mono if the key is an invalid\n value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setConfigurationSettingWithResponse(com.azure.data.appconfiguration.models.ConfigurationSetting,boolean)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setConfigurationSettingWithResponse(ConfigurationSetting setting, boolean ifUnchanged)"
name: "setConfigurationSettingWithResponse(ConfigurationSetting setting, boolean ifUnchanged)"
nameWithType: "ConfigurationAsyncClient.setConfigurationSettingWithResponse(ConfigurationSetting setting, boolean ifUnchanged)"
summary: "Creates or updates a configuration value in the service."
parameters:
- description: "The setting to create or update based on its key, optional label and optional ETag combination."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
- description: "Flag indicating if the <code>setting</code> <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getETag*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ETag\"></xref> is used as a\n IF-MATCH header."
name: "ifUnchanged"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<ConfigurationSetting>> setConfigurationSettingWithResponse(ConfigurationSetting setting, boolean ifUnchanged)"
desc: "Creates or updates a configuration value in the service. Partial updates are not supported and the entire configuration setting is updated. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>. If <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getETag()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ETag\"></xref> is specified, the configuration value is updated if the current setting's ETag matches. If the ETag's value is equal to the wildcard character (`\"*\"`), the setting will always be updated.\n\n**Code Samples**\n\nAdd a setting with the key \"prodDBConnection\", label \"westUS\", and value \"db\\_connection\".\n\nUpdate setting's value \"db\\_connection\" to \"updated\\_db\\_connection\"\n\n```java\nclient.setConfigurationSettingWithResponse(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"db_connection\"),\n false)\n .subscribe(response -> {\n final ConfigurationSetting result = response.getValue();\n System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n result.getKey(), result.getLabel(), result.getValue());\n });\n // Update the value of the setting to \"updated_db_connection\"\n client.setConfigurationSettingWithResponse(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"updated_db_connection\"),\n false)\n .subscribe(response -> {\n final ConfigurationSetting responseSetting = response.getValue();\n System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n responseSetting.getKey(), responseSetting.getLabel(), responseSetting.getValue());\n });\n```"
returns:
description: "A REST response containing the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that was created or updated, if the key is an\n invalid value, the setting is read-only, or an ETag was provided but does not match the service's current ETag\n value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setReadOnly(com.azure.data.appconfiguration.models.ConfigurationSetting,boolean)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setReadOnly(ConfigurationSetting setting, boolean isReadOnly)"
name: "setReadOnly(ConfigurationSetting setting, boolean isReadOnly)"
nameWithType: "ConfigurationAsyncClient.setReadOnly(ConfigurationSetting setting, boolean isReadOnly)"
summary: "Sets the read-only status for the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref>."
parameters:
- description: "The configuration setting to set to read-only or not read-only based on the <code>isReadOnly</code>."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
- description: "Flag used to set the read-only status of the configuration. <code>true</code> will put the\n configuration into a read-only state, <code>false</code> will clear the state."
name: "isReadOnly"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<ConfigurationSetting> setReadOnly(ConfigurationSetting setting, boolean isReadOnly)"
desc: "Sets the read-only status for the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref>. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>.\n\n**Code Samples**\n\nSet the setting to read-only with the key-label \"prodDBConnection\"-\"westUS\".\n\n```java\nclient.setReadOnly(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"),\n true)\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```\n\nClear read-only of the setting with the key-label \"prodDBConnection\"-\"westUS\".\n\n```java\nclient.setReadOnly(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"),\n false)\n .subscribe(response -> System.out.printf(\"Key: %s, Value: %s\", response.getKey(), response.getValue()));\n```"
returns:
description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that is read-only, or an empty Mono if a key collision occurs or the\n key is an invalid value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setReadOnly(java.lang.String,java.lang.String,boolean)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setReadOnly(String key, String label, boolean isReadOnly)"
name: "setReadOnly(String key, String label, boolean isReadOnly)"
nameWithType: "ConfigurationAsyncClient.setReadOnly(String key, String label, boolean isReadOnly)"
summary: "Sets the read-only status for the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that matches the `key`, the optional `label`."
parameters:
- description: "The key of configuration setting to set to be read-only."
name: "key"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The label of configuration setting to read-only. If <code>null</code> no label will be used."
name: "label"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Flag used to set the read-only status of the configuration. <code>true</code> will put the\n configuration into a read-only state, <code>false</code> will clear the state."
name: "isReadOnly"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<ConfigurationSetting> setReadOnly(String key, String label, boolean isReadOnly)"
desc: "Sets the read-only status for the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that matches the `key`, the optional `label`.\n\n**Code Samples**\n\nSet the setting to read-only with the key-label \"prodDBConnection\"-\"westUS\".\n\n```java\nclient.setReadOnly(\"prodDBConnection\", \"westUS\", true)\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```\n\nClear read-only of the setting with the key-label \"prodDBConnection\"-\"westUS\".\n\n```java\nclient.setReadOnly(\"prodDBConnection\", \"westUS\", false)\n .contextWrite(Context.of(key1, value1, key2, value2))\n .subscribe(response -> System.out.printf(\"Key: %s, Value: %s\", response.getKey(), response.getValue()));\n```"
returns:
description: "The <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref> that is read-only, or an empty Mono if a key collision occurs or the\n key is an invalid value (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setReadOnlyWithResponse(com.azure.data.appconfiguration.models.ConfigurationSetting,boolean)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.setReadOnlyWithResponse(ConfigurationSetting setting, boolean isReadOnly)"
name: "setReadOnlyWithResponse(ConfigurationSetting setting, boolean isReadOnly)"
nameWithType: "ConfigurationAsyncClient.setReadOnlyWithResponse(ConfigurationSetting setting, boolean isReadOnly)"
summary: "Sets the read-only status for the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref>."
parameters:
- description: "The configuration setting to set to read-only or not read-only based on the <code>isReadOnly</code>."
name: "setting"
type: "<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />"
- description: "Flag used to set the read-only status of the configuration. <code>true</code> will put the\n configuration into a read-only state, <code>false</code> will clear the state."
name: "isReadOnly"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<ConfigurationSetting>> setReadOnlyWithResponse(ConfigurationSetting setting, boolean isReadOnly)"
desc: "Sets the read-only status for the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSetting\"></xref>. For more configuration setting types, see <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> and <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref>.\n\n**Code Samples**\n\nSet the setting to read-only with the key-label \"prodDBConnection\"-\"westUS\".\n\n```java\nclient.setReadOnlyWithResponse(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"),\n true)\n .subscribe(response -> {\n ConfigurationSetting result = response.getValue();\n System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n result.getKey(), result.getLabel(), result.getValue());\n });\n```\n\nClear read-only of the setting with the key-label \"prodDBConnection\"-\"westUS\".\n\n```java\nclient.setReadOnlyWithResponse(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"),\n false)\n .contextWrite(Context.of(key1, value1, key2, value2))\n .subscribe(response -> {\n ConfigurationSetting result = response.getValue();\n System.out.printf(\"Key: %s, Value: %s\", result.getKey(), result.getValue());\n });\n```"
returns:
description: "A REST response containing the read-only or not read-only ConfigurationSetting if <code>isReadOnly</code>\n is true or null, or false respectively. Or return <code>null</code> if the setting didn't exist.\n <code>null</code> is also returned if the <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting.getKey()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"key\"></xref> is an invalid value.\n (which will also throw HttpResponseException described below)."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.data.appconfiguration.models.ConfigurationSetting?alt=com.azure.data.appconfiguration.models.ConfigurationSetting&text=ConfigurationSetting\" data-throw-if-not-resolved=\"False\" />>>"
- uid: "com.azure.data.appconfiguration.ConfigurationAsyncClient.updateSyncToken(java.lang.String)"
fullName: "com.azure.data.appconfiguration.ConfigurationAsyncClient.updateSyncToken(String token)"
name: "updateSyncToken(String token)"
nameWithType: "ConfigurationAsyncClient.updateSyncToken(String token)"
summary: "Adds an external synchronization token to ensure service requests receive up-to-date values."
parameters:
- description: "an external synchronization token to ensure service requests receive up-to-date values."
name: "token"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public void updateSyncToken(String token)"
desc: "Adds an external synchronization token to ensure service requests receive up-to-date values."
type: "class"
desc: "This class provides a client that contains all the operations for <xref uid=\"com.azure.data.appconfiguration.models.ConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ConfigurationSettings\"></xref>, <xref uid=\"com.azure.data.appconfiguration.models.FeatureFlagConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FeatureFlagConfigurationSetting\"></xref> or <xref uid=\"com.azure.data.appconfiguration.models.SecretReferenceConfigurationSetting\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SecretReferenceConfigurationSetting\"></xref> in Azure App Configuration Store. Operations allowed by the client are adding, retrieving, deleting, set read-only status ConfigurationSettings, and listing settings or revision of a setting based on a <xref uid=\"com.azure.data.appconfiguration.models.SettingSelector\" data-throw-if-not-resolved=\"false\" data-raw-source=\"filter\"></xref>.\n\nAdditionally, this class allows to add an external synchronization token to ensure service requests receive up-to-date values. Use the <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient.updateSyncToken(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"updateSyncToken\"></xref> method.\n\n## Getting Started ##\n\nIn order to interact with the App Configuration service you'll need to create an instance of the <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\"></xref> 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**Instantiating an asynchronous Configuration Client**\n\n```java\nConfigurationAsyncClient configurationAsyncClient = new ConfigurationClientBuilder()\n .connectionString(connectionString)\n .buildAsyncClient();\n```\n\nView <xref uid=\"com.azure.data.appconfiguration.ConfigurationClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> for additional ways to construct the client.\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.ConfigurationAsyncClient.addConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient#addConfigurationSetting(ConfigurationSetting)\"></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.ConfigurationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient\"></xref>.\n\n```java\nclient.addConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"db_connection\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```\n\n**Note:** For synchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>.\n\n\n--------------------\n\n## Update Configuration Setting ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient.setConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient#setConfigurationSetting(ConfigurationSetting)\"></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\nclient.setConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n // Update the value of the setting to \"updated_db_connection\"\n client.setConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\")\n .setValue(\"updated_db_connection\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```\n\n**Note:** For synchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>.\n\n\n--------------------\n\n## Get Configuration Setting ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient.getConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient#getConfigurationSetting(ConfigurationSetting)\"></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\nclient.getConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```\n\n**Note:** For synchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>.\n\n\n--------------------\n\n## Delete Configuration Setting ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient.deleteConfigurationSetting(com.azure.data.appconfiguration.models.ConfigurationSetting)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient#deleteConfigurationSetting(ConfigurationSetting)\"></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\nclient.deleteConfigurationSetting(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"))\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getValue()));\n```\n\n**Note:** For synchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>.\n\n\n--------------------\n\n## Set the Configuration Setting to read-only ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient.setReadOnly(com.azure.data.appconfiguration.models.ConfigurationSetting,boolean)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient#setReadOnly(ConfigurationSetting, boolean)\"></xref> method can be used to conditionally set a configuration setting to read-only in the Azure App Configuration.\n\nThe sample below shows how to conditionally set the setting to read-only with the key \"prodDBConnection\".\n\n```java\nclient.setReadOnly(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"),\n true)\n .subscribe(response -> System.out.printf(\"Key: %s, Label: %s, Value: %s\",\n response.getKey(), response.getLabel(), response.getValue()));\n```\n\n**Note:** For synchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>.\n\n\n--------------------\n\n## Clear read-only of the Configuration Setting ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient.setReadOnly(com.azure.data.appconfiguration.models.ConfigurationSetting,boolean)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient#setReadOnly(ConfigurationSetting, boolean)\"></xref> method can be used to conditionally clear read-only of the setting in the Azure App Configuration.\n\nThe sample below shows how to conditionally clear read-only of the setting with the key \"prodDBConnection\".\n\n```java\nclient.setReadOnly(new ConfigurationSetting()\n .setKey(\"prodDBConnection\")\n .setLabel(\"westUS\"),\n false)\n .subscribe(response -> System.out.printf(\"Key: %s, Value: %s\", response.getKey(), response.getValue()));\n```\n\n**Note:** For synchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>.\n\n\n--------------------\n\n## List Configuration Settings ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient.listConfigurationSettings(com.azure.data.appconfiguration.models.SettingSelector)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient#listConfigurationSettings(SettingSelector)\"></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\nclient.listConfigurationSettings(new SettingSelector().setKeyFilter(\"prodDBConnection\"))\n .contextWrite(Context.of(key1, value1, key2, value2))\n .subscribe(setting ->\n System.out.printf(\"Key: %s, Value: %s\", setting.getKey(), setting.getValue()));\n```\n\n**Note:** For synchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>.\n\n\n--------------------\n\n## List revisions of a Configuration Setting ##\n\nThe <xref uid=\"com.azure.data.appconfiguration.ConfigurationAsyncClient.listRevisions(com.azure.data.appconfiguration.models.SettingSelector)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationAsyncClient#listRevisions(SettingSelector)\"></xref> method can be used to list all revisions of a configuration setting in the Azure App Configuration.\n\nThe sample below shows how to list all revision of a setting that use the key \"prodDBConnection\".\n\n```java\nclient.listRevisions(new SettingSelector().setKeyFilter(\"prodDBConnection\"))\n .contextWrite(Context.of(key1, value1, key2, value2))\n .subscribe(setting ->\n System.out.printf(\"Key: %s, Value: %s\", setting.getKey(), setting.getValue()));\n```\n\n**Note:** For synchronous sample, refer to <xref uid=\"com.azure.data.appconfiguration.ConfigurationClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.data.appconfiguration.ConfigurationClient\"></xref>.\n\n\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.6.0