EntitiesListOptionalParams interface

Balíček:

@azure/arm-managementgroups

Volitelné parametry.

Extends

OperationOptions

Vlastnosti

cacheControl	Určuje, jestli má požadavek využívat jakékoli mezipaměti. Naplňte hlavičku hodnotou no-cache, aby se stávající mezipaměti vynechaly.
filter	Parametr filtru umožňuje filtrovat podle polí názvu nebo zobrazovaného názvu. Můžete zkontrolovat rovnost u pole názvu (např. name eq {entityName}) a můžete zkontrolovat podřetězce u polí názvu nebo zobrazovaného názvu (např. contains(name; '{substringToSearch}'), contains(displayName; '{substringToSearch')). Všimněte si, že pole {entityName} a {substringToSearch} se nerozlišují malá a velká písmena.
groupName	Filtr, který umožňuje volání entit získat fokus 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. Když použijete $search=AllowedParents, rozhraní API vrátí informace o entitách všech skupin, na které bude požadovaná entita moct znovu reagovat podle toho, jak určuje oprávnění uživatele. V $search=AllowedChildren rozhraní API vrátí informace o entitách všech entit, které je možné přidat jako podřízené položky požadované entity. V $search=ParentAndFirstLevelChildren rozhraní API vrátí nadřazenou a první úroveň podřízených položek, ke kterým má uživatel přímý přístup prostřednictvím jednoho ze svých potomků. S $search=ParentOnly rozhraní API vrátí 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 údajů entity skupiny zadané 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é z podřízených entit.
select	Tento parametr určuje pole, která mají být zahrnuta 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í parametru $select může přepsat výběr v $skipToken.
skip	Počet entit, které se mají přeskočit při načítání výsledků Předáním tohoto $skipToken se přepíše.
skiptoken	Token pro 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 výchozí 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 tohoto $skipToken se přepíše.
view	Parametr zobrazení 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 se volat 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í serializace/de-serializace chování.
tracingOptions	Možnosti používané při povolení trasování

Podrobnosti vlastnosti

cacheControl

Určuje, jestli má požadavek využívat jakékoli mezipaměti. Naplňte hlavičku hodnotou no-cache, aby se stávající mezipaměti vynechaly.

cacheControl?: string

Hodnota vlastnosti

string

filter

Parametr filtru umožňuje filtrovat podle polí názvu nebo zobrazovaného názvu. Můžete zkontrolovat rovnost u pole názvu (např. name eq {entityName}) a můžete zkontrolovat podřetězce u polí názvu nebo zobrazovaného názvu (např. contains(name; '{substringToSearch}'), contains(displayName; '{substringToSearch')). Všimněte si, že pole {entityName} a {substringToSearch} se nerozlišují malá a velká písmena.

filter?: string

Hodnota vlastnosti

string

groupName

Filtr, který umožňuje volání entit získat fokus 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. Když použijete $search=AllowedParents, rozhraní API vrátí informace o entitách všech skupin, na které bude požadovaná entita moct znovu reagovat podle toho, jak určuje oprávnění uživatele. V $search=AllowedChildren rozhraní API vrátí informace o entitách všech entit, které je možné přidat jako podřízené položky požadované entity. V $search=ParentAndFirstLevelChildren rozhraní API vrátí nadřazenou a první úroveň podřízených položek, ke kterým má uživatel přímý přístup prostřednictvím jednoho ze svých potomků. S $search=ParentOnly rozhraní API vrátí 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 údajů entity skupiny zadané 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é z podřízených entit.

search?: string

Hodnota vlastnosti

string

select

Tento parametr určuje pole, která mají být zahrnuta 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í parametru $select může přepsat výběr v $skipToken.

select?: string

Hodnota vlastnosti

string

skip

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

skip?: number

Hodnota vlastnosti

number

skiptoken

Token pro 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 výchozí 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 tohoto $skipToken se přepíše.

top?: number

Hodnota vlastnosti

number

view

Parametr zobrazení 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ěný 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 se volat 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ěné z coreClient.OperationOptions.requestOptions

serializerOptions

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

serializerOptions?: SerializerOptions

Hodnota vlastnosti

SerializerOptions

zděděno z coreClient.OperationOptions.serializerOptions

tracingOptions

Možnosti používané při povolení trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

zděděno z coreClient.OperationOptions.tracingOptions