ConfigurationClient.DeleteConfigurationSettingAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| DeleteConfigurationSettingAsync(ConfigurationSetting, Boolean, CancellationToken) |
Delete a ConfigurationSetting from the configuration store. |
| DeleteConfigurationSettingAsync(String, String, CancellationToken) |
Delete a ConfigurationSetting from the configuration store. |
DeleteConfigurationSettingAsync(ConfigurationSetting, Boolean, CancellationToken)
- Source:
- ConfigurationClient.cs
- Source:
- ConfigurationClient.cs
Delete a ConfigurationSetting from the configuration store.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteConfigurationSettingAsync (Azure.Data.AppConfiguration.ConfigurationSetting setting, bool onlyIfUnchanged = false, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteConfigurationSettingAsync : Azure.Data.AppConfiguration.ConfigurationSetting * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteConfigurationSettingAsync : Azure.Data.AppConfiguration.ConfigurationSetting * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteConfigurationSettingAsync (setting As ConfigurationSetting, Optional onlyIfUnchanged As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- setting
- ConfigurationSetting
The ConfigurationSetting to delete.
- onlyIfUnchanged
- Boolean
If set to true and the configuration setting exists in the configuration store, delete the setting if the passed-in ConfigurationSetting is the same version as the one in the configuration store. The setting versions are the same if their ETag fields match. If the two settings are different versions, this method will throw an exception to indicate that the setting in the configuration store was modified since it was last obtained by the client.
- cancellationToken
- CancellationToken
A CancellationToken controlling the request lifetime.
Returns
A response indicating the success of the operation.
Applies to
DeleteConfigurationSettingAsync(String, String, CancellationToken)
- Source:
- ConfigurationClient.cs
- Source:
- ConfigurationClient.cs
Delete a ConfigurationSetting from the configuration store.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteConfigurationSettingAsync (string key, string label = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteConfigurationSettingAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteConfigurationSettingAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function DeleteConfigurationSettingAsync (key As String, Optional label As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)Parameters
- key
- String
The primary identifier of the configuration setting.
- label
- String
A label used to group this configuration setting with others.
- cancellationToken
- CancellationToken
A CancellationToken controlling the request lifetime.
Returns
A response indicating the success of the operation.
