EntitiesListNextOptionalParams interface

Пакет:

@azure/arm-managementgroups

Необязательные параметры.

Extends

OperationOptions

Свойства

cacheControl	Указывает, должен ли запрос использовать любые кэши. Заполните заголовок значением no-cache, чтобы обойти существующие кэши.
filter	Параметр фильтра позволяет фильтровать поля имени или отображаемого имени. Вы можете проверить равенство в поле имени (например, имя "{entityName}"), а также проверить наличие подстроок в полях имени или отображаемого имени (например, contains(name, "{substringToSearch}"), contains(displayName, "{substringToSearch")). Обратите внимание, что поля "{entityName}" и "{substringToSearch}" проверяются без учета регистра.
groupName	Фильтр, позволяющий вызову сущностей сосредоточиться на определенной группе (т. е. "$filter=name eq 'groupName'")
search	Параметр $search используется вместе с параметром $filter для возврата трех разных выходных данных в зависимости от переданного параметра. С помощью $search=AllowedParents API вернет сведения о сущности всех групп, к которым запрашиваемая сущность сможет вернуться в соответствии с разрешениями пользователя. С помощью $search=AllowedChildren API возвращает сведения о сущностях всех сущностей, которые можно добавить в качестве дочерних элементов запрошенной сущности. С помощью $search=ParentAndFirstLevelChildren API вернет родительский и первый уровень дочерних элементов, к которым пользователь имеет прямой доступ или косвенный доступ через один из потомков. При использовании $search=ParentOnly API возвращает только группу, если пользователь имеет доступ по крайней мере к одному из потомков группы. При использовании $search=ChildrenOnly API возвращает только первый уровень дочерних элементов группы, указанных в $filter. Пользователь должен иметь прямой доступ к дочерним сущностям или одному из потомков для отображения в результатах.
select	Этот параметр указывает поля для включения в ответ. Может включать любое сочетание Name, DisplayName, Type, ParentDisplayNameChain, ParentChain, например "$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain". При указании параметра $select можно переопределить выбор в $skipToken.
skip	Количество сущностей, которые следует пропустить при получении результатов. Передача этого параметра переопределит $skipToken.
skiptoken	Маркер продолжения страницы используется только в том случае, если предыдущая операция вернула частичный результат. Если предыдущий ответ содержит элемент nextLink, значение элемента nextLink будет включать параметр токена, указывающий начальную точку для последующих вызовов.
top	Количество элементов, возвращаемых при получении результатов. Передача этого параметра переопределит $skipToken.
view	Параметр представления позволяет клиентам фильтровать тип данных, возвращаемых вызовом getEntities.

Унаследованные свойства

abortSignal	Сигнал, который можно использовать для прерывания запросов.
onResponse	Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.
requestOptions	Параметры, используемые при создании и отправке HTTP-запросов для этой операции.
serializerOptions	Параметры переопределения поведения сериализации и десериализации.
tracingOptions	Параметры, используемые при включении трассировки.

Сведения о свойстве

cacheControl

Указывает, должен ли запрос использовать любые кэши. Заполните заголовок значением no-cache, чтобы обойти существующие кэши.

cacheControl?: string

Значение свойства

string

filter

Параметр фильтра позволяет фильтровать поля имени или отображаемого имени. Вы можете проверить равенство в поле имени (например, имя "{entityName}"), а также проверить наличие подстроок в полях имени или отображаемого имени (например, contains(name, "{substringToSearch}"), contains(displayName, "{substringToSearch")). Обратите внимание, что поля "{entityName}" и "{substringToSearch}" проверяются без учета регистра.

filter?: string

Значение свойства

string

groupName

Фильтр, позволяющий вызову сущностей сосредоточиться на определенной группе (т. е. "$filter=name eq 'groupName'")

groupName?: string

Значение свойства

string

search

Параметр $search используется вместе с параметром $filter для возврата трех разных выходных данных в зависимости от переданного параметра. С помощью $search=AllowedParents API вернет сведения о сущности всех групп, к которым запрашиваемая сущность сможет вернуться в соответствии с разрешениями пользователя. С помощью $search=AllowedChildren API возвращает сведения о сущностях всех сущностей, которые можно добавить в качестве дочерних элементов запрошенной сущности. С помощью $search=ParentAndFirstLevelChildren API вернет родительский и первый уровень дочерних элементов, к которым пользователь имеет прямой доступ или косвенный доступ через один из потомков. При использовании $search=ParentOnly API возвращает только группу, если пользователь имеет доступ по крайней мере к одному из потомков группы. При использовании $search=ChildrenOnly API возвращает только первый уровень дочерних элементов группы, указанных в $filter. Пользователь должен иметь прямой доступ к дочерним сущностям или одному из потомков для отображения в результатах.

search?: string

Значение свойства

string

select

Этот параметр указывает поля для включения в ответ. Может включать любое сочетание Name, DisplayName, Type, ParentDisplayNameChain, ParentChain, например "$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain". При указании параметра $select можно переопределить выбор в $skipToken.

select?: string

Значение свойства

string

skip

Количество сущностей, которые следует пропустить при получении результатов. Передача этого параметра переопределит $skipToken.

skip?: number

Значение свойства

number

skiptoken

Маркер продолжения страницы используется только в том случае, если предыдущая операция вернула частичный результат. Если предыдущий ответ содержит элемент nextLink, значение элемента nextLink будет включать параметр токена, указывающий начальную точку для последующих вызовов.

skiptoken?: string

Значение свойства

string

top

Количество элементов, возвращаемых при получении результатов. Передача этого параметра переопределит $skipToken.

top?: number

Значение свойства

number

view

Параметр представления позволяет клиентам фильтровать тип данных, возвращаемых вызовом getEntities.

view?: string

Значение свойства

string

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

Значение свойства

AbortSignalLike

наследуется от coreClient.OperationOptions.abortSignal

onResponse

Функция, вызываемая каждый раз при получении ответа от сервера при выполнении запрошенной операции. Может вызываться несколько раз.

onResponse?: RawResponseCallback

Значение свойства

RawResponseCallback

унаследовано от coreClient.OperationOptions.onResponse

requestOptions

Параметры, используемые при создании и отправке HTTP-запросов для этой операции.

requestOptions?: OperationRequestOptions

Значение свойства

OperationRequestOptions

наследуется от coreClient.OperationOptions.requestOptions

serializerOptions

Параметры переопределения поведения сериализации и десериализации.

serializerOptions?: SerializerOptions

Значение свойства

SerializerOptions

Унаследовано от coreClient.OperationOptions.serializerOptions

tracingOptions

Параметры, используемые при включении трассировки.

tracingOptions?: OperationTracingOptions

Значение свойства

OperationTracingOptions

унаследовано от coreClient.OperationOptions.tracingOptions