EntitiesListOptionalParams interface

Paket:

@azure/arm-managementgroups

Valfria parametrar.

Extends

OperationOptions

Egenskaper

cacheControl	Anger om begäran ska använda några cacheminnen. Fyll i huvudet med värdet "ingen cache" för att kringgå befintliga cacheminnen.
filter	Med filterparametern kan du filtrera efter fälten namn eller visningsnamn. Du kan söka efter likhet i namnfältet (t.ex. namnet eq '{entityName}') och du kan söka efter delsträngar i antingen namn- eller visningsnamnfälten(t.ex. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Observera att fälten {entityName} och {substringToSearch} är okänsliga.
groupName	Ett filter som gör att anropet hämta entiteter kan fokusera på en viss grupp (dvs. "$filter=name eq 'groupName'")
search	Parametern $search används tillsammans med parametern $filter för att returnera tre olika utdata beroende på vilken parameter som skickas. Med $search=AllowedParents returnerar API:et entitetsinformationen för alla grupper som den begärda entiteten kommer att kunna följa enligt användarens behörigheter. Med $search=AllowedChildren returnerar API:et entitetsinformation för alla entiteter som kan läggas till som underordnade till den begärda entiteten. Med $search=ParentAndFirstLevelChildren returnerar API:et den överordnade och första nivån av underordnade som användaren antingen har direkt åtkomst till eller indirekt åtkomst via en av sina underordnade. Med $search=ParentOnly returnerar API:et endast gruppen om användaren har åtkomst till minst en av underordnade i gruppen. Med $search=ChildrenOnly returnerar API:et endast den första nivån av underordnade i gruppentitetsinformationen som anges i $filter. Användaren måste ha direkt åtkomst till underordnade entiteter eller någon av de underordnade för att den ska visas i resultatet.
select	Den här parametern anger de fält som ska inkluderas i svaret. Kan innehålla valfri kombination av Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, t.ex. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. När den har angetts kan $select-parametern åsidosätta valet i $skipToken.
skip	Antal entiteter som ska hoppa över när resultat hämtas. Om du skickar in detta åsidosätts $skipToken.
skiptoken	Sidfortsättningstoken används endast om en tidigare åtgärd returnerade ett partiellt resultat. Om ett tidigare svar innehåller ett nextLink-element innehåller värdet för nextLink-elementet en tokenparameter som anger en startpunkt som ska användas för efterföljande anrop.
top	Antal element som ska returneras vid hämtning av resultat. Om du skickar in detta åsidosätts $skipToken.
view	Med vyparametern kan klienter filtrera den typ av data som returneras av getEntities-anropet.

Ärvda egenskaper

abortSignal	Den signal som kan användas för att avbryta begäranden.
onResponse	En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
requestOptions	Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
serializerOptions	Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.
tracingOptions	Alternativ som används när spårning är aktiverat.

Egenskapsinformation

cacheControl

Anger om begäran ska använda några cacheminnen. Fyll i huvudet med värdet "ingen cache" för att kringgå befintliga cacheminnen.

cacheControl?: string

Egenskapsvärde

string

filter

Med filterparametern kan du filtrera efter fälten namn eller visningsnamn. Du kan söka efter likhet i namnfältet (t.ex. namnet eq '{entityName}') och du kan söka efter delsträngar i antingen namn- eller visningsnamnfälten(t.ex. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Observera att fälten {entityName} och {substringToSearch} är okänsliga.

filter?: string

Egenskapsvärde

string

groupName

Ett filter som gör att anropet hämta entiteter kan fokusera på en viss grupp (dvs. "$filter=name eq 'groupName'")

groupName?: string

Egenskapsvärde

string

search

Parametern $search används tillsammans med parametern $filter för att returnera tre olika utdata beroende på vilken parameter som skickas. Med $search=AllowedParents returnerar API:et entitetsinformationen för alla grupper som den begärda entiteten kommer att kunna följa enligt användarens behörigheter. Med $search=AllowedChildren returnerar API:et entitetsinformation för alla entiteter som kan läggas till som underordnade till den begärda entiteten. Med $search=ParentAndFirstLevelChildren returnerar API:et den överordnade och första nivån av underordnade som användaren antingen har direkt åtkomst till eller indirekt åtkomst via en av sina underordnade. Med $search=ParentOnly returnerar API:et endast gruppen om användaren har åtkomst till minst en av underordnade i gruppen. Med $search=ChildrenOnly returnerar API:et endast den första nivån av underordnade i gruppentitetsinformationen som anges i $filter. Användaren måste ha direkt åtkomst till underordnade entiteter eller någon av de underordnade för att den ska visas i resultatet.

search?: string

Egenskapsvärde

string

select

Den här parametern anger de fält som ska inkluderas i svaret. Kan innehålla valfri kombination av Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, t.ex. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. När den har angetts kan $select-parametern åsidosätta valet i $skipToken.

select?: string

Egenskapsvärde

string

skip

Antal entiteter som ska hoppa över när resultat hämtas. Om du skickar in detta åsidosätts $skipToken.

skip?: number

Egenskapsvärde

number

skiptoken

Sidfortsättningstoken används endast om en tidigare åtgärd returnerade ett partiellt resultat. Om ett tidigare svar innehåller ett nextLink-element innehåller värdet för nextLink-elementet en tokenparameter som anger en startpunkt som ska användas för efterföljande anrop.

skiptoken?: string

Egenskapsvärde

string

top

Antal element som ska returneras vid hämtning av resultat. Om du skickar in detta åsidosätts $skipToken.

top?: number

Egenskapsvärde

number

view

Med vyparametern kan klienter filtrera den typ av data som returneras av getEntities-anropet.

view?: string

Egenskapsvärde

string

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

ärvd från coreClient.OperationOptions.abortSignal

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

onResponse?: RawResponseCallback

Egenskapsvärde

RawResponseCallback

ärvd från coreClient.OperationOptions.onResponse

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

requestOptions?: OperationRequestOptions

Egenskapsvärde

OperationRequestOptions

ärvd från coreClient.OperationOptions.requestOptions

serializerOptions

Alternativ för att åsidosätta serialiserings-/av-serialiseringsbeteende.

serializerOptions?: SerializerOptions

Egenskapsvärde

SerializerOptions

ärvd från coreClient.OperationOptions.serializerOptions

tracingOptions

Alternativ som används när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

ärvd från coreClient.OperationOptions.tracingOptions