EntitiesOperationsExtensions.List Método

Definição

Namespace:

Microsoft.Azure.Management.ManagementGroups

Assembly:

Microsoft.Azure.Management.ManagementGroups.dll

Pacote:

Microsoft.Azure.Management.ManagementGroups v2.0.0-beta

Listar todas as entidades (Grupos de Gerenciamento, Assinaturas e etc.) para o usuário autenticado.

public static Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo> List (this Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations operations, string skiptoken = default, int? skip = default, int? top = default, string select = default, string search = default, string filter = default, string view = default, string groupName = default, string cacheControl = "no-cache");

static member List : Microsoft.Azure.Management.ManagementGroups.IEntitiesOperations * string * Nullable<int> * Nullable<int> * string * string * string * string * string * string -> Microsoft.Rest.Azure.IPage<Microsoft.Azure.Management.ManagementGroups.Models.EntityInfo>

<Extension()>
Public Function List (operations As IEntitiesOperations, Optional skiptoken As String = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional select As String = Nothing, Optional search As String = Nothing, Optional filter As String = Nothing, Optional view As String = Nothing, Optional groupName As String = Nothing, Optional cacheControl As String = "no-cache") As IPage(Of EntityInfo)

Parâmetros

operations

IEntitiesOperations

O grupo de operações para esse método de extensão.

skiptoken

String

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.

skip

Nullable<Int32>

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

top

Nullable<Int32>

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

select

String

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 em $skipToken.

search

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 que a entidade solicitada poderá reparenciar 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. Os valores possíveis incluem: 'AllowedParents', 'AllowedChildren', 'ParentAndFirstLevelChildren', 'ParentOnly', 'ChildrenOnly'

filter

String

O parâmetro de filtro permite filtrar os campos nome ou nome de exibição. Você pode marcar para igualdade no campo nome (por exemplo, nome eq '{entityName}') e pode marcar para 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}' são verificados sem diferenciação de maiúsculas e minúsculas.

view

String

O parâmetro de exibição permite que os clientes filtrem o tipo de dados retornado pela chamada getEntities. Os valores possíveis incluem: 'FullHierarchy', 'GroupsOnly', 'SubscriptionsOnly', 'Audit'

groupName

String

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

cacheControl

String

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

Retornos

IPage<EntityInfo>