EntitiesListOptionalParams 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 pole názvu (např. name eq {entityName}) a podřetězece můžete zkontrolovat buď v polích názvu, nebo zobrazovaných názvů (např. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Všimněte si, že pole {entityName} a {substringToSearch} jsou kontrolována bez rozlišování velkých a malých písmen.
groupName	Filtr, který umožňuje volání entit 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. S $search=AllowedParents vrátí rozhraní API informace o entitách ze všech skupin, na které bude požadovaná entita moci znovu zobrazit, jak je určeno oprávněními uživatele. V $search=AllowedChildren vrátí rozhraní API informace o entitách všech entit, které lze 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ý přístup nebo nepřímý přístup prostřednictvím jednoho 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. V $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 některému z jeho 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'. Po zadání může parametr $select přepsat výběr v $skipToken.
skip	Počet entit, které se mají při načítání výsledků přeskočit Předáním této funkce přepíšete $skipToken.
skiptoken	Token pokračování stránky se používá pouze v případě, že předchozí operace vrátila částečný výsledek. Pokud předchozí odpověď obsahuje prvek nextLink, hodnota elementu nextLink bude obsahovat parametr tokenu, který určuje počáteční bod, který se má použít 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 této funkce přepíšete $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 nebo 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 pole názvu (např. name eq {entityName}) a podřetězece můžete zkontrolovat buď v polích názvu, nebo zobrazovaných názvů (např. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Všimněte si, že pole {entityName} a {substringToSearch} jsou kontrolována bez rozlišování velkých a malých písmen.

filter?: string

Hodnota vlastnosti

string

groupName

Filtr, který umožňuje volání entit 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. S $search=AllowedParents vrátí rozhraní API informace o entitách ze všech skupin, na které bude požadovaná entita moci znovu zobrazit, jak je určeno oprávněními uživatele. V $search=AllowedChildren vrátí rozhraní API informace o entitách všech entit, které lze 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ý přístup nebo nepřímý přístup prostřednictvím jednoho 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. V $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 některému z jeho 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'. Po zadání může parametr $select přepsat výběr 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 této funkce přepíšete $skipToken.

skip?: number

Hodnota vlastnosti

number

skiptoken

Token pokračování stránky se používá pouze v případě, že předchozí operace vrátila částečný výsledek. Pokud předchozí odpověď obsahuje prvek nextLink, hodnota elementu nextLink bude obsahovat parametr tokenu, který určuje počáteční bod, který se má použít 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 této funkce přepíšete $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 nebo 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