Udostępnij za pośrednictwem

ResourcesListOptionalParams interface

  • Odwołanie
Pakiet:
@azure/arm-resources

Parametry opcjonalne.

Extends
OperationOptions

Właściwości

expand

Rozdzielona przecinkami lista dodatkowych właściwości, które mają zostać uwzględnione w odpowiedzi. Prawidłowe wartości to createdTime, changedTime i provisioningState. Na przykład $expand=createdTime,changedTime.
filter

Filtr, który ma być stosowany do operacji.

Operatory porównania filtrów obejmują eq (równe) i ne (nie równa się) i mogą być używane z następującymi właściwościami: location, resourceType, identityidentity/principalIdplanresourceGroupnameplan/productplan/nameplan/publisherplan/versioni .plan/promotionCode

Aby na przykład filtrować według typu zasobu, użyj polecenia $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) Można użyć do filtrowania podciągów następujących aktualnie obsługiwanych właściwości: name i resourceGroup

Aby na przykład pobrać wszystkie zasoby z "pokazem" w dowolnym miejscu w nazwie zasobu, użyj polecenia $filter=substringof('demo', name)

Wiele operacji podciągów można również łączyć przy użyciu and/or operatorów.

Należy pamiętać, że każda obcięta liczba wyników, których dotyczy zapytanie, $top może również nie być zgodna w przypadku korzystania z filtru.


Zasoby można filtrować według nazw tagów i wartości. Aby na przykład filtrować nazwę i wartość tagu, użyj polecenia $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Należy pamiętać, że gdy zasoby są filtrowane według nazwy i wartości tagu, oryginalne tagi dla każdego zasobu nie zostaną zwrócone w wynikach. Każda lista dodatkowych właściwości, których dotyczy zapytanie za pośrednictwem, $expand może również nie być zgodna podczas filtrowania według nazw tagów/wartości.

Tylko w przypadku nazw tagów zasoby można filtrować według prefiksu przy użyciu następującej składni: $filter=startswith(tagName, 'depart'). To zapytanie zwróci wszystkie zasoby z nazwą tagu poprzedzoną frazą depart (np.departmentdepartureDate , departureTime, itp.)


Należy pamiętać, że niektóre właściwości można łączyć podczas filtrowania zasobów, które obejmują następujące elementy: substringof() and/or resourceType, plan and plan/publisher and plan/namei identity and identity/principalId.
top

Liczba wyników do zwrócenia. Jeśli przekazano wartość null, zwraca wszystkie zasoby.

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ępowania zachowania serializacji/deseralizacji.
tracingOptions

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

Szczegóły właściwości

expand

Rozdzielona przecinkami lista dodatkowych właściwości, które mają zostać uwzględnione w odpowiedzi. Prawidłowe wartości to createdTime, changedTime i provisioningState. Na przykład $expand=createdTime,changedTime.

expand?: string

Wartość właściwości

string

filter

Filtr, który ma być stosowany do operacji.

Operatory porównania filtrów obejmują eq (równe) i ne (nie równa się) i mogą być używane z następującymi właściwościami: location, resourceType, identityidentity/principalIdplanresourceGroupnameplan/productplan/nameplan/publisherplan/versioni .plan/promotionCode

Aby na przykład filtrować według typu zasobu, użyj polecenia $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) Można użyć do filtrowania podciągów następujących aktualnie obsługiwanych właściwości: name i resourceGroup

Aby na przykład pobrać wszystkie zasoby z "pokazem" w dowolnym miejscu w nazwie zasobu, użyj polecenia $filter=substringof('demo', name)

Wiele operacji podciągów można również łączyć przy użyciu and/or operatorów.

Należy pamiętać, że każda obcięta liczba wyników, których dotyczy zapytanie, $top może również nie być zgodna w przypadku korzystania z filtru.


Zasoby można filtrować według nazw tagów i wartości. Aby na przykład filtrować nazwę i wartość tagu, użyj polecenia $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Należy pamiętać, że gdy zasoby są filtrowane według nazwy i wartości tagu, oryginalne tagi dla każdego zasobu nie zostaną zwrócone w wynikach. Każda lista dodatkowych właściwości, których dotyczy zapytanie za pośrednictwem, $expand może również nie być zgodna podczas filtrowania według nazw tagów/wartości.

Tylko w przypadku nazw tagów zasoby można filtrować według prefiksu przy użyciu następującej składni: $filter=startswith(tagName, 'depart'). To zapytanie zwróci wszystkie zasoby z nazwą tagu poprzedzoną frazą depart (np.departmentdepartureDate , departureTime, itp.)


Należy pamiętać, że niektóre właściwości można łączyć podczas filtrowania zasobów, które obejmują następujące elementy: substringof() and/or resourceType, plan and plan/publisher and plan/namei identity and identity/principalId.

filter?: string

Wartość właściwości

string

top

Liczba wyników do zwrócenia. Jeśli przekazano wartość null, zwraca wszystkie zasoby.

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

AbortSignalLike

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

RawResponseCallback

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

OperationRequestOptions

Dziedziczone z coreClient.OperationOptions.requestOptions

serializerOptions

Opcje zastępowania zachowania serializacji/deseralizacji.

serializerOptions?: SerializerOptions

Wartość właściwości

SerializerOptions

Dziedziczone z coreClient.OperationOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

Dziedziczone z coreClient.OperationOptions.tracingOptions