Grupos Microsoft.Graph

Importante

As APIs sob a /beta versão no Microsoft Graph estão sujeitas a alterações. A utilização destas APIs em aplicações de produção não é suportada. Para determinar se uma API está disponível na v1.0, use o seletor Versão .

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Use uma permissão ou permissões com privilégios mais altos somente se seu aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Nota

As permissões para contas pessoais da Microsoft não podem ser usadas para implantar recursos do Microsoft Graph declarados em arquivos Bicep.

Tipo de permissão	Permissões menos privilegiadas	Permissões com privilégios mais elevados
Delegada (conta profissional ou escolar)	Grupo.ReadWrite.All	Directory.ReadWrite.All
Delegada (conta Microsoft pessoal)	Não suportado.	Não suportado.
Aplicação	Grupo.ReadWrite.All	Directory.ReadWrite.All

Formato do recurso

Para criar um recurso Microsoft.Graph/groups, adicione o seguinte Bíceps ao seu modelo.

resource symbolicname 'Microsoft.Graph/groups@beta' = {
  classification: 'string'
  description: 'string'
  displayName: 'string'
  groupTypes: [
    'string'
  ]
  infoCatalogs: [
    'string'
  ]
  isAssignableToRole: bool
  mailEnabled: bool
  mailNickname: 'string'
  members: [
    'string'
  ]
  membershipRule: 'string'
  membershipRuleProcessingState: 'string'
  organizationId: 'string'
  owners: [
    'string'
  ]
  preferredDataLocation: 'string'
  preferredLanguage: 'string'
  resourceBehaviorOptions: [
    'string'
  ]
  resourceProvisioningOptions: [
    'string'
  ]
  securityEnabled: bool
  serviceProvisioningErrors: [
    {
      createdDateTime: 'string'
      isResolved: bool
      serviceInstance: 'string'
    }
  ]
  theme: 'string'
  uniqueName: 'string'
  visibility: 'string'
  writebackConfiguration: {
    isEnabled: bool
    onPremisesGroupType: 'string'
  }
}

Valores de propriedade

grupos

