Udostępnij za pośrednictwem


PartnerTopicsListBySubscriptionOptionalParams interface

Parametry opcjonalne.

Rozszerzenie

Właściwości

filter

Zapytanie używane do filtrowania wyników wyszukiwania przy użyciu składni OData. Filtrowanie jest dozwolone tylko dla właściwości "name" i z ograniczoną liczbą operacji OData. Te operacje to: funkcja "contains" oraz następujące operacje logiczne: nie i, lub, eq (dla równej) i ne (dla nie równej). Nie są obsługiwane żadne operacje arytmetyczne. Poniżej przedstawiono prawidłowy przykład filtru: $filter=contains(namE, 'PATTERN') i name ne 'PATTERN-1'. Poniższy przykład nie jest prawidłowym przykładem filtru: $filter=location eq "westus".

top

Liczba wyników, które mają być zwracane na stronę dla operacji listy. Prawidłowy zakres dla najwyższego parametru to od 1 do 100. Jeśli nie zostanie określona, domyślna liczba zwracanych wyników to 20 elementów na stronę.

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

serializerOptions

Opcje zastąpienia zachowania serializacji/de serializacji.

tracingOptions

Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości

filter

Zapytanie używane do filtrowania wyników wyszukiwania przy użyciu składni OData. Filtrowanie jest dozwolone tylko dla właściwości "name" i z ograniczoną liczbą operacji OData. Te operacje to: funkcja "contains" oraz następujące operacje logiczne: nie i, lub, eq (dla równej) i ne (dla nie równej). Nie są obsługiwane żadne operacje arytmetyczne. Poniżej przedstawiono prawidłowy przykład filtru: $filter=contains(namE, 'PATTERN') i name ne 'PATTERN-1'. Poniższy przykład nie jest prawidłowym przykładem filtru: $filter=location eq "westus".

filter?: string

Wartość właściwości

string

top

Liczba wyników, które mają być zwracane na stronę dla operacji listy. Prawidłowy zakres dla najwyższego parametru to od 1 do 100. Jeśli nie zostanie określona, domyślna liczba zwracanych wyników to 20 elementów na stronę.

top?: number

Wartość właściwości

number

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.abortSignal

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.requestOptions

serializerOptions

Opcje zastąpienia zachowania serializacji/de serializacji.

serializerOptions?: SerializerOptions

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.serializerOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

Dziedziczone z coreClient.OperationOptions.tracingOptions