Partilhar via

EntitiesListOptionalParams interface

  • Referência
Pacote:
@azure/arm-managementgroups

Parâmetros opcionais.

Extends
OperationOptions

Propriedades

cacheControl

Indica se o pedido deve utilizar caches. Preencha o cabeçalho com o valor "sem cache" para ignorar as caches existentes.
filter

O parâmetro de filtro permite-lhe filtrar os campos de nome ou nome a apresentar. Pode verificar a igualdade no campo de nome (por exemplo, nome eq '{entityName}') e pode verificar a existência de subcadeias nos campos de nome ou nome a apresentar(por exemplo, contém(nome, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Tenha em atenção que os campos "{entityName}" e "{substringToSearch}" são verificados de forma não sensível às maiúsculas e minúsculas.
groupName

Um filtro que permite que a chamada obter entidades se concentre num grupo específico (ou seja, "$filter=name eq 'groupName'")
search

O parâmetro $search é utilizado em conjunto com o parâmetro $filter para devolver três saídas diferentes, consoante o parâmetro transmitido. Com $search=AllowedParents, a API devolverá as informações de entidade de todos os grupos para os quais a entidade pedida poderá repará-lo conforme determinado pelas permissões do utilizador. Com $search=AllowedChildren, a API devolverá as informações de entidade de todas as entidades que podem ser adicionadas como subordinados da entidade pedida. Com $search=ParentAndFirstLevelChildren, a API devolverá o principal e o primeiro nível de crianças aos quais o utilizador tem acesso direto ou indireto através de um dos seus descendentes. Com $search=ParentOnly, a API devolverá apenas o grupo se o utilizador tiver acesso a, pelo menos, um dos descendentes do grupo. Com $search=ChildrenOnly, a API devolverá apenas o primeiro nível de subordinados das informações da entidade de grupo especificadas no $filter. O utilizador tem de ter acesso direto às entidades subordinadas ou a um dos seus descendentes para que apareça nos resultados.
select

Este parâmetro especifica os campos a incluir 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 selecionar no $skipToken.
skip

Número de entidades a ignorar ao obter resultados. Ao transmiti-lo, irá substituir $skipToken.
skiptoken

O token de continuação da página só é utilizado se uma operação anterior devolver 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 utilizar para chamadas subsequentes.
top

Número de elementos a devolver ao obter resultados. Ao transmiti-lo, irá substituir $skipToken.
view

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

Propriedades Herdadas

abortSignal

O sinal que pode ser utilizado para abortar pedidos.
onResponse

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

Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.
serializerOptions

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

Opções utilizadas quando o rastreio está ativado.

Detalhes de Propriedade

cacheControl

Indica se o pedido deve utilizar caches. Preencha o cabeçalho com o valor "sem cache" para ignorar as caches existentes.

cacheControl?: string

Valor de Propriedade

string

filter

O parâmetro de filtro permite-lhe filtrar os campos de nome ou nome a apresentar. Pode verificar a igualdade no campo de nome (por exemplo, nome eq '{entityName}') e pode verificar a existência de subcadeias nos campos de nome ou nome a apresentar(por exemplo, contém(nome, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Tenha em atenção que os campos "{entityName}" e "{substringToSearch}" são verificados de forma não sensível às maiúsculas e minúsculas.

filter?: string

Valor de Propriedade

string

groupName

Um filtro que permite que a chamada obter entidades se concentre num grupo específico (ou seja, "$filter=name eq 'groupName'")

groupName?: string

Valor de Propriedade

string

O parâmetro $search é utilizado em conjunto com o parâmetro $filter para devolver três saídas diferentes, consoante o parâmetro transmitido. Com $search=AllowedParents, a API devolverá as informações de entidade de todos os grupos para os quais a entidade pedida poderá repará-lo conforme determinado pelas permissões do utilizador. Com $search=AllowedChildren, a API devolverá as informações de entidade de todas as entidades que podem ser adicionadas como subordinados da entidade pedida. Com $search=ParentAndFirstLevelChildren, a API devolverá o principal e o primeiro nível de crianças aos quais o utilizador tem acesso direto ou indireto através de um dos seus descendentes. Com $search=ParentOnly, a API devolverá apenas o grupo se o utilizador tiver acesso a, pelo menos, um dos descendentes do grupo. Com $search=ChildrenOnly, a API devolverá apenas o primeiro nível de subordinados das informações da entidade de grupo especificadas no $filter. O utilizador tem de ter acesso direto às entidades subordinadas ou a um dos seus descendentes para que apareça nos resultados.

search?: string

Valor de Propriedade

string

select

Este parâmetro especifica os campos a incluir 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 selecionar no $skipToken.

select?: string

Valor de Propriedade

string

skip

Número de entidades a ignorar ao obter resultados. Ao transmiti-lo, irá substituir $skipToken.

skip?: number

Valor de Propriedade

number

skiptoken

O token de continuação da página só é utilizado se uma operação anterior devolver 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 utilizar para chamadas subsequentes.

skiptoken?: string

Valor de Propriedade

string

top

Número de elementos a devolver ao obter resultados. Ao transmiti-lo, irá substituir $skipToken.

top?: number

Valor de Propriedade

number

view

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

view?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser utilizado para abortar pedidos.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

Herdado de coreClient.OperationOptions.abortSignal

onResponse

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

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

Herdado de coreClient.OperationOptions.onResponse

requestOptions

Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

Herdado de coreClient.OperationOptions.requestOptions

serializerOptions

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

serializerOptions?: SerializerOptions

Valor de Propriedade

SerializerOptions

Herdado de coreClient.OperationOptions.serializerOptions

tracingOptions

Opções utilizadas quando o rastreio está ativado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

Herdado de coreClient.OperationOptions.tracingOptions