BlocklistClient.GetTextBlocklist Method

  • Reference

Definition

Namespace:
Azure.AI.ContentSafety
Assembly:
Azure.AI.ContentSafety.dll
Package:
Azure.AI.ContentSafety v1.0.0

Overloads

GetTextBlocklist(String, RequestContext)

[Protocol Method] Get Text Blocklist By blocklistName
GetTextBlocklist(String, CancellationToken)

Get Text Blocklist By blocklistName.

GetTextBlocklist(String, RequestContext)

Source:
BlocklistClient.cs

[Protocol Method] Get Text Blocklist By blocklistName

public virtual Azure.Response GetTextBlocklist (string name, Azure.RequestContext context);
abstract member GetTextBlocklist : string * Azure.RequestContext -> Azure.Response
override this.GetTextBlocklist : string * Azure.RequestContext -> Azure.Response
Public Overridable Function GetTextBlocklist (name As String, context As RequestContext) As Response

Parameters

name
String

Text blocklist name.

context
RequestContext

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

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

name is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call GetTextBlocklist and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
BlocklistClient client = new BlocklistClient(endpoint, credential);

Response response = client.GetTextBlocklist("<Name>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("blocklistName").ToString());

This sample shows how to call GetTextBlocklist with all parameters and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
BlocklistClient client = new BlocklistClient(endpoint, credential);

Response response = client.GetTextBlocklist("<Name>", null);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("blocklistName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());

Applies to

GetTextBlocklist(String, CancellationToken)

Source:
BlocklistClient.cs

Get Text Blocklist By blocklistName.

public virtual Azure.Response<Azure.AI.ContentSafety.TextBlocklist> GetTextBlocklist (string name, System.Threading.CancellationToken cancellationToken = default);
abstract member GetTextBlocklist : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.ContentSafety.TextBlocklist>
override this.GetTextBlocklist : string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.ContentSafety.TextBlocklist>
Public Overridable Function GetTextBlocklist (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TextBlocklist)

Parameters

name
String

Text blocklist name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response<TextBlocklist>

Exceptions

ArgumentNullException

name is null.

ArgumentException

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

Examples

This sample shows how to call GetTextBlocklist.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
BlocklistClient client = new BlocklistClient(endpoint, credential);

Response<TextBlocklist> response = client.GetTextBlocklist("<Name>");

This sample shows how to call GetTextBlocklist with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
BlocklistClient client = new BlocklistClient(endpoint, credential);

Response<TextBlocklist> response = client.GetTextBlocklist("<Name>");

Remarks

Returns text blocklist details.

Applies to