EntitiesListOptionalParams interface

Paquete:

@azure/arm-managementgroups

Parámetros opcionales.

Extends

OperationOptions

Propiedades

cacheControl	Indica si la solicitud debe utilizar las memorias caché. Rellene el encabezado con el valor "no-cache" para omitir las cachés existentes.
filter	El parámetro filter permite filtrar por los campos nombre o nombre para mostrar. Puede comprobar si hay igualdad en el campo de nombre (por ejemplo, nombre eq '{entityName}') y puede comprobar si hay subcadenas en los campos de nombre o nombre para mostrar (por ejemplo, contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Tenga en cuenta que los campos '{entityName}' y '{substringToSearch}' no distinguen mayúsculas de minúsculas.
groupName	Filtro que permite que las entidades get se centren en un grupo determinado (es decir, "$filter=name eq 'groupName'")
search	El parámetro $search se usa junto con el parámetro $filter para devolver tres salidas diferentes en función del parámetro pasado. Con $search=AllowedParents, la API devolverá la información de entidad de todos los grupos a los que la entidad solicitada podrá volver a ser primario según lo determinen los permisos del usuario. Con $search=AllowedChildren, la API devolverá la información de entidad de todas las entidades que se pueden agregar como elementos secundarios de la entidad solicitada. Con $search=ParentAndFirstLevelChildren, la API devolverá el nivel primario y el primer nivel de elementos secundarios a los que el usuario tiene acceso directo o indirecto a través de uno de sus descendientes. Con $search=ParentOnly, la API devolverá solo el grupo si el usuario tiene acceso a al menos uno de los descendientes del grupo. Con $search=ChildrenOnly, la API devolverá solo el primer nivel de elementos secundarios de la información de entidad de grupo especificada en $filter. El usuario debe tener acceso directo a las entidades secundarias o a uno de sus descendientes para que aparezca en los resultados.
select	Este parámetro especifica los campos que se van a incluir en la respuesta. Puede incluir cualquier combinación de Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, por ejemplo, '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Cuando se especifica el parámetro $select puede invalidar la selección en $skipToken.
skip	Número de entidades que se omitirán al recuperar los resultados. Pasar esto en invalidará $skipToken.
skiptoken	El token de continuación de página solo se usa si una operación anterior devolvió un resultado parcial. Si una respuesta anterior contiene un elemento nextLink, el valor del elemento nextLink incluirá un parámetro de token que especifica un punto de partida que se usará para las llamadas posteriores.
top	Número de elementos que se van a devolver al recuperar resultados. Pasar esto en invalidará $skipToken.
view	El parámetro view permite a los clientes filtrar el tipo de datos devueltos por la llamada getEntities.

Propiedades heredadas

abortSignal	Señal que se puede usar para anular las solicitudes.
onResponse	Una 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 usadas 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

cacheControl

Indica si la solicitud debe utilizar las memorias caché. Rellene el encabezado con el valor "no-cache" para omitir las cachés existentes.

cacheControl?: string

Valor de propiedad

string

filter

El parámetro filter permite filtrar por los campos nombre o nombre para mostrar. Puede comprobar si hay igualdad en el campo de nombre (por ejemplo, nombre eq '{entityName}') y puede comprobar si hay subcadenas en los campos de nombre o nombre para mostrar (por ejemplo, contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Tenga en cuenta que los campos '{entityName}' y '{substringToSearch}' no distinguen mayúsculas de minúsculas.

filter?: string

Valor de propiedad

string

groupName

Filtro que permite que las entidades get se centren en un grupo determinado (es decir, "$filter=name eq 'groupName'")

groupName?: string

Valor de propiedad

string

search

El parámetro $search se usa junto con el parámetro $filter para devolver tres salidas diferentes en función del parámetro pasado. Con $search=AllowedParents, la API devolverá la información de entidad de todos los grupos a los que la entidad solicitada podrá volver a ser primario según lo determinen los permisos del usuario. Con $search=AllowedChildren, la API devolverá la información de entidad de todas las entidades que se pueden agregar como elementos secundarios de la entidad solicitada. Con $search=ParentAndFirstLevelChildren, la API devolverá el nivel primario y el primer nivel de elementos secundarios a los que el usuario tiene acceso directo o indirecto a través de uno de sus descendientes. Con $search=ParentOnly, la API devolverá solo el grupo si el usuario tiene acceso a al menos uno de los descendientes del grupo. Con $search=ChildrenOnly, la API devolverá solo el primer nivel de elementos secundarios de la información de entidad de grupo especificada en $filter. El usuario debe tener acceso directo a las entidades secundarias o a uno de sus descendientes para que aparezca en los resultados.

search?: string

Valor de propiedad

string

select

Este parámetro especifica los campos que se van a incluir en la respuesta. Puede incluir cualquier combinación de Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, por ejemplo, '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Cuando se especifica el parámetro $select puede invalidar la selección en $skipToken.

select?: string

Valor de propiedad

string

skip

Número de entidades que se omitirán al recuperar los resultados. Pasar esto en invalidará $skipToken.

skip?: number

Valor de propiedad

number

skiptoken

El token de continuación de página solo se usa si una operación anterior devolvió un resultado parcial. Si una respuesta anterior contiene un elemento nextLink, el valor del elemento nextLink incluirá un parámetro de token que especifica un punto de partida que se usará para las llamadas posteriores.

skiptoken?: string

Valor de propiedad

string

top

Número de elementos que se van a devolver al recuperar resultados. Pasar esto en invalidará $skipToken.

top?: number

Valor de propiedad

number

view

El parámetro view permite a los clientes filtrar el tipo de datos devueltos por la llamada getEntities.

view?: string

Valor de propiedad

string

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

Una 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

Heredado de coreClient.OperationOptions.onResponse

requestOptions

Opciones usadas 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

Heredado de coreClient.OperationOptions.serializerOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

OperationTracingOptions

Se hereda de coreClient.OperationOptions.tracingOptions