ListGeographicAreaCodesOptions interface

Package:

@azure/communication-phone-numbers

Additional options that can be passed to the Geographic area codes request.

Extends

PhoneNumbersListAreaCodesOptionalParams

Inherited Properties

abortSignal	The signal which can be used to abort requests.
acceptLanguage	The locale to display in the localized fields in the response. e.g. 'en-US'
administrativeDivision	The name of the state or province in which to search for the area code.
assignmentType	Filter by assignmentType, e.g. Person, Application.
locality	The name of locality or town in which to search for the area code. This is required if the number type is Geographic.
maxPageSize	An optional parameter for how many entries to return, for pagination purposes. The default value is 100.
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.
skip	An optional parameter for how many entries to skip, for pagination purposes. The default value is 0.
tracingOptions	Options used when tracing is enabled.

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From PhoneNumbersListAreaCodesOptionalParams.abortSignal

acceptLanguage

The locale to display in the localized fields in the response. e.g. 'en-US'

acceptLanguage?: string

Property Value

string

Inherited From PhoneNumbersListAreaCodesOptionalParams.acceptLanguage

administrativeDivision

The name of the state or province in which to search for the area code.

administrativeDivision?: string

Property Value

string

Inherited From PhoneNumbersListAreaCodesOptionalParams.administrativeDivision

assignmentType

Filter by assignmentType, e.g. Person, Application.

assignmentType?: PhoneNumberAssignmentType

Property Value

PhoneNumberAssignmentType

Inherited From PhoneNumbersListAreaCodesOptionalParams.assignmentType

locality

The name of locality or town in which to search for the area code. This is required if the number type is Geographic.

locality?: string

Property Value

string

Inherited From PhoneNumbersListAreaCodesOptionalParams.locality

maxPageSize

An optional parameter for how many entries to return, for pagination purposes. The default value is 100.

maxPageSize?: number

Property Value

number

Inherited From PhoneNumbersListAreaCodesOptionalParams.maxPageSize

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 PhoneNumbersListAreaCodesOptionalParams.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From PhoneNumbersListAreaCodesOptionalParams.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From PhoneNumbersListAreaCodesOptionalParams.serializerOptions

skip

An optional parameter for how many entries to skip, for pagination purposes. The default value is 0.

skip?: number

Property Value

number

Inherited From PhoneNumbersListAreaCodesOptionalParams.skip

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From PhoneNumbersListAreaCodesOptionalParams.tracingOptions