EntitiesListOptionalParams interface

Pakket:

@azure/arm-managementgroups

Optionele parameters.

Uitbreiding

OperationOptions

Eigenschappen

cacheControl	Geeft aan of de aanvraag caches moet gebruiken. Vul de header in met de waarde 'no-cache' om bestaande caches te omzeilen.
filter	Met de filterparameter kunt u filteren op de naam- of weergavenaamvelden. U kunt controleren op gelijkheid in het naamveld (bijvoorbeeld naam eq {entityName}) en u kunt controleren op subtekenreeksen op de naam- of weergavenaamvelden (bijvoorbeeld contains(name, {substringToSearch}), contains(displayName, {substringToSearch)). Houd er rekening mee dat de velden {entityName} en {substringToSearch} niet hoofdlettergevoelig worden gecontroleerd.
groupName	Een filter waarmee de get-entiteiten zich kunnen richten op een bepaalde groep (bijvoorbeeld "$filter=name eq 'groupName')
search	De parameter $search wordt gebruikt in combinatie met de parameter $filter om drie verschillende uitvoer te retourneren, afhankelijk van de doorgegeven parameter. Met $search=AllowedParents retourneert de API de entiteitsgegevens van alle groepen waartoe de aangevraagde entiteit kan reparenten zoals bepaald door de machtigingen van de gebruiker. Met $search=Allowed Children retourneert de API de entiteitsgegevens van alle entiteiten die kunnen worden toegevoegd als onderliggende items van de aangevraagde entiteit. Met $search=ParentAndFirstLevel Children retourneert de API het bovenliggende en eerste niveau van onderliggende elementen dat de gebruiker directe toegang tot of indirecte toegang heeft via een van hun nakomelingen. Met $search=ParentOnly retourneert de API alleen de groep als de gebruiker toegang heeft tot ten minste één van de afstammelingen van de groep. Met $search=ChildrenOnly retourneert de API alleen het eerste niveau van onderliggende elementen van de groepsentiteitsgegevens die zijn opgegeven in $filter. De gebruiker moet directe toegang hebben tot de onderliggende entiteiten of een van de onderliggende entiteiten om deze weer te geven in de resultaten.
select	Met deze parameter geeft u de velden op die moeten worden opgenomen in het antwoord. Kan elke combinatie van Naam, DisplayName, Type, ParentDisplayNameChain, ParentChain, bijvoorbeeld '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain', bevatten. Wanneer u de parameter $select opgeeft, kunt u de selectie in $skipToken overschrijven.
skip	Het aantal entiteiten dat moet worden overgeslagen bij het ophalen van resultaten. Als u dit doorgeeft, wordt $skipToken overschreven.
skiptoken	Het vervolgtoken van de pagina wordt alleen gebruikt als een vorige bewerking een gedeeltelijk resultaat heeft geretourneerd. Als een eerder antwoord een nextLink-element bevat, bevat de waarde van het nextLink-element een tokenparameter die een beginpunt aangeeft dat moet worden gebruikt voor volgende aanroepen.
top	Aantal elementen dat moet worden geretourneerd bij het ophalen van resultaten. Als u dit doorgeeft, wordt $skipToken overschreven.
view	Met de weergaveparameter kunnen clients het type gegevens filteren dat wordt geretourneerd door de aanroep Entiteiten ophalen.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse	Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions	Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
serializerOptions	Opties voor het overschrijven van serialisatie/deserialisatiegedrag.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

cacheControl

Geeft aan of de aanvraag caches moet gebruiken. Vul de header in met de waarde 'no-cache' om bestaande caches te omzeilen.

cacheControl?: string

Waarde van eigenschap

string

filter

Met de filterparameter kunt u filteren op de naam- of weergavenaamvelden. U kunt controleren op gelijkheid in het naamveld (bijvoorbeeld naam eq {entityName}) en u kunt controleren op subtekenreeksen op de naam- of weergavenaamvelden (bijvoorbeeld contains(name, {substringToSearch}), contains(displayName, {substringToSearch)). Houd er rekening mee dat de velden {entityName} en {substringToSearch} niet hoofdlettergevoelig worden gecontroleerd.

filter?: string

Waarde van eigenschap

string

groupName

Een filter waarmee de get-entiteiten zich kunnen richten op een bepaalde groep (bijvoorbeeld "$filter=name eq 'groupName')

groupName?: string

Waarde van eigenschap

string

search

De parameter $search wordt gebruikt in combinatie met de parameter $filter om drie verschillende uitvoer te retourneren, afhankelijk van de doorgegeven parameter. Met $search=AllowedParents retourneert de API de entiteitsgegevens van alle groepen waartoe de aangevraagde entiteit kan reparenten zoals bepaald door de machtigingen van de gebruiker. Met $search=Allowed Children retourneert de API de entiteitsgegevens van alle entiteiten die kunnen worden toegevoegd als onderliggende items van de aangevraagde entiteit. Met $search=ParentAndFirstLevel Children retourneert de API het bovenliggende en eerste niveau van onderliggende elementen dat de gebruiker directe toegang tot of indirecte toegang heeft via een van hun nakomelingen. Met $search=ParentOnly retourneert de API alleen de groep als de gebruiker toegang heeft tot ten minste één van de afstammelingen van de groep. Met $search=ChildrenOnly retourneert de API alleen het eerste niveau van onderliggende elementen van de groepsentiteitsgegevens die zijn opgegeven in $filter. De gebruiker moet directe toegang hebben tot de onderliggende entiteiten of een van de onderliggende entiteiten om deze weer te geven in de resultaten.

search?: string

Waarde van eigenschap

string

select

Met deze parameter geeft u de velden op die moeten worden opgenomen in het antwoord. Kan elke combinatie van Naam, DisplayName, Type, ParentDisplayNameChain, ParentChain, bijvoorbeeld '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain', bevatten. Wanneer u de parameter $select opgeeft, kunt u de selectie in $skipToken overschrijven.

select?: string

Waarde van eigenschap

string

skip

Het aantal entiteiten dat moet worden overgeslagen bij het ophalen van resultaten. Als u dit doorgeeft, wordt $skipToken overschreven.

skip?: number

Waarde van eigenschap

number

skiptoken

Het vervolgtoken van de pagina wordt alleen gebruikt als een vorige bewerking een gedeeltelijk resultaat heeft geretourneerd. Als een eerder antwoord een nextLink-element bevat, bevat de waarde van het nextLink-element een tokenparameter die een beginpunt aangeeft dat moet worden gebruikt voor volgende aanroepen.

skiptoken?: string

Waarde van eigenschap

string

top

Aantal elementen dat moet worden geretourneerd bij het ophalen van resultaten. Als u dit doorgeeft, wordt $skipToken overschreven.

top?: number

Waarde van eigenschap

number

view

Met de weergaveparameter kunnen clients het type gegevens filteren dat wordt geretourneerd door de aanroep Entiteiten ophalen.

view?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van coreClient.OperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van coreClient.OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van coreClient.OperationOptions.requestOptions

serializerOptions

Opties voor het overschrijven van serialisatie/deserialisatiegedrag.

serializerOptions?: SerializerOptions

Waarde van eigenschap

SerializerOptions

overgenomen van coreClient.OperationOptions.serializerOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van coreClient.OperationOptions.tracingOptions