WebPubSubChatServiceClient.CreateOrReplaceRole Method

Definition

Namespace:: Azure.Messaging.WebPubSub.Chat

Assembly:: Azure.Messaging.WebPubSub.Chat.dll

Package:: Azure.Messaging.WebPubSub.Chat v1.0.0-beta.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
CreateOrReplaceRole(String, WebPubSubChatRole, MatchConditions, CancellationToken)	Create or replace a role.
CreateOrReplaceRole(String, RequestContent, MatchConditions, RequestContext)	[Protocol Method] Create or replace a role. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

Name

Description

CreateOrReplaceRole(String, WebPubSubChatRole, MatchConditions, CancellationToken)

Create or replace a role.

CreateOrReplaceRole(String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Create or replace a role.

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

CreateOrReplaceRole(String, WebPubSubChatRole, MatchConditions, CancellationToken)

Source:: WebPubSubChatServiceClient.cs

Create or replace a role.

public virtual Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole> CreateOrReplaceRole(string roleName, Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole resource, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CreateOrReplaceRole : string * Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole * Azure.MatchConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole>
override this.CreateOrReplaceRole : string * Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole * Azure.MatchConditions * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole>

Public Overridable Function CreateOrReplaceRole (roleName As String, resource As WebPubSubChatRole, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of WebPubSubChatRole)

Parameters

roleName: String

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

resource: WebPubSubChatRole

The resource instance.

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

Response<WebPubSubChatRole>

Exceptions

ArgumentNullException

roleName or resource is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Applies to

CreateOrReplaceRole(String, RequestContent, MatchConditions, RequestContext)

Source:: WebPubSubChatServiceClient.cs

[Protocol Method] Create or replace a role.

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

public virtual Azure.Response CreateOrReplaceRole(string roleName, Azure.Core.RequestContent content, Azure.MatchConditions matchConditions = default, Azure.RequestContext context = default);

abstract member CreateOrReplaceRole : string * Azure.Core.RequestContent * Azure.MatchConditions * Azure.RequestContext -> Azure.Response
override this.CreateOrReplaceRole : string * Azure.Core.RequestContent * Azure.MatchConditions * Azure.RequestContext -> Azure.Response

Public Overridable Function CreateOrReplaceRole (roleName As String, content As RequestContent, Optional matchConditions As MatchConditions = Nothing, Optional context As RequestContext = Nothing) As Response