Поделиться через

ResourcesListOptionalParams interface

  • Ссылка
Пакет:
@azure/arm-resources

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

Extends
OperationOptions

Свойства

expand

Разделенный запятыми список дополнительных свойств, которые будут включены в ответ. Допустимые значения включают createdTime, changedTime и provisioningState. Например, $expand=createdTime,changedTime.
filter

Фильтр, применяемый к операции.

Операторы сравнения фильтров включают eq (равно) и ne (не равны) и могут использоваться со следующими свойствами: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versionи plan/promotionCode.

Например, чтобы отфильтровать по типу ресурса, используйте $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) можно использовать для фильтрации подстроок следующих поддерживаемых в настоящее время свойств: name и resourceGroup

Например, чтобы получить все ресурсы с "demo" в любом месте имени ресурса, используйте $filter=substringof('demo', name)

Можно также объединить несколько операций подстроки с помощью операторов and/or.

Обратите внимание, что любое усеченное количество результатов, запрашиваемых через $top, также может быть несовместимо при использовании фильтра.


Ресурсы можно фильтровать по именам тегов и значениям. Например, чтобы отфильтровать имя и значение тега, используйте $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Обратите внимание, что если ресурсы фильтруются по имени и значению тегов, исходные теги для каждого ресурса не будут возвращены в результатах. Любой список дополнительных свойств, запрашиваемых через $expand, также может быть несовместим при фильтрации по именам или значениям тегов.

Только для имен тегов ресурсы можно фильтровать по префиксу, используя следующий синтаксис: $filter=startswith(tagName, 'depart'). Этот запрос вернет все ресурсы с префиксом имени тега, который depart фразы (т. е.department, departureDate, departureTimeи т. д.)


Обратите внимание, что некоторые свойства можно объединить при фильтрации ресурсов, включая следующие: substringof() and/or resourceType, plan and plan/publisher and plan/nameи identity and identity/principalId.
top

Количество возвращаемых результатов. Если значение NULL передается, возвращает все ресурсы.

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

abortSignal

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

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

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

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

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

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

expand

Разделенный запятыми список дополнительных свойств, которые будут включены в ответ. Допустимые значения включают createdTime, changedTime и provisioningState. Например, $expand=createdTime,changedTime.

expand?: string

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

string

filter

Фильтр, применяемый к операции.

Операторы сравнения фильтров включают eq (равно) и ne (не равны) и могут использоваться со следующими свойствами: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versionи plan/promotionCode.

Например, чтобы отфильтровать по типу ресурса, используйте $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) можно использовать для фильтрации подстроок следующих поддерживаемых в настоящее время свойств: name и resourceGroup

Например, чтобы получить все ресурсы с "demo" в любом месте имени ресурса, используйте $filter=substringof('demo', name)

Можно также объединить несколько операций подстроки с помощью операторов and/or.

Обратите внимание, что любое усеченное количество результатов, запрашиваемых через $top, также может быть несовместимо при использовании фильтра.


Ресурсы можно фильтровать по именам тегов и значениям. Например, чтобы отфильтровать имя и значение тега, используйте $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Обратите внимание, что если ресурсы фильтруются по имени и значению тегов, исходные теги для каждого ресурса не будут возвращены в результатах. Любой список дополнительных свойств, запрашиваемых через $expand, также может быть несовместим при фильтрации по именам или значениям тегов.

Только для имен тегов ресурсы можно фильтровать по префиксу, используя следующий синтаксис: $filter=startswith(tagName, 'depart'). Этот запрос вернет все ресурсы с префиксом имени тега, который depart фразы (т. е.department, departureDate, departureTimeи т. д.)


Обратите внимание, что некоторые свойства можно объединить при фильтрации ресурсов, включая следующие: substringof() and/or resourceType, plan and plan/publisher and plan/nameи identity and identity/principalId.

filter?: string

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

string

top

Количество возвращаемых результатов. Если значение NULL передается, возвращает все ресурсы.

top?: number

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

number

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

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