Freigeben über

EntitiesListOptionalParams interface

  • Referenz
Paket:
@azure/arm-managementgroups

Optionale Parameter.

Extends
OperationOptions

Eigenschaften

cacheControl

Gibt an, ob die Anforderung Caches verwenden soll. Füllen Sie den Header mit dem Wert "no-cache", um vorhandene Caches zu umgehen.
filter

Mit dem Filterparameter können Sie nach den Feldern Name oder Anzeigename filtern. Sie können die Gleichheit im Namensfeld überprüfen (z. B. name eq '{entityName}'), und Sie können nach Teilzeichenfolgen für die Felder Name oder Anzeigename suchen (z. B. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Beachten Sie, dass bei den Feldern "{entityName}" und "{substringToSearch}" die Groß-/Kleinschreibung nicht beachtet wird.
groupName

Ein Filter, der es dem Aufruf von get-Entitäten ermöglicht, sich auf eine bestimmte Gruppe zu konzentrieren (d. h. "$filter=name eq 'groupName'").
search

Der parameter $search wird in Verbindung mit dem parameter $filter verwendet, um je nach übergebenem Parameter drei verschiedene Ausgaben zurückzugeben. Mit $search=AllowedParents gibt die API die Entitätsinformationen aller Gruppen zurück, für die die angeforderte Entität gemäß den Berechtigungen des Benutzers erneut verwendet werden kann. Mit $search=AllowedChildren gibt die API die Entitätsinformationen aller Entitäten zurück, die als untergeordnete Elemente der angeforderten Entität hinzugefügt werden können. Mit $search=ParentAndFirstLevelChildren gibt die API die übergeordnete und erste Ebene untergeordneter Elemente zurück, auf die der Benutzer entweder direkten Zugriff oder indirekten Zugriff über eine ihrer untergeordneten Elemente hat. Mit $search=ParentOnly gibt die API nur die Gruppe zurück, wenn der Benutzer Zugriff auf mindestens einen der untergeordneten Elemente der Gruppe hat. Mit $search=ChildrenOnly gibt die API nur die erste untergeordnete Ebene der in $filter angegebenen Gruppenentitätsinformationen zurück. Der Benutzer muss direkten Zugriff auf die untergeordneten Entitäten oder eine der untergeordneten Entitäten haben, damit er in den Ergebnissen angezeigt wird.
select

Dieser Parameter gibt die Felder an, die in die Antwort eingeschlossen werden sollen. Kann eine beliebige Kombination von Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, z. B. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain' enthalten. Wenn angegeben, kann der $select-Parameter die Option in $skipToken außer Kraft setzen.
skip

Anzahl der Entitäten, die beim Abrufen von Ergebnissen übersprungen werden sollen. Durch Die Übergabe wird $skipToken überschrieben.
skiptoken

Das Seitenfortsetzungstoken wird nur verwendet, wenn ein vorheriger Vorgang ein Teilergebnis zurückgegeben hat. Wenn eine vorherige Antwort ein nextLink-Element enthält, enthält der Wert des nextLink-Elements einen Tokenparameter, der einen Startpunkt angibt, der für nachfolgende Aufrufe verwendet werden soll.
top

Anzahl der Elemente, die beim Abrufen von Ergebnissen zurückgegeben werden sollen. Durch Die Übergabe wird $skipToken überschrieben.
view

Mit dem View-Parameter können Clients den Datentyp filtern, der vom aufruf getEntities zurückgegeben wird.

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

cacheControl

Gibt an, ob die Anforderung Caches verwenden soll. Füllen Sie den Header mit dem Wert "no-cache", um vorhandene Caches zu umgehen.

cacheControl?: string

Eigenschaftswert

string

filter

Mit dem Filterparameter können Sie nach den Feldern Name oder Anzeigename filtern. Sie können die Gleichheit im Namensfeld überprüfen (z. B. name eq '{entityName}'), und Sie können nach Teilzeichenfolgen für die Felder Name oder Anzeigename suchen (z. B. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Beachten Sie, dass bei den Feldern "{entityName}" und "{substringToSearch}" die Groß-/Kleinschreibung nicht beachtet wird.

filter?: string

Eigenschaftswert

string

groupName

Ein Filter, der es dem Aufruf von get-Entitäten ermöglicht, sich auf eine bestimmte Gruppe zu konzentrieren (d. h. "$filter=name eq 'groupName'").

groupName?: string

Eigenschaftswert

string

Der parameter $search wird in Verbindung mit dem parameter $filter verwendet, um je nach übergebenem Parameter drei verschiedene Ausgaben zurückzugeben. Mit $search=AllowedParents gibt die API die Entitätsinformationen aller Gruppen zurück, für die die angeforderte Entität gemäß den Berechtigungen des Benutzers erneut verwendet werden kann. Mit $search=AllowedChildren gibt die API die Entitätsinformationen aller Entitäten zurück, die als untergeordnete Elemente der angeforderten Entität hinzugefügt werden können. Mit $search=ParentAndFirstLevelChildren gibt die API die übergeordnete und erste Ebene untergeordneter Elemente zurück, auf die der Benutzer entweder direkten Zugriff oder indirekten Zugriff über eine ihrer untergeordneten Elemente hat. Mit $search=ParentOnly gibt die API nur die Gruppe zurück, wenn der Benutzer Zugriff auf mindestens einen der untergeordneten Elemente der Gruppe hat. Mit $search=ChildrenOnly gibt die API nur die erste untergeordnete Ebene der in $filter angegebenen Gruppenentitätsinformationen zurück. Der Benutzer muss direkten Zugriff auf die untergeordneten Entitäten oder eine der untergeordneten Entitäten haben, damit er in den Ergebnissen angezeigt wird.

search?: string

Eigenschaftswert

string

select

Dieser Parameter gibt die Felder an, die in die Antwort eingeschlossen werden sollen. Kann eine beliebige Kombination von Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, z. B. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain' enthalten. Wenn angegeben, kann der $select-Parameter die Option in $skipToken außer Kraft setzen.

select?: string

Eigenschaftswert

string

skip

Anzahl der Entitäten, die beim Abrufen von Ergebnissen übersprungen werden sollen. Durch Die Übergabe wird $skipToken überschrieben.

skip?: number

Eigenschaftswert

number

skiptoken

Das Seitenfortsetzungstoken wird nur verwendet, wenn ein vorheriger Vorgang ein Teilergebnis zurückgegeben hat. Wenn eine vorherige Antwort ein nextLink-Element enthält, enthält der Wert des nextLink-Elements einen Tokenparameter, der einen Startpunkt angibt, der für nachfolgende Aufrufe verwendet werden soll.

skiptoken?: string

Eigenschaftswert

string

top

Anzahl der Elemente, die beim Abrufen von Ergebnissen zurückgegeben werden sollen. Durch Die Übergabe wird $skipToken überschrieben.

top?: number

Eigenschaftswert

number

view

Mit dem View-Parameter können Clients den Datentyp filtern, der vom aufruf getEntities zurückgegeben wird.

view?: string

Eigenschaftswert

string

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