Language

WebPubSubChatServiceClient.DeleteRole Method

Definition

Overloads

Name Description
DeleteRole(String, MatchConditions, CancellationToken)

Delete a role.

DeleteRole(String, MatchConditions, RequestContext)

[Protocol Method] Delete a role.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

DeleteRole(String, MatchConditions, CancellationToken)

Source:
WebPubSubChatServiceClient.cs

Delete a role.

public virtual Azure.Response DeleteRole(string roleName, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DeleteRole : string * Azure.MatchConditions * System.Threading.CancellationToken -> Azure.Response
override this.DeleteRole : string * Azure.MatchConditions * System.Threading.CancellationToken -> Azure.Response
Public Overridable Function DeleteRole (roleName As String, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response

Parameters

roleName
String

Role name. Must start with 'user.' or 'room.' prefix.

matchConditions
MatchConditions

The content to send as the request conditions of the request.

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Exceptions

roleName is null.

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

Service returned a non-success status code.

Applies to

DeleteRole(String, MatchConditions, RequestContext)

Source:
WebPubSubChatServiceClient.cs

[Protocol Method] Delete a role.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Response DeleteRole(string roleName, Azure.MatchConditions matchConditions, Azure.RequestContext context);
abstract member DeleteRole : string * Azure.MatchConditions * Azure.RequestContext -> Azure.Response
override this.DeleteRole : string * Azure.MatchConditions * Azure.RequestContext -> Azure.Response
Public Overridable Function DeleteRole (roleName As String, matchConditions As MatchConditions, context As RequestContext) As Response

Parameters

roleName
String

Role name. Must start with 'user.' or 'room.' prefix.

matchConditions
MatchConditions

The content to send as the request conditions of the request.

context
RequestContext

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

Returns

The response returned from the service.

Exceptions

roleName is null.

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

Service returned a non-success status code.

Applies to