EntitiesListNextOptionalParams interface

Balíček:

@azure/arm-managementgroups

Volitelné parametry.

Extends

OperationOptions

Vlastnosti

cacheControl	Určuje, jestli má požadavek využívat nějaké mezipaměti. Pokud chcete obejít existující mezipaměti, naplňte hlavičku hodnotou no-cache.
filter	Parametr filter umožňuje filtrovat pole názvů nebo zobrazovaných názvů. Můžete zkontrolovat rovnost v poli name (např. name eq '{entityName}') a můžete zkontrolovat podřetězece v polích name nebo display name (např. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Všimněte si, že pole {entityName} a {substringToSearch} se kontrolují nerozlišují malá a velká písmena.
groupName	Filtr, který umožňuje volání entity get zaměřit se na konkrétní skupinu (tj. "$filter=name eq 'groupName'")
search	Parametr $search se používá ve spojení s parametrem $filter k vrácení tří různých výstupů v závislosti na předaném parametru. V $search=AllowedParents vrátí rozhraní API informace o entitách všech skupin, ke kterým bude požadovaná entita moct přejít podle oprávnění uživatele. V $search=AllowedChildren vrátí rozhraní API informace o entitách všech entit, které je možné přidat jako podřízené položky požadované entity. S $search=ParentAndFirstLevelChildren vrátí rozhraní API nadřazenou a první úroveň podřízených položek, ke kterým má uživatel přímý nebo nepřímý přístup prostřednictvím některého ze svých potomků. S $search=ParentOnly vrátí rozhraní API pouze skupinu, pokud má uživatel přístup alespoň k jednomu z potomků skupiny. S $search=ChildrenOnly vrátí rozhraní API pouze první úroveň podřízených položek informací o entitě skupiny zadaných v $filter. Aby se uživatel mohl zobrazit ve výsledcích, musí mít přímý přístup k podřízeným entitám nebo k některému z jejich potomků.
select	Tento parametr určuje pole, která se mají zahrnout do odpovědi. Může obsahovat libovolnou kombinaci Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, například '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Při zadání může parametr $select přepsat select v $skipToken.
skip	Počet entit, které se mají při načítání výsledků přeskočit Předáním tohoto parametru dojde k přepsání $skipToken.
skiptoken	Pokračovací token stránky se používá jenom v případě, že předchozí operace vrátila částečný výsledek. Pokud předchozí odpověď obsahuje nextLink element, bude hodnota prvku nextLink obsahovat parametr tokenu, který určuje počáteční bod pro následné volání.
top	Počet prvků, které se mají vrátit při načítání výsledků Předáním tohoto parametru dojde k přepsání $skipToken.
view	Parametr view umožňuje klientům filtrovat typ dat vrácených voláním getEntities.

Zděděné vlastnosti

abortSignal	Signál, který lze použít k přerušení požadavků.
onResponse	Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může být volána vícekrát.
requestOptions	Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci
serializerOptions	Možnosti přepsání chování serializace/de-serializace.
tracingOptions	Možnosti použité při povoleném trasování.

Podrobnosti vlastnosti

cacheControl

Určuje, jestli má požadavek využívat nějaké mezipaměti. Pokud chcete obejít existující mezipaměti, naplňte hlavičku hodnotou no-cache.

cacheControl?: string

Hodnota vlastnosti

string

filter

Parametr filter umožňuje filtrovat pole názvů nebo zobrazovaných názvů. Můžete zkontrolovat rovnost v poli name (např. name eq '{entityName}') a můžete zkontrolovat podřetězece v polích name nebo display name (např. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Všimněte si, že pole {entityName} a {substringToSearch} se kontrolují nerozlišují malá a velká písmena.

filter?: string

Hodnota vlastnosti

string

groupName

Filtr, který umožňuje volání entity get zaměřit se na konkrétní skupinu (tj. "$filter=name eq 'groupName'")

groupName?: string

Hodnota vlastnosti

string

search

Parametr $search se používá ve spojení s parametrem $filter k vrácení tří různých výstupů v závislosti na předaném parametru. V $search=AllowedParents vrátí rozhraní API informace o entitách všech skupin, ke kterým bude požadovaná entita moct přejít podle oprávnění uživatele. V $search=AllowedChildren vrátí rozhraní API informace o entitách všech entit, které je možné přidat jako podřízené položky požadované entity. S $search=ParentAndFirstLevelChildren vrátí rozhraní API nadřazenou a první úroveň podřízených položek, ke kterým má uživatel přímý nebo nepřímý přístup prostřednictvím některého ze svých potomků. S $search=ParentOnly vrátí rozhraní API pouze skupinu, pokud má uživatel přístup alespoň k jednomu z potomků skupiny. S $search=ChildrenOnly vrátí rozhraní API pouze první úroveň podřízených položek informací o entitě skupiny zadaných v $filter. Aby se uživatel mohl zobrazit ve výsledcích, musí mít přímý přístup k podřízeným entitám nebo k některému z jejich potomků.

search?: string

Hodnota vlastnosti

string

select

Tento parametr určuje pole, která se mají zahrnout do odpovědi. Může obsahovat libovolnou kombinaci Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, například '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Při zadání může parametr $select přepsat select v $skipToken.

select?: string

Hodnota vlastnosti

string

skip

Počet entit, které se mají při načítání výsledků přeskočit Předáním tohoto parametru dojde k přepsání $skipToken.

skip?: number

Hodnota vlastnosti

number

skiptoken

Pokračovací token stránky se používá jenom v případě, že předchozí operace vrátila částečný výsledek. Pokud předchozí odpověď obsahuje nextLink element, bude hodnota prvku nextLink obsahovat parametr tokenu, který určuje počáteční bod pro následné volání.

skiptoken?: string

Hodnota vlastnosti

string

top

Počet prvků, které se mají vrátit při načítání výsledků Předáním tohoto parametru dojde k přepsání $skipToken.

top?: number

Hodnota vlastnosti

number

view

Parametr view umožňuje klientům filtrovat typ dat vrácených voláním getEntities.

view?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

Zděděno z coreClient.OperationOptions.abortSignal

onResponse

Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může být volána vícekrát.

onResponse?: RawResponseCallback

Hodnota vlastnosti

RawResponseCallback

Zděděno z coreClient.OperationOptions.onResponse

requestOptions

Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci

requestOptions?: OperationRequestOptions

Hodnota vlastnosti

OperationRequestOptions

Zděděno z coreClient.OperationOptions.requestOptions

serializerOptions

Možnosti přepsání chování serializace/de-serializace.

serializerOptions?: SerializerOptions

Hodnota vlastnosti

SerializerOptions

Zděděno z coreClient.OperationOptions.serializerOptions

tracingOptions

Možnosti použité při povoleném trasování.

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

Zděděno z coreClient.OperationOptions.tracingOptions