ResourcesListByResourceGroupOptionalParams interface

Pakiet:

@azure/arm-resources-profile-2020-09-01-hybrid

Parametry opcjonalne.

Rozszerzenie

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 obejmują createdTime, changedTime i provisioningState. Na przykład $expand=createdTime,changedTime.
filter	Filtr do zastosowania w operacji. Właściwości, których można użyć dla wartości eq (równa się) lub ne (nie równa się) to: lokalizacja, typ zasobu, nazwa, resourceGroup, tożsamość, tożsamość/principalId, plan, plan/wydawca, plan/produkt, plan/nazwa, plan/wersja i plan/promocjaCode. Aby na przykład filtrować według typu zasobu, użyj polecenia: $filter=resourceType eq "Microsoft.Network/virtualNetworks" W filtrze można użyć parametru substringof(value, property). Właściwości, których można użyć do podciągowania, to: name i resourceGroup. Aby na przykład pobrać wszystkie zasoby z nazwą "demo" w dowolnym miejscu, użyj polecenia: $filter=substringof('demo', name) Możesz połączyć ze sobą więcej niż jeden podciąg, dodając operatory i/lub. Możesz filtrować według nazw tagów i wartości. Aby na przykład filtrować nazwę i wartość tagu, użyj wartości $filter=tagName eq "tag1" i tagValue eq "Value1". Podczas filtrowania według nazwy i wartości tagu tagi dla każdego zasobu nie są zwracane w wynikach. Podczas filtrowania można używać niektórych właściwości. Kombinacje, których można użyć, to: podciąg i/lub resourceType, plan i plan/wydawca oraz plan/nazwa, tożsamość i tożsamość/principalId.
top	Liczba wyników do zwrócenia. Jeśli wartość null zostanie przekazana, 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 są 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 obejmują createdTime, changedTime i provisioningState. Na przykład $expand=createdTime,changedTime.

expand?: string

Wartość właściwości

string

filter

Filtr do zastosowania w operacji.

Właściwości, których można użyć dla wartości eq (równa się) lub ne (nie równa się) to: lokalizacja, typ zasobu, nazwa, resourceGroup, tożsamość, tożsamość/principalId, plan, plan/wydawca, plan/produkt, plan/nazwa, plan/wersja i plan/promocjaCode.

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

W filtrze można użyć parametru substringof(value, property). Właściwości, których można użyć do podciągowania, to: name i resourceGroup.

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

Możesz połączyć ze sobą więcej niż jeden podciąg, dodając operatory i/lub.

Możesz filtrować według nazw tagów i wartości. Aby na przykład filtrować nazwę i wartość tagu, użyj wartości $filter=tagName eq "tag1" i tagValue eq "Value1". Podczas filtrowania według nazwy i wartości tagu tagi dla każdego zasobu nie są zwracane w wynikach.

Podczas filtrowania można używać niektórych właściwości. Kombinacje, których można użyć, to: podciąg i/lub resourceType, plan i plan/wydawca oraz plan/nazwa, tożsamość i tożsamość/principalId.

filter?: string

Wartość właściwości

string

top

Liczba wyników do zwrócenia. Jeśli wartość null zostanie przekazana, 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 są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone z coreClient.OperationOptions.tracingOptions