GroupListConnectionsOptions interface

Package:

@azure/web-pubsub

Options for listing connections in a group.

Extends

OperationOptions

Properties

continuationToken	A token that allows the client to retrieve the next page of results. This parameter is provided by the service in the response of a previous request when there are additional results to be fetched. Clients should include the continuationToken in the next request to receive the subsequent page of data. If this parameter is omitted, the server will return the first page of results.
maxPageSize	The maximum number of connections to include in a single response. It should be between 1 and 200.
top	The maximum number of connections to return. If the value is not set, then all the connections in a group are returned.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
tracingOptions	Options used when tracing is enabled.

Property Details

continuationToken

A token that allows the client to retrieve the next page of results. This parameter is provided by the service in the response of a previous request when there are additional results to be fetched. Clients should include the continuationToken in the next request to receive the subsequent page of data. If this parameter is omitted, the server will return the first page of results.

continuationToken?: string

Property Value

string

maxPageSize

The maximum number of connections to include in a single response. It should be between 1 and 200.

maxPageSize?: number

Property Value

number

top

The maximum number of connections to return. If the value is not set, then all the connections in a group are returned.

top?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions