EntitiesListOptionalParams interface
Parametri facoltativi.
- Extends
Proprietà
cache |
Indica se la richiesta deve usare tutte le cache. Popolare l'intestazione con il valore "no-cache" per ignorare le cache esistenti. |
filter | Il parametro filtro consente di filtrare sui campi nome o nome visualizzato. È possibile verificare l'uguaglianza nel campo nome (ad esempio nome eq '{entityName}') ed è possibile verificare la presenza di sottostringa nei campi nome o nome visualizzato(ad esempio contains(name, '{substringToSearch}'), contains({substringToSearch}'), contains(displayName, '{substringToSearch'). Si noti che i campi '{entityName}' e '{substringToSearch}' vengono controllati in modo insensibile. |
group |
Filtro che consente alle entità di ottenere entità di concentrarsi su un determinato gruppo (ad esempio "$filter=name eq 'groupName'") |
search | Il parametro $search viene usato insieme al parametro $filter per restituire tre output diversi a seconda del parametro passato. Con $search=AllowedParents l'API restituirà le informazioni sull'entità di tutti i gruppi che l'entità richiesta sarà in grado di eseguire la replica come determinato dalle autorizzazioni dell'utente. Con $search=AllowedChildren l'API restituirà le informazioni sull'entità di tutte le entità che possono essere aggiunte come elementi figlio dell'entità richiesta. Con $search=ParentAndFirstLevelChildren, l'API restituirà l'elemento padre e il primo livello di figlio a cui l'utente ha accesso diretto o indiretto tramite uno dei discendenti. Con $search=ParentOnly l'API restituirà solo il gruppo se l'utente ha accesso a almeno uno dei discendenti del gruppo. Con $search=ChildrenOnly l'API restituirà solo il primo livello di elementi figlio delle informazioni sull'entità del gruppo specificate in $filter. L'utente deve avere accesso diretto alle entità figlio o uno dei discendenti per visualizzare i risultati. |
select | Questo parametro specifica i campi da includere nella risposta. Può includere qualsiasi combinazione di Nome,DisplayName,Type,ParentDisplayNameChain,ParentChain, ad esempio '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Quando è stato specificato il parametro $select può eseguire l'override della selezione in $skipToken. |
skip | Numero di entità da ignorare durante il recupero dei risultati. Il passaggio in eseguirà l'override di $skipToken. |
skiptoken | Il token di continuazione della pagina viene usato solo se un'operazione precedente ha restituito un risultato parziale. Se una risposta precedente contiene un elemento nextLink, il valore dell'elemento nextLink includerà un parametro token che specifica un punto di partenza da usare per le chiamate successive. |
top | Numero di elementi da restituire durante il recupero dei risultati. Il passaggio in eseguirà l'override di $skipToken. |
view | Il parametro di visualizzazione consente ai client di filtrare il tipo di dati restituiti dalla chiamata getEntities. |
Proprietà ereditate
abort |
Segnale che può essere usato per interrompere le richieste. |
on |
Una funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte. |
request |
Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione. |
serializer |
Opzioni per eseguire l'override del comportamento di serializzazione/de-serializzazione. |
tracing |
Opzioni usate quando la traccia è abilitata. |
Dettagli proprietà
cacheControl
Indica se la richiesta deve usare tutte le cache. Popolare l'intestazione con il valore "no-cache" per ignorare le cache esistenti.
cacheControl?: string
Valore della proprietà
string
filter
Il parametro filtro consente di filtrare sui campi nome o nome visualizzato. È possibile verificare l'uguaglianza nel campo nome (ad esempio nome eq '{entityName}') ed è possibile verificare la presenza di sottostringa nei campi nome o nome visualizzato(ad esempio contains(name, '{substringToSearch}'), contains({substringToSearch}'), contains(displayName, '{substringToSearch'). Si noti che i campi '{entityName}' e '{substringToSearch}' vengono controllati in modo insensibile.
filter?: string
Valore della proprietà
string
groupName
Filtro che consente alle entità di ottenere entità di concentrarsi su un determinato gruppo (ad esempio "$filter=name eq 'groupName'")
groupName?: string
Valore della proprietà
string
search
Il parametro $search viene usato insieme al parametro $filter per restituire tre output diversi a seconda del parametro passato. Con $search=AllowedParents l'API restituirà le informazioni sull'entità di tutti i gruppi che l'entità richiesta sarà in grado di eseguire la replica come determinato dalle autorizzazioni dell'utente. Con $search=AllowedChildren l'API restituirà le informazioni sull'entità di tutte le entità che possono essere aggiunte come elementi figlio dell'entità richiesta. Con $search=ParentAndFirstLevelChildren, l'API restituirà l'elemento padre e il primo livello di figlio a cui l'utente ha accesso diretto o indiretto tramite uno dei discendenti. Con $search=ParentOnly l'API restituirà solo il gruppo se l'utente ha accesso a almeno uno dei discendenti del gruppo. Con $search=ChildrenOnly l'API restituirà solo il primo livello di elementi figlio delle informazioni sull'entità del gruppo specificate in $filter. L'utente deve avere accesso diretto alle entità figlio o uno dei discendenti per visualizzare i risultati.
search?: string
Valore della proprietà
string
select
Questo parametro specifica i campi da includere nella risposta. Può includere qualsiasi combinazione di Nome,DisplayName,Type,ParentDisplayNameChain,ParentChain, ad esempio '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Quando è stato specificato il parametro $select può eseguire l'override della selezione in $skipToken.
select?: string
Valore della proprietà
string
skip
Numero di entità da ignorare durante il recupero dei risultati. Il passaggio in eseguirà l'override di $skipToken.
skip?: number
Valore della proprietà
number
skiptoken
Il token di continuazione della pagina viene usato solo se un'operazione precedente ha restituito un risultato parziale. Se una risposta precedente contiene un elemento nextLink, il valore dell'elemento nextLink includerà un parametro token che specifica un punto di partenza da usare per le chiamate successive.
skiptoken?: string
Valore della proprietà
string
top
Numero di elementi da restituire durante il recupero dei risultati. Il passaggio in eseguirà l'override di $skipToken.
top?: number
Valore della proprietà
number
view
Il parametro di visualizzazione consente ai client di filtrare il tipo di dati restituiti dalla chiamata getEntities.
view?: string
Valore della proprietà
string
Dettagli proprietà ereditate
abortSignal
Segnale che può essere usato per interrompere le richieste.
abortSignal?: AbortSignalLike
Valore della proprietà
Ereditato da coreClient.OperationOptions.abortSignal
onResponse
Una funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.
onResponse?: RawResponseCallback
Valore della proprietà
Ereditato da coreClient.OperationOptions.onResponse
requestOptions
Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.
requestOptions?: OperationRequestOptions
Valore della proprietà
Ereditato da coreClient.OperationOptions.requestOptions
serializerOptions
Opzioni per eseguire l'override del comportamento di serializzazione/de-serializzazione.
serializerOptions?: SerializerOptions
Valore della proprietà
Ereditato da coreClient.OperationOptions.serializerOptions
tracingOptions
Opzioni usate quando la traccia è abilitata.
tracingOptions?: OperationTracingOptions
Valore della proprietà
Ereditato da coreClient.OperationOptions.tracingOptions