Share via


Glossary.DeleteAsync(String, RequestContext) Method

Definition

[Protocol Method] Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<Azure.Response> DeleteAsync (string glossaryId, Azure.RequestContext context = default);
abstract member DeleteAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function DeleteAsync (glossaryId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

glossaryId
String

The globally unique identifier for glossary.

context
RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

The response returned from the service.

Exceptions

glossaryId is null.

glossaryId is an empty string, and was expected to be non-empty.

Service returned a non-success status code.

Examples

This sample shows how to call DeleteAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response response = await client.DeleteAsync("<glossaryId>");

Console.WriteLine(response.Status);

This sample shows how to call DeleteAsync with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
Glossary client = new DataMapClient(endpoint, credential).GetGlossaryClient();

Response response = await client.DeleteAsync("<glossaryId>");

Console.WriteLine(response.Status);

Applies to