LocalUsersListOptionalParams interface

Optional parameters.

Extends

Properties

filter

Optional. When specified, only local user names starting with the filter will be listed.

include

Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default.

maxpagesize

Optional, specifies the maximum number of local users that will be included in the list response.

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.

tracingOptions

Options used when tracing is enabled.

Property Details

filter

Optional. When specified, only local user names starting with the filter will be listed.

filter?: string

Property Value

string

include

Optional, when specified, will list local users enabled for the specific protocol. Lists all users by default.

include?: string

Property Value

string

maxpagesize

Optional, specifies the maximum number of local users that will be included in the list response.

maxpagesize?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

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

Inherited From OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

Inherited From OperationOptions.tracingOptions