xml/Azure.AI.ContentSafety/BlocklistClient.xml

<Type Name="BlocklistClient" FullName="Azure.AI.ContentSafety.BlocklistClient"> <TypeSignature Language="C#" Value="public class BlocklistClient" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit BlocklistClient extends System.Object" /> <TypeSignature Language="DocId" Value="T:Azure.AI.ContentSafety.BlocklistClient" /> <TypeSignature Language="VB.NET" Value="Public Class BlocklistClient" /> <TypeSignature Language="F#" Value="type BlocklistClient = class" /> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces /> <Docs> <summary> The Blocklist service client. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected BlocklistClient ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.#ctor" /> <MemberSignature Language="VB.NET" Value="Protected Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary> Initializes a new instance of BlocklistClient for mocking. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public BlocklistClient (Uri endpoint, Azure.AzureKeyCredential credential);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.#ctor(System.Uri,Azure.AzureKeyCredential)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential)" /> <MemberSignature Language="F#" Value="new Azure.AI.ContentSafety.BlocklistClient : Uri * Azure.AzureKeyCredential -> Azure.AI.ContentSafety.BlocklistClient" Usage="new Azure.AI.ContentSafety.BlocklistClient (endpoint, credential)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.AzureKeyCredential" /> </Parameters> <Docs> <param name="endpoint"> Supported Cognitive Services endpoints (protocol and hostname, for example: https://<resource-name>.cognitiveservices.azure.com). </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <summary> Initializes a new instance of BlocklistClient. </summary> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public BlocklistClient (Uri endpoint, Azure.Core.TokenCredential credential);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.#ctor(System.Uri,Azure.Core.TokenCredential)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" /> <MemberSignature Language="F#" Value="new Azure.AI.ContentSafety.BlocklistClient : Uri * Azure.Core.TokenCredential -> Azure.AI.ContentSafety.BlocklistClient" Usage="new Azure.AI.ContentSafety.BlocklistClient (endpoint, credential)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> </Parameters> <Docs> <param name="endpoint"> Supported Cognitive Services endpoints (protocol and hostname, for example: https://<resource-name>.cognitiveservices.azure.com). </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <summary> Initializes a new instance of BlocklistClient. </summary> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public BlocklistClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.AI.ContentSafety.ContentSafetyClientOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, class Azure.AI.ContentSafety.ContentSafetyClientOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.AI.ContentSafety.ContentSafetyClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, options As ContentSafetyClientOptions)" /> <MemberSignature Language="F#" Value="new Azure.AI.ContentSafety.BlocklistClient : Uri * Azure.AzureKeyCredential * Azure.AI.ContentSafety.ContentSafetyClientOptions -> Azure.AI.ContentSafety.BlocklistClient" Usage="new Azure.AI.ContentSafety.BlocklistClient (endpoint, credential, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.AzureKeyCredential" /> <Parameter Name="options" Type="Azure.AI.ContentSafety.ContentSafetyClientOptions" /> </Parameters> <Docs> <param name="endpoint"> Supported Cognitive Services endpoints (protocol and hostname, for example: https://<resource-name>.cognitiveservices.azure.com). </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <param name="options"> The options for configuring the client. </param> <summary> Initializes a new instance of BlocklistClient. </summary> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public BlocklistClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.ContentSafety.ContentSafetyClientOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.AI.ContentSafety.ContentSafetyClientOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.AI.ContentSafety.ContentSafetyClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As ContentSafetyClientOptions)" /> <MemberSignature Language="F#" Value="new Azure.AI.ContentSafety.BlocklistClient : Uri * Azure.Core.TokenCredential * Azure.AI.ContentSafety.ContentSafetyClientOptions -> Azure.AI.ContentSafety.BlocklistClient" Usage="new Azure.AI.ContentSafety.BlocklistClient (endpoint, credential, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> <Parameter Name="options" Type="Azure.AI.ContentSafety.ContentSafetyClientOptions" /> </Parameters> <Docs> <param name="endpoint"> Supported Cognitive Services endpoints (protocol and hostname, for example: https://<resource-name>.cognitiveservices.azure.com). </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <param name="options"> The options for configuring the client. </param> <summary> Initializes a new instance of BlocklistClient. </summary> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception> </Docs> </Member> <Member MemberName="AddOrUpdateBlocklistItems"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult> AddOrUpdateBlocklistItems (string name, Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult> AddOrUpdateBlocklistItems(string name, class Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.AddOrUpdateBlocklistItems(System.String,Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBlocklistItems (name As String, options As AddOrUpdateTextBlocklistItemsOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AddOrUpdateTextBlocklistItemsResult)" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBlocklistItems : string * Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult>
override this.AddOrUpdateBlocklistItems : string * Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult>" Usage="blocklistClient.AddOrUpdateBlocklistItems (name, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="options"> Options for adding or updating blocklist items. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add or update BlocklistItems To Text Blocklist. </summary> <returns>To be added.</returns> <remarks> Add or update blocklistItems to a text blocklist. You can add or update at most 100 blocklistItems in one request. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="options" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddOrUpdateBlocklistItems. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); AddOrUpdateTextBlocklistItemsOptions options = new AddOrUpdateTextBlocklistItemsOptions(new TextBlocklistItem[] { new TextBlocklistItem("<text>") }); Response<AddOrUpdateTextBlocklistItemsResult> response = client.AddOrUpdateBlocklistItems("<Name>", options); ]]></code> This sample shows how to call AddOrUpdateBlocklistItems with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); AddOrUpdateTextBlocklistItemsOptions options = new AddOrUpdateTextBlocklistItemsOptions(new TextBlocklistItem[] { new TextBlocklistItem("<text>") { Description = "<description>", } }); Response<AddOrUpdateTextBlocklistItemsResult> response = client.AddOrUpdateBlocklistItems("<Name>", options); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBlocklistItems"> <MemberSignature Language="C#" Value="public virtual Azure.Response AddOrUpdateBlocklistItems (string name, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AddOrUpdateBlocklistItems(string name, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.AddOrUpdateBlocklistItems(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBlocklistItems (name As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBlocklistItems : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AddOrUpdateBlocklistItems : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="blocklistClient.AddOrUpdateBlocklistItems (name, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add or update BlocklistItems To Text Blocklist <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.AddOrUpdateBlocklistItems(System.String,Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddOrUpdateBlocklistItems and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistItems = new object[] { new { text = "<text>", } }, }); Response response = client.AddOrUpdateBlocklistItems("<Name>", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("text").ToString()); ]]></code> This sample shows how to call AddOrUpdateBlocklistItems with all parameters and request content and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistItems = new object[] { new { description = "<description>", text = "<text>", } }, }); Response response = client.AddOrUpdateBlocklistItems("<Name>", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("text").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBlocklistItemsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult>> AddOrUpdateBlocklistItemsAsync (string name, Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult>> AddOrUpdateBlocklistItemsAsync(string name, class Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.AddOrUpdateBlocklistItemsAsync(System.String,Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBlocklistItemsAsync (name As String, options As AddOrUpdateTextBlocklistItemsOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AddOrUpdateTextBlocklistItemsResult))" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBlocklistItemsAsync : string * Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult>>
override this.AddOrUpdateBlocklistItemsAsync : string * Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult>>" Usage="blocklistClient.AddOrUpdateBlocklistItemsAsync (name, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsResult>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="options"> Options for adding or updating blocklist items. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Add or update BlocklistItems To Text Blocklist. </summary> <returns>To be added.</returns> <remarks> Add or update blocklistItems to a text blocklist. You can add or update at most 100 blocklistItems in one request. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="options" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call AddOrUpdateBlocklistItemsAsync. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); AddOrUpdateTextBlocklistItemsOptions options = new AddOrUpdateTextBlocklistItemsOptions(new TextBlocklistItem[] { new TextBlocklistItem("<text>") }); Response<AddOrUpdateTextBlocklistItemsResult> response = await client.AddOrUpdateBlocklistItemsAsync("<Name>", options); ]]></code> This sample shows how to call AddOrUpdateBlocklistItemsAsync with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); AddOrUpdateTextBlocklistItemsOptions options = new AddOrUpdateTextBlocklistItemsOptions(new TextBlocklistItem[] { new TextBlocklistItem("<text>") { Description = "<description>", } }); Response<AddOrUpdateTextBlocklistItemsResult> response = await client.AddOrUpdateBlocklistItemsAsync("<Name>", options); ]]></code></example> </Docs> </Member> <Member MemberName="AddOrUpdateBlocklistItemsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AddOrUpdateBlocklistItemsAsync (string name, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AddOrUpdateBlocklistItemsAsync(string name, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.AddOrUpdateBlocklistItemsAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AddOrUpdateBlocklistItemsAsync (name As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member AddOrUpdateBlocklistItemsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AddOrUpdateBlocklistItemsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="blocklistClient.AddOrUpdateBlocklistItemsAsync (name, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Add or update BlocklistItems To Text Blocklist <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.AddOrUpdateBlocklistItemsAsync(System.String,Azure.AI.ContentSafety.AddOrUpdateTextBlocklistItemsOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call AddOrUpdateBlocklistItemsAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistItems = new object[] { new { text = "<text>", } }, }); Response response = await client.AddOrUpdateBlocklistItemsAsync("<Name>", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("text").ToString()); ]]></code> This sample shows how to call AddOrUpdateBlocklistItemsAsync with all parameters and request content and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistItems = new object[] { new { description = "<description>", text = "<text>", } }, }); Response response = await client.AddOrUpdateBlocklistItemsAsync("<Name>", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("blocklistItems")[0].GetProperty("text").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateOrUpdateTextBlocklist"> <MemberSignature Language="C#" Value="public virtual Azure.Response CreateOrUpdateTextBlocklist (string name, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response CreateOrUpdateTextBlocklist(string name, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.CreateOrUpdateTextBlocklist(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdateTextBlocklist (name As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member CreateOrUpdateTextBlocklist : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateOrUpdateTextBlocklist : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="blocklistClient.CreateOrUpdateTextBlocklist (name, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Create Or Update Text Blocklist <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateOrUpdateTextBlocklist and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistName = "<blocklistName>", }); Response response = client.CreateOrUpdateTextBlocklist("<Name>", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); ]]></code> This sample shows how to call CreateOrUpdateTextBlocklist with all parameters and request content and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistName = "<blocklistName>", description = "<description>", }); Response response = client.CreateOrUpdateTextBlocklist("<Name>", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateOrUpdateTextBlocklistAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CreateOrUpdateTextBlocklistAsync (string name, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> CreateOrUpdateTextBlocklistAsync(string name, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.CreateOrUpdateTextBlocklistAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdateTextBlocklistAsync (name As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member CreateOrUpdateTextBlocklistAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateOrUpdateTextBlocklistAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="blocklistClient.CreateOrUpdateTextBlocklistAsync (name, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Create Or Update Text Blocklist <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateOrUpdateTextBlocklistAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistName = "<blocklistName>", }); Response response = await client.CreateOrUpdateTextBlocklistAsync("<Name>", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); ]]></code> This sample shows how to call CreateOrUpdateTextBlocklistAsync with all parameters and request content and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistName = "<blocklistName>", description = "<description>", }); Response response = await client.CreateOrUpdateTextBlocklistAsync("<Name>", content); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteTextBlocklist"> <MemberSignature Language="C#" Value="public virtual Azure.Response DeleteTextBlocklist (string name, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DeleteTextBlocklist(string name, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.DeleteTextBlocklist(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteTextBlocklist (name As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member DeleteTextBlocklist : string * Azure.RequestContext -> Azure.Response
override this.DeleteTextBlocklist : string * Azure.RequestContext -> Azure.Response" Usage="blocklistClient.DeleteTextBlocklist (name, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete Text Blocklist By blocklistName <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteTextBlocklist. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = client.DeleteTextBlocklist("<Name>"); Console.WriteLine(response.Status); ]]></code> This sample shows how to call DeleteTextBlocklist with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = client.DeleteTextBlocklist("<Name>"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteTextBlocklistAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteTextBlocklistAsync (string name, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteTextBlocklistAsync(string name, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.DeleteTextBlocklistAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteTextBlocklistAsync (name As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member DeleteTextBlocklistAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteTextBlocklistAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="blocklistClient.DeleteTextBlocklistAsync (name, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Delete Text Blocklist By blocklistName <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteTextBlocklistAsync. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = await client.DeleteTextBlocklistAsync("<Name>"); Console.WriteLine(response.Status); ]]></code> This sample shows how to call DeleteTextBlocklistAsync with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = await client.DeleteTextBlocklistAsync("<Name>"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklist"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetTextBlocklist (string name, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetTextBlocklist(string name, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklist(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklist (name As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklist : string * Azure.RequestContext -> Azure.Response
override this.GetTextBlocklist : string * Azure.RequestContext -> Azure.Response" Usage="blocklistClient.GetTextBlocklist (name, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get Text Blocklist By blocklistName <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklist(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTextBlocklist and parse the result. <code><![CDATA[ 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()); ]]></code> This sample shows how to call GetTextBlocklist with all parameters and parse the result. <code><![CDATA[ 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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklist"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.ContentSafety.TextBlocklist> GetTextBlocklist (string name, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.ContentSafety.TextBlocklist> GetTextBlocklist(string name, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklist(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklist (name As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TextBlocklist)" /> <MemberSignature Language="F#" Value="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>" Usage="blocklistClient.GetTextBlocklist (name, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.ContentSafety.TextBlocklist></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get Text Blocklist By blocklistName. </summary> <returns>To be added.</returns> <remarks> Returns text blocklist details. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetTextBlocklist. <code><![CDATA[ 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>"); ]]></code> This sample shows how to call GetTextBlocklist with all parameters. <code><![CDATA[ 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>"); ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetTextBlocklistAsync (string name, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetTextBlocklistAsync(string name, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistAsync (name As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetTextBlocklistAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="blocklistClient.GetTextBlocklistAsync (name, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get Text Blocklist By blocklistName <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTextBlocklistAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = await client.GetTextBlocklistAsync("<Name>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); ]]></code> This sample shows how to call GetTextBlocklistAsync with all parameters and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = await client.GetTextBlocklistAsync("<Name>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklist>> GetTextBlocklistAsync (string name, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.ContentSafety.TextBlocklist>> GetTextBlocklistAsync(string name, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistAsync(System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TextBlocklist))" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklist>>
override this.GetTextBlocklistAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklist>>" Usage="blocklistClient.GetTextBlocklistAsync (name, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklist>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get Text Blocklist By blocklistName. </summary> <returns>To be added.</returns> <remarks> Returns text blocklist details. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetTextBlocklistAsync. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response<TextBlocklist> response = await client.GetTextBlocklistAsync("<Name>"); ]]></code> This sample shows how to call GetTextBlocklistAsync with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response<TextBlocklist> response = await client.GetTextBlocklistAsync("<Name>"); ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistItem"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetTextBlocklistItem (string name, string blocklistItemId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetTextBlocklistItem(string name, string blocklistItemId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItem(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistItem (name As String, blocklistItemId As String, context As RequestContext) As Response" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistItem : string * string * Azure.RequestContext -> Azure.Response
override this.GetTextBlocklistItem : string * string * Azure.RequestContext -> Azure.Response" Usage="blocklistClient.GetTextBlocklistItem (name, blocklistItemId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="blocklistItemId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="blocklistItemId"> The service will generate a BlocklistItemId, which will be a UUID. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get BlocklistItem By blocklistName And blocklistItemId <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItem(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="blocklistItemId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> or <paramref name="blocklistItemId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTextBlocklistItem and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = client.GetTextBlocklistItem("<Name>", "<blocklistItemId>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("text").ToString()); ]]></code> This sample shows how to call GetTextBlocklistItem with all parameters and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = client.GetTextBlocklistItem("<Name>", "<blocklistItemId>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("text").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistItem"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.ContentSafety.TextBlocklistItem> GetTextBlocklistItem (string name, string blocklistItemId, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.ContentSafety.TextBlocklistItem> GetTextBlocklistItem(string name, string blocklistItemId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItem(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistItem (name As String, blocklistItemId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of TextBlocklistItem)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistItem : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.ContentSafety.TextBlocklistItem>
override this.GetTextBlocklistItem : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.ContentSafety.TextBlocklistItem>" Usage="blocklistClient.GetTextBlocklistItem (name, blocklistItemId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.ContentSafety.TextBlocklistItem></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="blocklistItemId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="blocklistItemId"> The service will generate a BlocklistItemId, which will be a UUID. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get BlocklistItem By blocklistName And blocklistItemId. </summary> <returns>To be added.</returns> <remarks> Get blocklistItem by blocklistName and blocklistItemId from a text blocklist. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="blocklistItemId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> or <paramref name="blocklistItemId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetTextBlocklistItem. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response<TextBlocklistItem> response = client.GetTextBlocklistItem("<Name>", "<blocklistItemId>"); ]]></code> This sample shows how to call GetTextBlocklistItem with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response<TextBlocklistItem> response = client.GetTextBlocklistItem("<Name>", "<blocklistItemId>"); ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistItemAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetTextBlocklistItemAsync (string name, string blocklistItemId, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetTextBlocklistItemAsync(string name, string blocklistItemId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItemAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistItemAsync (name As String, blocklistItemId As String, context As RequestContext) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistItemAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetTextBlocklistItemAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="blocklistClient.GetTextBlocklistItemAsync (name, blocklistItemId, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="blocklistItemId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="blocklistItemId"> The service will generate a BlocklistItemId, which will be a UUID. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get BlocklistItem By blocklistName And blocklistItemId <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItemAsync(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="blocklistItemId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> or <paramref name="blocklistItemId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTextBlocklistItemAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = await client.GetTextBlocklistItemAsync("<Name>", "<blocklistItemId>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("text").ToString()); ]]></code> This sample shows how to call GetTextBlocklistItemAsync with all parameters and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response response = await client.GetTextBlocklistItemAsync("<Name>", "<blocklistItemId>", null); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("text").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistItemAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklistItem>> GetTextBlocklistItemAsync (string name, string blocklistItemId, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.ContentSafety.TextBlocklistItem>> GetTextBlocklistItemAsync(string name, string blocklistItemId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItemAsync(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistItemAsync (name As String, blocklistItemId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of TextBlocklistItem))" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistItemAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklistItem>>
override this.GetTextBlocklistItemAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklistItem>>" Usage="blocklistClient.GetTextBlocklistItemAsync (name, blocklistItemId, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.ContentSafety.TextBlocklistItem>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="blocklistItemId" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="blocklistItemId"> The service will generate a BlocklistItemId, which will be a UUID. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get BlocklistItem By blocklistName And blocklistItemId. </summary> <returns>To be added.</returns> <remarks> Get blocklistItem by blocklistName and blocklistItemId from a text blocklist. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="blocklistItemId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> or <paramref name="blocklistItemId" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetTextBlocklistItemAsync. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response<TextBlocklistItem> response = await client.GetTextBlocklistItemAsync("<Name>", "<blocklistItemId>"); ]]></code> This sample shows how to call GetTextBlocklistItemAsync with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); Response<TextBlocklistItem> response = await client.GetTextBlocklistItemAsync("<Name>", "<blocklistItemId>"); ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistItems"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetTextBlocklistItems (string name, int? maxCount, int? skip, int? maxpagesize, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetTextBlocklistItems(string name, valuetype System.Nullable`1<int32> maxCount, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItems(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistItems (name As String, maxCount As Nullable(Of Integer), skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistItems : string * Nullable<int> * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetTextBlocklistItems : string * Nullable<int> * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="blocklistClient.GetTextBlocklistItems (name, maxCount, skip, maxpagesize, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="maxCount" Type="System.Nullable<System.Int32>" /> <Parameter Name="skip" Type="System.Nullable<System.Int32>" /> <Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="maxCount"> The number of result items to return. </param> <param name="skip"> The number of result items to skip. </param> <param name="maxpagesize"> The maximum number of result items per page. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get All BlocklistItems By blocklistName <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItems(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTextBlocklistItems and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); foreach (BinaryData item in client.GetTextBlocklistItems("<Name>", null, null, null, null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("text").ToString()); } ]]></code> This sample shows how to call GetTextBlocklistItems with all parameters and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); foreach (BinaryData item in client.GetTextBlocklistItems("<Name>", 1234, 1234, 1234, null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("text").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistItems"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.AI.ContentSafety.TextBlocklistItem> GetTextBlocklistItems (string name, int? maxCount = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.AI.ContentSafety.TextBlocklistItem> GetTextBlocklistItems(string name, valuetype System.Nullable`1<int32> maxCount, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItems(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistItems (name As String, Optional maxCount As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of TextBlocklistItem)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistItems : string * Nullable<int> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.ContentSafety.TextBlocklistItem>
override this.GetTextBlocklistItems : string * Nullable<int> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.ContentSafety.TextBlocklistItem>" Usage="blocklistClient.GetTextBlocklistItems (name, maxCount, skip, maxpagesize, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Pageable<Azure.AI.ContentSafety.TextBlocklistItem></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="maxCount" Type="System.Nullable<System.Int32>" /> <Parameter Name="skip" Type="System.Nullable<System.Int32>" /> <Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="maxCount"> The number of result items to return. </param> <param name="skip"> The number of result items to skip. </param> <param name="maxpagesize"> The maximum number of result items per page. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get All BlocklistItems By blocklistName. </summary> <returns>To be added.</returns> <remarks> Get all blocklistItems in a text blocklist. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetTextBlocklistItems. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); foreach (TextBlocklistItem item in client.GetTextBlocklistItems("<Name>")) { } ]]></code> This sample shows how to call GetTextBlocklistItems with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); foreach (TextBlocklistItem item in client.GetTextBlocklistItems("<Name>", maxCount: 1234, skip: 1234, maxpagesize: 1234)) { } ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistItemsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetTextBlocklistItemsAsync (string name, int? maxCount, int? skip, int? maxpagesize, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetTextBlocklistItemsAsync(string name, valuetype System.Nullable`1<int32> maxCount, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItemsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistItemsAsync (name As String, maxCount As Nullable(Of Integer), skip As Nullable(Of Integer), maxpagesize As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistItemsAsync : string * Nullable<int> * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetTextBlocklistItemsAsync : string * Nullable<int> * Nullable<int> * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="blocklistClient.GetTextBlocklistItemsAsync (name, maxCount, skip, maxpagesize, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="maxCount" Type="System.Nullable<System.Int32>" /> <Parameter Name="skip" Type="System.Nullable<System.Int32>" /> <Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="maxCount"> The number of result items to return. </param> <param name="skip"> The number of result items to skip. </param> <param name="maxpagesize"> The maximum number of result items per page. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get All BlocklistItems By blocklistName <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItemsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTextBlocklistItemsAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); await foreach (BinaryData item in client.GetTextBlocklistItemsAsync("<Name>", null, null, null, null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("text").ToString()); } ]]></code> This sample shows how to call GetTextBlocklistItemsAsync with all parameters and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); await foreach (BinaryData item in client.GetTextBlocklistItemsAsync("<Name>", 1234, 1234, 1234, null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("blocklistItemId").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("text").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistItemsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlocklistItem> GetTextBlocklistItemsAsync (string name, int? maxCount = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.AI.ContentSafety.TextBlocklistItem> GetTextBlocklistItemsAsync(string name, valuetype System.Nullable`1<int32> maxCount, valuetype System.Nullable`1<int32> skip, valuetype System.Nullable`1<int32> maxpagesize, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistItemsAsync(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistItemsAsync (name As String, Optional maxCount As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of TextBlocklistItem)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistItemsAsync : string * Nullable<int> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlocklistItem>
override this.GetTextBlocklistItemsAsync : string * Nullable<int> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlocklistItem>" Usage="blocklistClient.GetTextBlocklistItemsAsync (name, maxCount, skip, maxpagesize, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlocklistItem></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="maxCount" Type="System.Nullable<System.Int32>" /> <Parameter Name="skip" Type="System.Nullable<System.Int32>" /> <Parameter Name="maxpagesize" Type="System.Nullable<System.Int32>" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="maxCount"> The number of result items to return. </param> <param name="skip"> The number of result items to skip. </param> <param name="maxpagesize"> The maximum number of result items per page. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get All BlocklistItems By blocklistName. </summary> <returns>To be added.</returns> <remarks> Get all blocklistItems in a text blocklist. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call GetTextBlocklistItemsAsync. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); await foreach (TextBlocklistItem item in client.GetTextBlocklistItemsAsync("<Name>")) { } ]]></code> This sample shows how to call GetTextBlocklistItemsAsync with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); await foreach (TextBlocklistItem item in client.GetTextBlocklistItemsAsync("<Name>", maxCount: 1234, skip: 1234, maxpagesize: 1234)) { } ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklists"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetTextBlocklists (Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetTextBlocklists(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklists(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklists (context As RequestContext) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklists : Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetTextBlocklists : Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="blocklistClient.GetTextBlocklists context" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get All Text Blocklists <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklists(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTextBlocklists and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); foreach (BinaryData item in client.GetTextBlocklists(null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); } ]]></code> This sample shows how to call GetTextBlocklists with all parameters and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); foreach (BinaryData item in client.GetTextBlocklists(null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklists"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.AI.ContentSafety.TextBlocklist> GetTextBlocklists (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.AI.ContentSafety.TextBlocklist> GetTextBlocklists(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklists(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklists (Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of TextBlocklist)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklists : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.ContentSafety.TextBlocklist>
override this.GetTextBlocklists : System.Threading.CancellationToken -> Azure.Pageable<Azure.AI.ContentSafety.TextBlocklist>" Usage="blocklistClient.GetTextBlocklists cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Pageable<Azure.AI.ContentSafety.TextBlocklist></ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get All Text Blocklists. </summary> <returns>To be added.</returns> <remarks> Get all text blocklists details. </remarks> <example> This sample shows how to call GetTextBlocklists. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); foreach (TextBlocklist item in client.GetTextBlocklists()) { } ]]></code> This sample shows how to call GetTextBlocklists with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); foreach (TextBlocklist item in client.GetTextBlocklists()) { } ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetTextBlocklistsAsync (Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetTextBlocklistsAsync(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistsAsync(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistsAsync (context As RequestContext) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetTextBlocklistsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="blocklistClient.GetTextBlocklistsAsync context" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Get All Text Blocklists <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistsAsync(System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTextBlocklistsAsync and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); await foreach (BinaryData item in client.GetTextBlocklistsAsync(null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); } ]]></code> This sample shows how to call GetTextBlocklistsAsync with all parameters and parse the result. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); await foreach (BinaryData item in client.GetTextBlocklistsAsync(null)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("blocklistName").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTextBlocklistsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlocklist> GetTextBlocklistsAsync (System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.AI.ContentSafety.TextBlocklist> GetTextBlocklistsAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.GetTextBlocklistsAsync(System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTextBlocklistsAsync (Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of TextBlocklist)" /> <MemberSignature Language="F#" Value="abstract member GetTextBlocklistsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlocklist>
override this.GetTextBlocklistsAsync : System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlocklist>" Usage="blocklistClient.GetTextBlocklistsAsync cancellationToken" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AsyncPageable<Azure.AI.ContentSafety.TextBlocklist></ReturnType> </ReturnValue> <Parameters> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Get All Text Blocklists. </summary> <returns>To be added.</returns> <remarks> Get all text blocklists details. </remarks> <example> This sample shows how to call GetTextBlocklistsAsync. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); await foreach (TextBlocklist item in client.GetTextBlocklistsAsync()) { } ]]></code> This sample shows how to call GetTextBlocklistsAsync with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); await foreach (TextBlocklist item in client.GetTextBlocklistsAsync()) { } ]]></code></example> </Docs> </Member> <Member MemberName="Pipeline"> <MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" /> <MemberSignature Language="DocId" Value="P:Azure.AI.ContentSafety.BlocklistClient.Pipeline" /> <MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" /> <MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.AI.ContentSafety.BlocklistClient.Pipeline" /> <MemberType>Property</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType> </ReturnValue> <Docs> <summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary> <value>To be added.</value> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="RemoveBlocklistItems"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveBlocklistItems (string name, Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveBlocklistItems(string name, class Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.RemoveBlocklistItems(System.String,Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBlocklistItems (name As String, options As RemoveTextBlocklistItemsOptions, Optional cancellationToken As CancellationToken = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveBlocklistItems : string * Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions * System.Threading.CancellationToken -> Azure.Response
override this.RemoveBlocklistItems : string * Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions * System.Threading.CancellationToken -> Azure.Response" Usage="blocklistClient.RemoveBlocklistItems (name, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="options"> Options for removing blocklist items. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Remove BlocklistItems From Text Blocklist. </summary> <returns>To be added.</returns> <remarks> Remove blocklistItems from a text blocklist. You can remove at most 100 BlocklistItems in one request. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="options" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveBlocklistItems. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); RemoveTextBlocklistItemsOptions options = new RemoveTextBlocklistItemsOptions(new string[] { "<blocklistItemIds>" }); Response response = client.RemoveBlocklistItems("<Name>", options); ]]></code> This sample shows how to call RemoveBlocklistItems with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); RemoveTextBlocklistItemsOptions options = new RemoveTextBlocklistItemsOptions(new string[] { "<blocklistItemIds>" }); Response response = client.RemoveBlocklistItems("<Name>", options); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBlocklistItems"> <MemberSignature Language="C#" Value="public virtual Azure.Response RemoveBlocklistItems (string name, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response RemoveBlocklistItems(string name, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.RemoveBlocklistItems(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBlocklistItems (name As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member RemoveBlocklistItems : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.RemoveBlocklistItems : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="blocklistClient.RemoveBlocklistItems (name, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Remove BlocklistItems From Text Blocklist <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.RemoveBlocklistItems(System.String,Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveBlocklistItems. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistItemIds = new object[] { "<blocklistItemIds>" }, }); Response response = client.RemoveBlocklistItems("<Name>", content); Console.WriteLine(response.Status); ]]></code> This sample shows how to call RemoveBlocklistItems with all parameters and request content. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistItemIds = new object[] { "<blocklistItemIds>" }, }); Response response = client.RemoveBlocklistItems("<Name>", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBlocklistItemsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveBlocklistItemsAsync (string name, Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveBlocklistItemsAsync(string name, class Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.RemoveBlocklistItemsAsync(System.String,Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBlocklistItemsAsync (name As String, options As RemoveTextBlocklistItemsOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveBlocklistItemsAsync : string * Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveBlocklistItemsAsync : string * Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>" Usage="blocklistClient.RemoveBlocklistItemsAsync (name, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="options"> Options for removing blocklist items. </param> <param name="cancellationToken"> The cancellation token to use. </param> <summary> Remove BlocklistItems From Text Blocklist. </summary> <returns>To be added.</returns> <remarks> Remove blocklistItems from a text blocklist. You can remove at most 100 BlocklistItems in one request. </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="options" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <example> This sample shows how to call RemoveBlocklistItemsAsync. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); RemoveTextBlocklistItemsOptions options = new RemoveTextBlocklistItemsOptions(new string[] { "<blocklistItemIds>" }); Response response = await client.RemoveBlocklistItemsAsync("<Name>", options); ]]></code> This sample shows how to call RemoveBlocklistItemsAsync with all parameters. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); RemoveTextBlocklistItemsOptions options = new RemoveTextBlocklistItemsOptions(new string[] { "<blocklistItemIds>" }); Response response = await client.RemoveBlocklistItemsAsync("<Name>", options); ]]></code></example> </Docs> </Member> <Member MemberName="RemoveBlocklistItemsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> RemoveBlocklistItemsAsync (string name, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> RemoveBlocklistItemsAsync(string name, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.ContentSafety.BlocklistClient.RemoveBlocklistItemsAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RemoveBlocklistItemsAsync (name As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member RemoveBlocklistItemsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.RemoveBlocklistItemsAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="blocklistClient.RemoveBlocklistItemsAsync (name, content, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.ContentSafety</AssemblyName> <AssemblyVersion>1.0.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="name" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="name"> Text blocklist name. </param> <param name="content"> The content to send as the body of the request. </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Remove BlocklistItems From Text Blocklist <list type="bullet"><item><description> This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios. </description></item><item><description> Please try the simpler <see cref="M:Azure.AI.ContentSafety.BlocklistClient.RemoveBlocklistItemsAsync(System.String,Azure.AI.ContentSafety.RemoveTextBlocklistItemsOptions,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first. </description></item></list></summary> <returns> The response returned from the service. </returns> <remarks>To be added.</remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="name" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="name" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call RemoveBlocklistItemsAsync. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistItemIds = new object[] { "<blocklistItemIds>" }, }); Response response = await client.RemoveBlocklistItemsAsync("<Name>", content); Console.WriteLine(response.Status); ]]></code> This sample shows how to call RemoveBlocklistItemsAsync with all parameters and request content. <code><![CDATA[ Uri endpoint = new Uri("<https://my-service.azure.com>"); AzureKeyCredential credential = new AzureKeyCredential("<key>"); BlocklistClient client = new BlocklistClient(endpoint, credential); using RequestContent content = RequestContent.Create(new { blocklistItemIds = new object[] { "<blocklistItemIds>" }, }); Response response = await client.RemoveBlocklistItemsAsync("<Name>", content); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> </Members> </Type>

xml/Azure.AI.ContentSafety/BlocklistClient.xml (1,787 lines of code) (raw):