Freigeben über

ResourcesListOptionalParams interface

Paket:
@azure/arm-resources

Optionale Parameter.

Extends
OperationOptions

Eigenschaften

expand

Durch Trennzeichen getrennte Liste zusätzlicher Eigenschaften, die in die Antwort aufgenommen werden sollen. Gültige Werte sind createdTime, changedTime und provisioningState. Beispiel: $expand=createdTime,changedTime.
filter

Der filter, der auf den Vorgang angewendet werden soll.

Filtervergleichsoperatoren umfassen eq (gleich) und ne (ungleich) und können mit den folgenden Eigenschaften verwendet werden: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versionund plan/promotionCode.

Um beispielsweise nach einem Ressourcentyp zu filtern, verwenden Sie $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) können verwendet werden, um nach Teilzeichenfolgen der folgenden derzeit unterstützten Eigenschaften zu filtern: name und resourceGroup

Um beispielsweise alle Ressourcen mit "Demo" an einer beliebigen Stelle im Ressourcennamen abzurufen, verwenden Sie $filter=substringof('demo', name)

Mehrere Teilzeichenfolgenvorgänge können auch mit and/or Operatoren kombiniert werden.

Beachten Sie, dass alle abgeschnittenen Ergebnisse, die über $top abgefragt werden, auch nicht kompatibel sein können, wenn sie einen Filter verwenden.


Ressourcen können nach Tagnamen und Werten gefiltert werden. Wenn Sie beispielsweise nach einem Tagnamen und -wert filtern möchten, verwenden Sie $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Beachten Sie, dass beim Filtern von Ressourcen nach Tagname und Wert die ursprünglichen Tags für jede Ressource nicht in den Ergebnissen zurückgegeben werden. Eine Liste mit zusätzlichen Eigenschaften, die über $expand abgefragt werden, kann auch beim Filtern nach Tagnamen/Werten nicht kompatibel sein.

Nur für Tagnamen können Ressourcen mithilfe der folgenden Syntax gefiltert werden: $filter=startswith(tagName, 'depart'). Diese Abfrage gibt alle Ressourcen mit einem Tagnamen zurück, dem der Ausdruck depart vorangestellt ist (z. B.department, departureDate, departureTimeusw.)


Beachten Sie, dass einige Eigenschaften beim Filtern von Ressourcen kombiniert werden können, die Folgendes umfassen: substringof() and/or resourceType, plan and plan/publisher and plan/nameund identity and identity/principalId.
top

Die Anzahl der Empfehlungen pro Seite, wenn eine seitenseitige Version dieser API verwendet wird.

Geerbte Eigenschaften

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
serializerOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.
tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

expand

Durch Trennzeichen getrennte Liste zusätzlicher Eigenschaften, die in die Antwort aufgenommen werden sollen. Gültige Werte sind createdTime, changedTime und provisioningState. Beispiel: $expand=createdTime,changedTime.

expand?: string

Eigenschaftswert

string

filter

Der filter, der auf den Vorgang angewendet werden soll.

Filtervergleichsoperatoren umfassen eq (gleich) und ne (ungleich) und können mit den folgenden Eigenschaften verwendet werden: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versionund plan/promotionCode.

Um beispielsweise nach einem Ressourcentyp zu filtern, verwenden Sie $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) können verwendet werden, um nach Teilzeichenfolgen der folgenden derzeit unterstützten Eigenschaften zu filtern: name und resourceGroup

Um beispielsweise alle Ressourcen mit "Demo" an einer beliebigen Stelle im Ressourcennamen abzurufen, verwenden Sie $filter=substringof('demo', name)

Mehrere Teilzeichenfolgenvorgänge können auch mit and/or Operatoren kombiniert werden.

Beachten Sie, dass alle abgeschnittenen Ergebnisse, die über $top abgefragt werden, auch nicht kompatibel sein können, wenn sie einen Filter verwenden.


Ressourcen können nach Tagnamen und Werten gefiltert werden. Wenn Sie beispielsweise nach einem Tagnamen und -wert filtern möchten, verwenden Sie $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Beachten Sie, dass beim Filtern von Ressourcen nach Tagname und Wert die ursprünglichen Tags für jede Ressource nicht in den Ergebnissen zurückgegeben werden. Eine Liste mit zusätzlichen Eigenschaften, die über $expand abgefragt werden, kann auch beim Filtern nach Tagnamen/Werten nicht kompatibel sein.

Nur für Tagnamen können Ressourcen mithilfe der folgenden Syntax gefiltert werden: $filter=startswith(tagName, 'depart'). Diese Abfrage gibt alle Ressourcen mit einem Tagnamen zurück, dem der Ausdruck depart vorangestellt ist (z. B.department, departureDate, departureTimeusw.)


Beachten Sie, dass einige Eigenschaften beim Filtern von Ressourcen kombiniert werden können, die Folgendes umfassen: substringof() and/or resourceType, plan and plan/publisher and plan/nameund identity and identity/principalId.

filter?: string

Eigenschaftswert

string

top

Die Anzahl der Empfehlungen pro Seite, wenn eine seitenseitige Version dieser API verwendet wird.

top?: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbt von coreClient.OperationOptions.abortSignal

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

Geerbt von coreClient.OperationOptions.onResponse

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Geerbt von coreClient.OperationOptions.requestOptions

serializerOptions

Optionen zum Außerkraftsetzen des Serialisierungs-/De serialisierungsverhaltens.

serializerOptions?: SerializerOptions

Eigenschaftswert

SerializerOptions

Geerbt von coreClient.OperationOptions.serializerOptions

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

Geerbt von coreClient.OperationOptions.tracingOptions