administrativeUnit tipo de recurso
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Uma unidade administrativa fornece um contentor conceptual para objetos de diretório de utilizador, grupo e dispositivo. Com as unidades administrativas, um administrador da empresa pode agora delegar responsabilidades administrativas para gerir os utilizadores, grupos e dispositivos contidos dentro ou no âmbito de uma unidade administrativa a um administrador regional ou departamal. Para obter mais informações sobre unidades administrativas, consulte Unidades administrativas no Microsoft Entra ID.
Esse recurso é um tipo aberto que permite que outras propriedades sejam passadas.
Esse recurso permite:
- Adicionar seus próprios dados às propriedades personalizadas como extensions.
- Usar a consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.
-
Capacidades de consulta OData , incluindo
$select,$filter,$searche$top. As utilizações específicas são suportadas apenas com capacidades de consulta Avançadas.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Criar | administrativeUnit | Crie uma nova unidade administrativa. |
| List | administrativeUnit collection | Listar propriedades de todos os administrativeUnits. |
| Get | administrativeUnit | Ler propriedades e relações de um objeto administrativeUnit específico. |
| Atualizar | administrativeUnit | Atualizar o objeto administrativeUnit. |
| Delete | Nenhum | Eliminar objeto administrativeUnit. |
| Obter delta | administrativeUnit | Obtenha administrativeUnits recentemente criados, atualizados ou eliminados sem ter de efetuar uma leitura completa de toda a coleção de recursos. |
| Associações | ||
| Adicionar membro | directoryObject | Adicionar um membro (utilizador ou grupo). |
| Listar membros | Coleção directoryObject | Obtenha a lista de membros (utilizador e grupo). |
| Obter membro | directoryObject | Obter um membro específico. |
| Remover membro | directoryObject | Remover um membro. |
| Atribuições de função | ||
| Atribuir função com âmbito | scopedRoleMembership | Atribua uma função de Microsoft Entra com âmbito de unidade administrativa. |
| Listar atribuições de funções com âmbito | Coleção scopedRoleMembership | Listar Microsoft Entra atribuições de funções com âmbito de unidade administrativa. |
| Obter atribuição de função com âmbito | scopedRoleMembership | Obtenha uma atribuição de função Microsoft Entra com o âmbito da unidade administrativa. |
| Remover atribuição de função com âmbito | scopedRoleMembership | Remova uma atribuição de função Microsoft Entra com o âmbito da unidade administrativa. |
| Itens excluídos | ||
| List | Coleção directoryObject | Obtenha uma lista de unidades administrativas eliminadas recentemente de uma coleção de objetos de diretório. |
| Get | directoryObject | Obtenha as propriedades de um objeto de unidade administrativa recentemente eliminado. |
| Restaurar | directoryObject | Restaure um objeto de unidade administrativa recentemente eliminado. |
Observação
O ponto final do URL para chamar a API administrativeUnits está /administrativeUnits no beta ponto final, mas /directory/administrativeUnits no v1.0 ponto final.
Propriedades
Importante
O uso específico de $filter e o parâmetro de consulta $search é suportado somente quando se usa o cabeçalho ConsistencyLevel definido como eventual e $count. Para obter mais informações, veja Capacidades avançadas de consulta em objetos de diretório.
| Propriedade. | Tipo | Descrição |
|---|---|---|
| description | Cadeia de caracteres | Uma descrição opcional para a unidade administrativa.
$filter Suporta (eq, ne, in, startsWith), $search. |
| displayName | Cadeia de caracteres | Nome a apresentar para a unidade administrativa. O comprimento máximo é de 256 caracteres. Suporte $filter (eq, ne, not, ge, le, in, startsWith, e eq no null valores), $search, e $orderby. |
| id | Cadeia de caracteres | Identificador exclusivo da unidade administrativa. Somente leitura. Suporta $filter (eq). |
| isMemberManagementRestricted | Booliano |
true se os membros desta unidade administrativa devem ser tratados como confidenciais, o que requer permissões específicas para gerir. O valor padrão é false. Utilize esta propriedade para definir unidades administrativas cujas funções não herdam de administradores ao nível do inquilino e a gestão de objetos membros individuais está limitada a administradores no âmbito de uma unidade administrativa de gestão restrita. Imutável, pelo que não pode ser alterado mais tarde. Para obter mais informações sobre como trabalhar com unidades administrativas de gestão restrita, veja Unidades administrativas de gestão restrita no Microsoft Entra ID. |
| membershipRule | String | A regra de associação dinâmica para a unidade administrativa. Para obter mais informações sobre as regras que pode utilizar para unidades administrativas dinâmicas e grupos dinâmicos, veja Gerir regras para grupos de associação dinâmicos no Microsoft Entra ID. |
| membershipRuleProcessingState | String | Controla se a regra de associação dinâmica é processada ativamente. Defina como On para ativar a regra de associação dinâmica ou Paused para parar de atualizar a associação dinamicamente. |
| membershipType | Cadeia de caracteres | Indica o tipo de associação para a unidade administrativa. Os valores possíveis são: dynamic, assigned. Se não estiver definido, o valor predefinido é null e o comportamento predefinido é atribuído. |
| visibility | Cadeia de caracteres | Controla se a unidade administrativa e os respetivos membros estão ocultos ou públicos. Pode ser definido como HiddenMembership ou Public. Se não estiver definido, o valor predefinido é null e o comportamento predefinido é público. Quando definido como HiddenMembership, apenas os membros da unidade administrativa podem listar outros membros da unidade administrativa. |
Dica
As extensões de diretório e os dados associados são devolvidos por predefinição, enquanto as extensões de esquema e os dados associados são devolvidos apenas em $select.
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| extensions | Coleção extension | A coleção de extensões abertas definidas para esta unidade administrativa. Anulável. |
| members | Coleção directoryObject | Utilizadores e grupos que são membros desta unidade administrativa. Oferece suporte para $expand. |
| scopedRoleMembers | Coleção scopedRoleMembership | Membros de função de âmbito desta unidade administrativa. |
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
{
"description": "String",
"displayName": "String",
"id": "String (identifier)",
"isMemberManagementRestricted": "Boolean",
"membershipRule": "String",
"membershipRuleProcessingState": "String",
"membershipType": "String",
"visibility": "String"
}