Freigeben über

ResourcesListOptionalParams interface

  • Referenz
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 , createdTimechangedTime und provisioningState. Beispiel: $expand=createdTime,changedTime.
filter

Der Filter, der auf den Vorgang angewendet werden soll.

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

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


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

Verwenden Sie beispielsweise, um alle Ressourcen mit "demo" an einer beliebigen Stelle im Ressourcennamen abzurufen. $filter=substringof('demo', name)

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

Beachten Sie, dass die abgeschnittene Anzahl der über $top abgefragten Ergebnisse möglicherweise auch nicht kompatibel ist, wenn ein Filter verwendet wird.


Ressourcen können nach Tagnamen und -werten gefiltert werden. Um beispielsweise nach einem Tagnamen und -wert zu filtern, 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. Jede Liste mit zusätzlichen Eigenschaften, die über $expand abgefragt werden, ist möglicherweise auch nicht kompatibel, wenn nach Tagnamen/Werten gefiltert wird.

Nur für Tagnamen können Ressourcen mithilfe der folgenden Syntax nach Präfix gefiltert werden: $filter=startswith(tagName, 'depart'). Diese Abfrage gibt alle Ressourcen mit einem Tagnamen zurück, departureDatedem der Ausdruck depart vorangestellt ist (d. h.department , departureTimeusw.).


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

Die Anzahl der zurückgegebenen Ergebnisse. Wenn NULL übergeben wird, werden alle Ressourcen zurückgegeben.

Geerbte Eigenschaften

abortSignal

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

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen wird. Kann mehrmals aufgerufen werden.
requestOptions

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

Optionen zum Überschreiben 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 , createdTimechangedTime 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 (nicht gleich) und können mit den folgenden Eigenschaften verwendet werden: location, , resourceType, resourceGroupname, identity, identity/principalId, , plan, plan/publisher, plan/product, plan/name, plan/version, und plan/promotionCode.

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


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

Verwenden Sie beispielsweise, um alle Ressourcen mit "demo" an einer beliebigen Stelle im Ressourcennamen abzurufen. $filter=substringof('demo', name)

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

Beachten Sie, dass die abgeschnittene Anzahl der über $top abgefragten Ergebnisse möglicherweise auch nicht kompatibel ist, wenn ein Filter verwendet wird.


Ressourcen können nach Tagnamen und -werten gefiltert werden. Um beispielsweise nach einem Tagnamen und -wert zu filtern, 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. Jede Liste mit zusätzlichen Eigenschaften, die über $expand abgefragt werden, ist möglicherweise auch nicht kompatibel, wenn nach Tagnamen/Werten gefiltert wird.

Nur für Tagnamen können Ressourcen mithilfe der folgenden Syntax nach Präfix gefiltert werden: $filter=startswith(tagName, 'depart'). Diese Abfrage gibt alle Ressourcen mit einem Tagnamen zurück, departureDatedem der Ausdruck depart vorangestellt ist (d. h.department , departureTimeusw.).


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

filter?: string

Eigenschaftswert

string

top

Die Anzahl der zurückgegebenen Ergebnisse. Wenn NULL übergeben wird, werden alle Ressourcen zurückgegeben.

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 beim Ausführen des angeforderten Vorgangs eine Antwort vom Server empfangen 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 Überschreiben 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