Nome	Descrição	valor
apiVersion	A versão da api de recursos	'beta' (Somente leitura)
classificação	Descreve uma classificação para o grupo (como baixo, médio ou alto impacto nos negócios)	string
createdByAppId	ID do aplicativo usado para criar o grupo. Pode ser nulo para alguns grupos. Só de leitura	string (Somente leitura)
createdDateTime	Carimbo de data/hora de quando o grupo foi criado. O valor não pode ser modificado e é preenchido automaticamente quando o grupo é criado. O tipo de carimbo de data/hora representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC de 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Só de Leitura.	string (Somente leitura)
excluídoDateTime	Data e hora em que este objeto foi excluído. Sempre nulo quando o objeto não tiver sido excluído.	string (Somente leitura)
descrição	Uma descrição opcional para o grupo	string
displayName	O nome para exibição do grupo. Obrigatório. O comprimento máximo é de 256 caracteres	string (Obrigatório)
expiraçãoDataHora	Carimbo de data/hora de quando o grupo está definido para expirar. É nulo para grupos de segurança, mas para grupos do Microsoft 365, representa quando o grupo está definido para expirar, conforme definido no groupLifecyclePolicy. O tipo de carimbo de data/hora representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC de 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Só de Leitura.	string (Somente leitura)
groupTypes	Especifica o tipo de grupo e sua associação. Se a coleção contiver Unified, o grupo será um grupo do Microsoft 365; caso contrário, é um grupo de segurança ou um grupo de distribuição. Para obter detalhes, consulte visão geral de grupos. Se a coleção incluir DynamicMembership, o grupo terá associação dinâmica; caso contrário, a associação será estática	string[]
id	O identificador exclusivo de uma entidade. Só de Leitura.	string (Somente leitura)
infoCatálogos	Identifica os segmentos de informação atribuídos ao grupo	string[]
isAssignableToRole	Indica se esse grupo pode ser atribuído a uma função do Microsoft Entra. Opcional. Esta propriedade só pode ser definida durante a criação do grupo e é imutável. Se definida como true, a propriedade securityEnabled também deve ser definida como true, a visibilidade deve ser Hidden e o grupo não pode ser um grupo dinâmico (ou seja, groupTypes não pode conter DynamicMembership). Somente chamadores com pelo menos a função de Administrador de Função Privilegiada podem definir essa propriedade. O chamador também deve receber a permissão RoleManagement.ReadWrite.Directory para definir essa propriedade ou atualizar a associação desses grupos. Para saber mais, consulte Usando um grupo para gerenciar atribuições de função do Microsoft EntraO uso desse recurso requer uma licença do Microsoft Entra ID P1	booleano
isManagementRestricted	Indica se o grupo é membro de uma unidade administrativa de gerenciamento restrito, caso em que requer uma função com escopo para a unidade administrativa restrita gerenciar. O valor predefinido é false. Só de Leitura. Para gerenciar um membro do grupo de uma unidade administrativa restrita, o aplicativo de chamada deve receber a permissão Directory.Write.Restricted . Para cenários delegados, os administradores também devem receber explicitamente funções suportadas no escopo restrito da unidade administrativa.	bool (Somente leitura)
correio	O endereço SMTP do grupo, por exemplo, 'serviceadmins@contoso.com'. Só de leitura	string (Somente leitura)
mailEnabled	Especifica se o grupo está habilitado para email. Necessário	bool (Obrigatório)
mailNickname	O alias de email para o grupo, exclusivo para grupos do Microsoft 365 na organização. O comprimento máximo é de 64 caracteres. Esta propriedade pode conter apenas caracteres no conjunto de caracteres ASCII 0 - 127, exceto o seguinte: @ () / [] ' ; : <> , ESPAÇO	string (Obrigatório)
membros	Membros diretos do grupo, que podem ser usuários, dispositivos, outros grupos ou entidades de serviço. Suporta as operações Listar membros, Adicionar membro e Remover membro. Pode ser nulo	string[]
membershipRule	A regra que determina os membros para este grupo se o grupo for um grupo dinâmico (groupTypes contém DynamicMembership). Para obter mais informações sobre a sintaxe da regra de associação, consulte Sintaxe das regras de associação	string
membershipRuleProcessingState	Indica se o processamento dinâmico de associação está ativado ou pausado. Os valores possíveis estão Ativado ou Pausado	string
onPremisesDomainName	Contém o FQDN do domínio local, também chamado dnsDomainName sincronizado a partir do diretório local. Só de Leitura.	string (Somente leitura)
onPremisesLastSyncDateTime	Indica a última vez em que o grupo foi sincronizado com o diretório local. O tipo de carimbo de data/hora representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC de 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Só de leitura	string (Somente leitura)
onPremisesNetBiosName	Contém o nome netBios local sincronizado a partir do diretório local. Só de Leitura.	string (Somente leitura)
onPremisesProvisioningErrors	Erros ao usar o produto de sincronização da Microsoft durante o provisionamento	MicrosoftGraphOnPremisesProvisioningError[] (Somente leitura)
onPremisesSamAccountName	Contém o nome da conta SAM local sincronizada a partir do diretório local. Só de Leitura.	string (Somente leitura)
onPremisesSecurityIdentifier	Contém o identificador de segurança local (SID) para o grupo sincronizado do local para a nuvem. Só de leitura	string (Somente leitura)
onPremisesSyncEnabled	true se esse grupo for sincronizado a partir de um diretório local; false se esse grupo foi originalmente sincronizado de um diretório local, mas não está mais sincronizado; null se este objeto nunca tiver sido sincronizado a partir de um diretório local (padrão). Só de leitura	bool (Somente leitura)
organizationId		string
proprietários	Os proprietários do grupo que podem ser usuários ou entidades de serviço. Nulo. Se essa propriedade não for especificada ao criar um grupo do Microsoft 365, o usuário chamador será atribuído automaticamente como o proprietário do grupo	string[]
preferredDataLocation	O local de dados preferencial para o grupo Microsoft 365. Por padrão, o grupo herda o local de dados preferido do criador do grupo. Para definir essa propriedade, o aplicativo de chamada deve receber a permissão Directory.ReadWrite.All e o usuário receber pelo menos uma das seguintes funções do Microsoft Entra: Administrador de Conta de Usuário Gravador de Diretórios Administrador do Exchange Administrador do SharePoint Para obter mais informações sobre essa propriedade, consulte OneDrive Online Multi-Geo e Criar um grupo do Microsoft 365 com uma PDL específica. Pode ser nulo	string
preferredLanguage	O idioma preferido para um grupo do Microsoft 365. Deve seguir o código ISO 639-1; por exemplo, en-US	string
proxyAddresses	Endereços de email do grupo que direcionam para a mesma caixa de correio do grupo. Por exemplo: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. O operador any é necessário para expressões de filtro em propriedades de vários valores. Só de Leitura. Não anulável	string[] (Somente leitura)
renovadoDateTime	Carimbo de data/hora de quando o grupo foi renovado pela última vez. Isso não pode ser modificado diretamente e só é atualizado por meio da ação de renovação do serviço. O tipo de carimbo de data/hora representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC de 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Só de Leitura.	string (Somente leitura)
resourceBehaviorOptions	Especifica os comportamentos de grupo que podem ser definidos para um grupo do Microsoft 365 durante a criação. Esta propriedade pode ser definida apenas como parte da criação (POST). Para obter a lista de valores possíveis, consulte Comportamentos de grupo e opções de provisionamento do Microsoft 365.	string[]
resourceProvisioningOptions	Especifica os recursos de grupo associados ao grupo do Microsoft 365. O valor possível é Equipa. Para obter mais informações, consulte Comportamentos de grupo e opções de provisionamento do Microsoft 365	string[]
securityAtivado	Especifica se o grupo é um grupo de segurança	bool (Obrigatório)
securityIdentifier	Identificador de segurança do grupo, usado em cenários do Windows. Só de leitura	string (Somente leitura)
serviceProvisioningErrors	Erros publicados por um serviço federado descrevendo um erro não transitório específico do serviço em relação às propriedades ou link de um objeto de grupo.	MicrosoftGraphServiceProvisioningError[]
tema	Especifica o tema de cores de um grupo do Microsoft 365. Os valores possíveis são Teal, Purple, Green, Blue, Pink, Orange ou Red	string
tipo	O tipo de recurso	'Microsoft.Graph/groups' (Somente leitura)
uniqueName	O identificador exclusivo que pode ser atribuído a um grupo e usado como uma chave alternativa. Imutável	string (Obrigatório)
Visibilidade	Especifica a política de ingresso no grupo e a visibilidade do conteúdo do grupo para grupos. Os valores possíveis são: Private, Public ou HiddenMembership. HiddenMembership pode ser definido apenas para grupos do Microsoft 365 quando os grupos são criados. Não pode ser atualizado mais tarde. Outros valores de visibilidade podem ser atualizados após a criação do grupo. Se o valor de visibilidade não for especificado durante a criação do grupo no Microsoft Graph, um grupo de segurança será criado como Privado por padrão e o grupo do Microsoft 365 será Público. Os grupos atribuíveis a funções são sempre Privados. Para saber mais, consulte Opções de visibilidade do grupo. Nulo.	string
writebackConfiguração	Especifica se um grupo está ou não configurado para regravar as propriedades do objeto de grupo no Ative Directory local. Essas propriedades são usadas quando o write-back de grupo é configurado no cliente de sincronização do Microsoft Entra Connect.	MicrosoftGraphGroupWritebackConfiguration

