ResourcesListOptionalParams interface

Pakiet:

@azure/arm-resources

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. Operatory porównania filtrów obejmują eq (równe) i ne (nie równe) i mogą być używane z następującymi właściwościami: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versioni plan/promotionCode. Aby na przykład filtrować według typu zasobu, użyj $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 $filter=substringof('demo', name) Wiele operacji podciągów można również łączyć przy użyciu operatorów and/or. Należy pamiętać, że każda obcięta liczba wyników zapytanych za pośrednictwem $top może być również niezgodna 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 $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ą prefiksem frazy depart (tj.department, departureDate, departureTimeitp.) 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 zaleceń na stronę, jeśli jest używana stronicowana wersja tego interfejsu API.

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.

Operatory porównania filtrów obejmują eq (równe) i ne (nie równe) i mogą być używane z następującymi właściwościami: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versioni plan/promotionCode.

Aby na przykład filtrować według typu zasobu, użyj $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 $filter=substringof('demo', name)

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

Należy pamiętać, że każda obcięta liczba wyników zapytanych za pośrednictwem $top może być również niezgodna 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 $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ą prefiksem frazy depart (tj.department, departureDate, departureTimeitp.)


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 zaleceń na stronę, jeśli jest używana stronicowana wersja tego interfejsu API.

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