Compartir a través de

ResourcesListOptionalParams interface

  • Referencia
Paquete:
@azure/arm-resources

Parámetros opcionales.

Extends
OperationOptions

Propiedades

expand

Lista separada por comas de propiedades adicionales que se incluirán en la respuesta. Los valores válidos incluyen createdTime, changedTime y provisioningState. Por ejemplo, $expand=createdTime,changedTime.
filter

Filtro que se va a aplicar en la operación.

Los operadores de comparación de filtros incluyen eq (iguales) y ne (no iguales) y se pueden usar con las siguientes propiedades: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versiony plan/promotionCode.

Por ejemplo, para filtrar por un tipo de recurso, use $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) se puede usar para filtrar por subcadenas de las siguientes propiedades admitidas actualmente: name y resourceGroup

Por ejemplo, para obtener todos los recursos con "demo" en cualquier lugar del nombre del recurso, use $filter=substringof('demo', name)

También se pueden combinar varias operaciones de subcadena mediante operadores de and/or.

Tenga en cuenta que cualquier número truncado de resultados consultados a través de $top también puede no ser compatible al usar un filtro.


Los recursos se pueden filtrar por nombres y valores de etiqueta. Por ejemplo, para filtrar un nombre de etiqueta y un valor, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Tenga en cuenta que, cuando los recursos se filtran por nombre y valor de etiqueta, las etiquetas originales de cada recurso no se devolverán en los resultados. Cualquier lista de propiedades adicionales consultadas a través de $expand también puede no ser compatible al filtrar por nombres o valores de etiqueta.

Solo para los nombres de etiqueta, los recursos se pueden filtrar por prefijo mediante la sintaxis siguiente: $filter=startswith(tagName, 'depart'). Esta consulta devolverá todos los recursos con un nombre de etiqueta prefijo por la frase depart (es decir,department, departureDate, departureTime, etc.).


Tenga en cuenta que algunas propiedades se pueden combinar al filtrar recursos, que incluyen lo siguiente: substringof() and/or resourceType, plan and plan/publisher and plan/namey identity and identity/principalId.
top

Número de resultados que se van a devolver. Si se pasa null, devuelve todos los recursos.

Propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.
onResponse

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.
requestOptions

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.
serializerOptions

Opciones para invalidar el comportamiento de serialización o des serialización.
tracingOptions

Opciones que se usan al habilitar el seguimiento.

Detalles de las propiedades

expand

Lista separada por comas de propiedades adicionales que se incluirán en la respuesta. Los valores válidos incluyen createdTime, changedTime y provisioningState. Por ejemplo, $expand=createdTime,changedTime.

expand?: string

Valor de propiedad

string

filter

Filtro que se va a aplicar en la operación.

Los operadores de comparación de filtros incluyen eq (iguales) y ne (no iguales) y se pueden usar con las siguientes propiedades: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/versiony plan/promotionCode.

Por ejemplo, para filtrar por un tipo de recurso, use $filter=resourceType eq 'Microsoft.Network/virtualNetworks'


substringof(value, property) se puede usar para filtrar por subcadenas de las siguientes propiedades admitidas actualmente: name y resourceGroup

Por ejemplo, para obtener todos los recursos con "demo" en cualquier lugar del nombre del recurso, use $filter=substringof('demo', name)

También se pueden combinar varias operaciones de subcadena mediante operadores de and/or.

Tenga en cuenta que cualquier número truncado de resultados consultados a través de $top también puede no ser compatible al usar un filtro.


Los recursos se pueden filtrar por nombres y valores de etiqueta. Por ejemplo, para filtrar un nombre de etiqueta y un valor, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. Tenga en cuenta que, cuando los recursos se filtran por nombre y valor de etiqueta, las etiquetas originales de cada recurso no se devolverán en los resultados. Cualquier lista de propiedades adicionales consultadas a través de $expand también puede no ser compatible al filtrar por nombres o valores de etiqueta.

Solo para los nombres de etiqueta, los recursos se pueden filtrar por prefijo mediante la sintaxis siguiente: $filter=startswith(tagName, 'depart'). Esta consulta devolverá todos los recursos con un nombre de etiqueta prefijo por la frase depart (es decir,department, departureDate, departureTime, etc.).


Tenga en cuenta que algunas propiedades se pueden combinar al filtrar recursos, que incluyen lo siguiente: substringof() and/or resourceType, plan and plan/publisher and plan/namey identity and identity/principalId.

filter?: string

Valor de propiedad

string

top

Número de resultados que se van a devolver. Si se pasa null, devuelve todos los recursos.

top?: number

Valor de propiedad

number

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

AbortSignalLike

Heredado de coreClient.OperationOptions.abortSignal

onResponse

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

RawResponseCallback

se hereda de coreClient.OperationOptions.onResponse

requestOptions

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

OperationRequestOptions

Heredado de coreClient.OperationOptions.requestOptions

serializerOptions

Opciones para invalidar el comportamiento de serialización o des serialización.

serializerOptions?: SerializerOptions

Valor de propiedad

SerializerOptions

Se hereda de coreClient.OperationOptions.serializerOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

heredado de coreClient.OperationOptions.tracingOptions