Grupos 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.

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o 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.

Observação

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 com privilégios mínimos	Permissões com privilégios mais altos
Delegado (conta corporativa ou de estudante)	Group.ReadWrite.All	Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Não há suporte.	Não há suporte.
Aplicativo	Group.ReadWrite.All	Directory.ReadWrite.All

Formato de recurso

Para criar um recurso Microsoft.Graph/groups, adicione o seguinte Bicep 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

groups

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. Somente leitura	cadeia de caracteres (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 Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1º de janeiro de 2014 é 2014-01-01T00:00:00Z. Somente leitura.	cadeia de caracteres (somente leitura)
deletedDateTime	Data e hora em que esse objeto foi excluído. Sempre nulo quando o objeto não tiver sido excluído.	cadeia de caracteres (somente leitura)
descrição	Uma descrição opcional para o grupo	string
displayName	O nome de exibição do grupo. Obrigatória. O comprimento máximo é de 256 caracteres	string (Obrigatório)
expirationDateTime	Carimbo de data/hora de quando o grupo está definido para expirar. Ele é nulo para grupos de segurança, mas para grupos do Microsoft 365, ele representa quando o grupo está definido para expirar, conforme definido no groupLifecyclePolicy. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1º de janeiro de 2014 é 2014-01-01T00:00:00Z. Somente leitura.	cadeia de caracteres (somente leitura)
tipos_de_grupo	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 dos grupos. Se a coleção incluir DynamicMembership, o grupo terá associação dinâmica; caso contrário, a associação é estática	string[]
ID	O identificador exclusivo de uma entidade. Somente leitura.	cadeia de caracteres (somente leitura)
infoCatálogos	Identifica os segmentos de informações atribuídos ao grupo	string[]
isAssignableToRole	Indica se esse grupo pode ser atribuído a uma função do Microsoft Entra. Opcional. Essa propriedade só pode ser definida durante a criação do grupo e é imutável. Se definido como true, a propriedade securityEnabled também deverá ser definida como true, a visibilidade deverá ser Hidden e o grupo não poderá 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 com Privilégios 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 obter mais informações, consulte Usando um grupo para gerenciar atribuições de função do Microsoft EntraO uso desse recurso requer uma licença P1 da ID do Microsoft Entra	bool
éGerenciamentoRestrito	Indica se o grupo é membro de uma unidade administrativa de gerenciamento restrito e, nesse caso, requer uma função com escopo para gerenciar a unidade administrativa restrita. O valor padrão é falso. Somente 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 com suporte no escopo da unidade administrativa restrita.	bool (somente leitura)
mail	O endereço SMTP do grupo, por exemplo, 'serviceadmins@contoso.com'. Somente leitura	cadeia de caracteres (somente leitura)
mailEnabled	Especifica se o grupo está habilitado para email. Obrigatório	bool (Obrigatório)
mailNickname	O alias de email do grupo, exclusivo para grupos do Microsoft 365 na organização. O comprimento máximo é de 64 caracteres. Essa propriedade pode conter apenas caracteres no conjunto de caracteres ASCII de 0 a 127, exceto os seguintes: @ () / [] ' ; : <> , ESPAÇO	string (Obrigatório)
membros	Membros diretos do grupo, que podem ser usuários, dispositivos, outros grupos ou entidades de serviço. Dá suporte às operações Listar membros, Adicionar membro e Remover membro. Permite valor nulo	string[]
membershipRule	A regra que determina os membros desse 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 de regras de associação	string
membershipRuleProcessingState	Indica se o processamento dinâmico de associação está ativado ou pausado. Os valores possíveis são Ativado ou Pausado	string
nome_do_domínio_local	Contém o FQDN do domínio local, também chamado de dnsDomainName sincronizado do diretório local. Somente leitura.	cadeia de caracteres (somente leitura)
onPremisesLastSyncDateTime	Indica a última vez em que o grupo foi sincronizado com o diretório local. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1º de janeiro de 2014 é 2014-01-01T00:00:00Z. Somente leitura	cadeia de caracteres (somente leitura)
onPremisesNetBiosName	Contém o nome netBios local sincronizado do diretório local. Somente leitura.	cadeia de caracteres (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 do SAM local sincronizado do diretório local. Somente leitura.	cadeia de caracteres (somente leitura)
onPremisesSecurityIdentifier	Contém o SID (identificador de segurança) local para o grupo sincronizado do local para a nuvem. Somente leitura	cadeia de caracteres (somente leitura)
onPremisesSyncEnabled	true se esse grupo for sincronizado 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 esse objeto nunca tiver sido sincronizado de um diretório local (padrão). Somente leitura	bool (somente leitura)
organizationId		string
owners	Os proprietários do grupo que podem ser usuários ou entidades de serviço. Anulável. Se essa propriedade não for especificada ao criar um grupo do Microsoft 365, o usuário que está chamando será atribuído automaticamente como o proprietário do grupo	string[]
preferredDataLocation	O local de dados preferencial para o grupo do Microsoft 365. Por padrão, o grupo herda o local de dados preferencial 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ório 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 um PDL específico. Permite valor nulo	string
preferredLanguage	O idioma preferencial 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 de 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. Somente leitura. Não permite valor nulo	string[] (Somente leitura)
renovado	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 Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1º de janeiro de 2014 é 2014-01-01T00:00:00Z. Somente leitura.	cadeia de caracteres (somente leitura)
resourceBehaviorOptions	Especifica os comportamentos de grupo que podem ser definidos para um grupo do Microsoft 365 durante a criação. Essa propriedade pode ser definida somente como parte da criação (POST). Para obter a lista de valores possíveis, consulte Comportamentos de grupo do Microsoft 365 e opções de provisionamento.	string[]
resourceProvisioningOptions	Especifica os recursos de grupo associados ao grupo do Microsoft 365. O valor possível é Equipe. Para obter mais informações, consulte Comportamentos de grupo e opções de provisionamento do Microsoft 365	string[]
securityEnabled	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. Somente leitura	cadeia de caracteres (somente leitura)
serviceProvisioningErrors	Erros publicados por um serviço federado que descrevem um erro não transitório específico do serviço em relação às propriedades ou link de um objeto de grupo.	MicrosoftGraphServiceProvisioningError[]
theme	Especifica o tema de cores de um grupo do Microsoft 365. Os valores possíveis são Azul-petróleo, Roxo, Verde, Azul, Rosa, Laranja ou Vermelho	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)
visibility	Especifica a política de ingresso em 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. Ele não pode ser atualizado posteriormente. 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. Anulável.	string
write-backConfiguração	Especifica se um grupo está ou não configurado para gravar propriedades de objeto de grupo no Active 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. Observação: atualmente, há 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
ocorreu Data/hora	A data e a hora em que o erro ocorreu.	string
propertyCausingError	Nome da propriedade do diretório que está causando o erro. Valores possíveis atuais: UserPrincipalName ou ProxyAddress	string
value	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
é resolvido	Indica se o erro foi atendido.	bool
serviceInstance	Instância de serviço qualificada (por exemplo, 'SharePoint/Dublin') que publicou as informações de erro de serviço.	string

MicrosoftGraphGroupWritebackConfiguration

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