MicrosoftGraphOnPremisesProvisioningError

Nome	Descrição	valor
category	Categoria do erro de provisionamento. Nota: Atualmente, existe apenas um valor possível. Valor possível: PropertyConflict - indica que um valor de propriedade não é exclusivo. Outros objetos contêm o mesmo valor para a propriedade.	string
ocorreuDateTime	A data e a hora em que o erro ocorreu.	string
propertyCausingError	Nome da propriedade de diretório que está causando o erro. Valores possíveis atuais: UserPrincipalName ou ProxyAddress	string
valor	Valor da propriedade que está causando o erro.	string

MicrosoftGraphServiceProvisioningError

Nome	Descrição	valor
createdDateTime	A data e a hora em que o erro ocorreu.	string
isResolvido	Indica se o erro foi atendido.	booleano
serviceInstance	Instância de serviço qualificada (por exemplo, 'SharePoint/Dublin') que publicou as informações de erro do serviço.	string

MicrosoftGraphGroupWritebackConfiguration

Nome	Descrição	valor
isEnabled	Indica se o write-back de grupos de nuvem para o Ative Directory local está habilitado. O valor padrão é true para grupos do Microsoft 365 e false para grupos de segurança.	booleano
onPremisesGroupType	Indica o tipo de grupo local de destino como o objeto de nuvem é gravado novamente. Nulo. Os valores possíveis são: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.Se o grupo de nuvem for um grupo unificado (Microsoft 365), essa propriedade pode ser uma das seguintes: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. Os grupos de segurança do Microsoft Entra podem ser gravados novamente como universalSecurityGroup. Se isEnabled ou a configuração de grupo NewUnifiedGroupWritebackDefault for true, mas essa propriedade não estiver explicitamente configurada: Os grupos do Microsoft 365 são gravados novamente como universalDistributionGroup por padrãoOs grupos de segurança são gravados novamente como universalSecurityGroup por padrão	string