EntitiesListNextOptionalParams interface

Pacchetto:

@azure/arm-managementgroups

Parametri facoltativi.

Extends

OperationOptions

Proprietà

cacheControl	Indica se la richiesta deve utilizzare eventuali cache. Popolare l'intestazione con il valore 'no-cache' per ignorare le cache esistenti.
filter	Il parametro di filtro consente di filtrare in base ai campi nome o nome visualizzato. È possibile verificare l'uguaglianza nel campo nome (ad esempio, nome eq '{entityName}') ed è possibile verificare la presenza di sottostringhe nei campi nome o nome visualizzato,ad esempio contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Si noti che i campi '{entityName}' e '{substringToSearch}' vengono controllati senza distinzione tra maiuscole e minuscole.
groupName	Filtro che consente alle entità di ottenere lo stato attivo 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 a cui 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à il padre e il primo livello di figli 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 ad almeno uno dei discendenti del gruppo. Con $search=ChildrenOnly l'API restituirà solo il primo livello di elementi figlio delle informazioni sull'entità di gruppo specificate in $filter. L'utente deve avere accesso diretto alle entità figlio o a uno dei discendenti affinché venga visualizzato nei risultati.
select	Questo parametro specifica i campi da includere nella risposta. Può includere qualsiasi combinazione di Name, DisplayName,Type,ParentDisplayNameChain,ParentChain, ad esempio '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Quando si specifica il parametro $select può eseguire l'override di select in $skipToken.
skip	Numero di entità da ignorare durante il recupero dei risultati. Se si passa questo valore, verrà eseguito 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. Se si passa questo valore, verrà eseguito l'override di $skipToken.
view	Il parametro view consente ai client di filtrare il tipo di dati restituiti dalla chiamata getEntities.

Proprietà ereditate

abortSignal	Segnale che può essere usato per interrompere le richieste.
onResponse	Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.
requestOptions	Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.
serializerOptions	Opzioni per eseguire l'override del comportamento di serializzazione/de-serializzazione.
tracingOptions	Opzioni utilizzate quando la traccia è abilitata.

Dettagli proprietà

cacheControl

Indica se la richiesta deve utilizzare eventuali cache. Popolare l'intestazione con il valore 'no-cache' per ignorare le cache esistenti.

cacheControl?: string

Valore della proprietà

string

filter

Il parametro di filtro consente di filtrare in base ai campi nome o nome visualizzato. È possibile verificare l'uguaglianza nel campo nome (ad esempio, nome eq '{entityName}') ed è possibile verificare la presenza di sottostringhe nei campi nome o nome visualizzato,ad esempio contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Si noti che i campi '{entityName}' e '{substringToSearch}' vengono controllati senza distinzione tra maiuscole e minuscole.

filter?: string

Valore della proprietà

string

groupName

Filtro che consente alle entità di ottenere lo stato attivo 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 a cui 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à il padre e il primo livello di figli 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 ad almeno uno dei discendenti del gruppo. Con $search=ChildrenOnly l'API restituirà solo il primo livello di elementi figlio delle informazioni sull'entità di gruppo specificate in $filter. L'utente deve avere accesso diretto alle entità figlio o a uno dei discendenti affinché venga visualizzato nei risultati.

search?: string

Valore della proprietà

string

select

Questo parametro specifica i campi da includere nella risposta. Può includere qualsiasi combinazione di Name, DisplayName,Type,ParentDisplayNameChain,ParentChain, ad esempio '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Quando si specifica il parametro $select può eseguire l'override di select in $skipToken.

select?: string

Valore della proprietà

string

skip

Numero di entità da ignorare durante il recupero dei risultati. Se si passa questo valore, verrà eseguito 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. Se si passa questo valore, verrà eseguito l'override di $skipToken.

top?: number

Valore della proprietà

number

view

Il parametro view 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à

AbortSignalLike

ereditato da coreClient.OperationOptions.abortSignal

onResponse

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à

RawResponseCallback

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à

OperationRequestOptions

Ereditato da coreClient.OperationOptions.requestOptions

serializerOptions

Opzioni per eseguire l'override del comportamento di serializzazione/de-serializzazione.

serializerOptions?: SerializerOptions

Valore della proprietà

SerializerOptions

Ereditato da coreClient.OperationOptions.serializerOptions

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

Ereditato da coreClient.OperationOptions.tracingOptions