Compartilhar via

EntitiesListOptionalParams interface

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

Parâmetros opcionais.

Extends
OperationOptions

Propriedades

cacheControl

Indica se a solicitação deve utilizar caches. Preencha o cabeçalho com o valor "sem cache" para ignorar os caches existentes.
filter

O parâmetro de filtro permite filtrar os campos nome ou nome de exibição. Você pode verificar a igualdade no campo nome (por exemplo, nome eq '{entityName}') e verificar se há subcadeias de caracteres nos campos nome ou nome de exibição(por exemplo, contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Observe que os campos '{entityName}' e '{substringToSearch}' não diferenciam maiúsculas de minúsculas.
groupName

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

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 de entidade de todos os grupos para os quais a entidade solicitada poderá separá-la novamente conforme determinado pelas permissões do usuário. Com $search=AllowedChildren, a API retornará as informações de 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á apenas 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 de entidade de grupo especificadas em $filter. O usuário deve ter acesso direto às entidades filho ou um dos descendentes para que ele apareça nos resultados.
select

Esse 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 select no $skipToken.
skip

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

O token de continuação de página só será usado se uma operação anterior retornar 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.
top

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

O parâmetro de exibição permite que os clientes filtrem o tipo de dados retornado pela chamada getEntities.

Propriedades herdadas

abortSignal

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

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

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

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

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

Detalhes da propriedade

cacheControl

Indica se a solicitação deve utilizar caches. Preencha o cabeçalho com o valor "sem cache" para ignorar os caches existentes.

cacheControl?: string

Valor da propriedade

string

filter

O parâmetro de filtro permite filtrar os campos nome ou nome de exibição. Você pode verificar a igualdade no campo nome (por exemplo, nome eq '{entityName}') e verificar se há subcadeias de caracteres nos campos nome ou nome de exibição(por exemplo, contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Observe que os campos '{entityName}' e '{substringToSearch}' não diferenciam maiúsculas de minúsculas.

filter?: string

Valor da propriedade

string

groupName

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

groupName?: string

Valor da propriedade

string

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 de entidade de todos os grupos para os quais a entidade solicitada poderá separá-la novamente conforme determinado pelas permissões do usuário. Com $search=AllowedChildren, a API retornará as informações de 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á apenas 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 de entidade de grupo especificadas em $filter. O usuário deve ter acesso direto às entidades filho ou um dos descendentes para que ele apareça nos resultados.

search?: string

Valor da propriedade

string

select

Esse 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 select no $skipToken.

select?: string

Valor da propriedade

string

skip

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

skip?: number

Valor da propriedade

number

skiptoken

O token de continuação de página só será usado se uma operação anterior retornar 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 da propriedade

string

top

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

top?: number

Valor da propriedade

number

view

O parâmetro de exibição permite que os clientes filtrem o tipo de dados retornado pela chamada getEntities.

view?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

abortSignal

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

abortSignal?: AbortSignalLike

Valor da 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 solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da propriedade

RawResponseCallback

Herdado de coreClient.OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Valor da propriedade

OperationRequestOptions

Herdado de coreClient.OperationOptions.requestOptions

serializerOptions

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

serializerOptions?: SerializerOptions

Valor da propriedade

SerializerOptions

Herdado de coreClient.OperationOptions.serializerOptions

tracingOptions

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

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado de coreClient.OperationOptions.tracingOptions