EntitiesListOptionalParams interface

Indica se a solicitação deve utilizar algum cache. Preencha o cabeçalho com o valor 'no-cache' para ignorar caches existentes.

cacheControl?: string

Valor de Propriedade

O parâmetro filter permite filtrar os campos name ou display name. Você pode verificar a igualdade no campo name (por exemplo, name eq '{entityName}') e pode verificar se há substrings nos campos name ou display name (por exemplo, contains (name, '{substringToSearch}'), contains (displayName, '{substringToSearch')). Observe que os campos '{entityName}' e '{substringToSearch}' são verificados sem distinção entre maiúsculas e minúsculas.

filter?: string

Valor de Propriedade

Um filtro que permite que a chamada get entities se concentre em um grupo específico (ou seja, "$filter=name eq 'groupName'")

groupName?: string

Valor de Propriedade

O parâmetro $search é usado em conjunto com o parâmetro $filter para retornar três saídas diferentes, dependendo do parâmetro passado. Com $search=AllowedParents, a API retornará as informações da entidade de todos os grupos para os quais a entidade solicitada poderá reparentar conforme determinado pelas permissões do usuário. Com $search=AllowedChildren a API retornará as informações da entidade de todas as entidades que podem ser adicionadas como filhos da entidade solicitada. Com $search=ParentAndFirstLevelChildren, a API retornará o pai e o primeiro nível de filhos aos quais o usuário tem acesso direto ou indireto por meio de um de seus descendentes. Com $search=ParentOnly a API retornará somente o grupo se o usuário tiver acesso a pelo menos um dos descendentes do grupo. Com $search=ChildrenOnly, a API retornará apenas o primeiro nível de filhos das informações da entidade do grupo especificadas no $filter. O usuário deve ter acesso direto às entidades filhos ou a um de seus descendentes para que ele apareça nos resultados.

search?: string

Valor de Propriedade

Este parâmetro especifica os campos a serem incluídos na resposta. Pode incluir qualquer combinação de Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, por exemplo, '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. Quando especificado, o parâmetro $select pode substituir a seleção em $skipToken.

select?: string

Valor de Propriedade

Número de entidades a serem ignoradas ao recuperar resultados. Passar isso substituirá $skipToken.

skip?: number

Valor de Propriedade

O token de continuação de página só é usado se uma operação anterior retornou um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro de token que especifica um ponto de partida a ser usado para chamadas subsequentes.

skiptoken?: string

Valor de Propriedade

Número de elementos a serem retornados ao recuperar resultados. Passar isso substituirá $skipToken.

top?: number

Valor de Propriedade

O parâmetro view permite que os clientes filtrem o tipo de dados retornados pela chamada getEntities.

view?: string

Valor de Propriedade

O sinal que pode ser usado para abortar solicitações.

abortSignal?: AbortSignalLike

Valor de Propriedade

herdado de coreClient.OperationOptions.abortSignal

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor de Propriedade

herdado de coreClient.OperationOptions.onResponse

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

herdado de coreClient.OperationOptions.requestOptions

Opções para substituir o comportamento de serialização/desserialização.

serializerOptions?: SerializerOptions

Valor de Propriedade

herdado de coreClient.OperationOptions.serializerOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

herdado de coreClient.OperationOptions.tracingOptions