GetCatalogOptionalParams interface

Package:

@azure/arm-reservations

Optional parameters.

Extends

OperationOptions

Properties

filter	May be used to filter by Catalog properties. The filter supports 'eq', 'or', and 'and'.
location	Filters the skus based on the location specified in this parameter. This can be an Azure region or global
offerId	Offer id used to get the third party products
planId	Plan id used to get the third party products
publisherId	Publisher id used to get the third party products
reservedResourceType	The type of the resource for which the skus should be provided.
skip	The number of reservations to skip from the list before returning results
take	To number of reservations to return

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

filter

May be used to filter by Catalog properties. The filter supports 'eq', 'or', and 'and'.

filter?: string

Property Value

string

location

Filters the skus based on the location specified in this parameter. This can be an Azure region or global

location?: string

Property Value

string

offerId

Offer id used to get the third party products

offerId?: string

Property Value

string

planId

Plan id used to get the third party products

planId?: string

Property Value

string

publisherId

Publisher id used to get the third party products

publisherId?: string

Property Value

string

reservedResourceType

The type of the resource for which the skus should be provided.

reservedResourceType?: string

Property Value

string

skip

The number of reservations to skip from the list before returning results

skip?: number

Property Value

number

take

To number of reservations to return

take?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From coreClient.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 coreClient.OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From coreClient.OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From coreClient.OperationOptions.serializerOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From coreClient.OperationOptions.tracingOptions