Groupes Microsoft.Graph
Important
Les API sous la version /beta
dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
autorisations
Choisissez l’autorisation ou les autorisations marquées comme les moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées supérieures uniquement si votre application l’exige. Pour plus d’informations sur les autorisations déléguées et les autorisations d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.
Remarque
Les autorisations pour les comptes Microsoft personnels ne peuvent pas être utilisées pour déployer des ressources Microsoft Graph déclarées dans des fichiers Bicep.
Déploiement de ressources
Choisissez l’autorisation la moins privilégiée dans le tableau suivant pour créer ou mettre à jour une ressource Microsoft.Graph/groups.
Type d'autorisation | Autorisations avec privilèges minimum | Autorisations privilégiées supérieures |
---|---|---|
Déléguée (compte professionnel ou scolaire) | Group.ReadWrite.All | Directory.ReadWrite.All |
Déléguée (compte Microsoft personnel) | Non pris en charge. | Non pris en charge. |
Application | Group.ReadWrite.All | Directory.ReadWrite.All |
Lire uniquement les ressources existantes
Choisissez l’autorisation la moins privilégiée dans le tableau suivant pour lire une ressource Microsoft.Graph/groups à l’aide du mot clé existing
.
Type d'autorisation | Autorisations avec privilèges minimum | Autorisations privilégiées supérieures |
---|---|---|
Déléguée (compte professionnel ou scolaire) | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Déléguée (compte Microsoft personnel) | Non pris en charge. | Non pris en charge. |
Application | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Format des ressources
Pour créer une ressource Microsoft.Graph/groups, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Graph/groups@beta' = {
classification: 'string'
cloudLicensing: any
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
theme: 'string'
uniqueName: 'string'
visibility: 'string'
writebackConfiguration: {
isEnabled: bool
onPremisesGroupType: 'string'
}
}
Valeurs de propriétés
groups
Nom | Description | active |
---|---|---|
apiVersion | Version de l’API de ressource | 'beta' (ReadOnly) |
classification ; | Décrit une classification pour le groupe (par exemple, un impact faible, moyen ou élevé sur l’entreprise) | string |
cloudLicensing | Relations d’un groupe à des ressources de licence cloud. | quelconque |
createdByAppId | ID d’application de l’application utilisée pour créer le groupe. Peut être null pour certains groupes. Lecture seule | string (ReadOnly) |
createdDateTime | Horodatage de la création du groupe. La valeur ne peut pas être modifiée et est automatiquement remplie lors de la création du groupe. Le type Timestamp représente les informations de date et d’heure au format ISO 8601 et est toujours au format UTC. Par exemple, minuit UTC le 1er janvier 2014 est 2014-01-01T00:00:00Z. Lecture seule. | string (ReadOnly) |
deletedDateTime | Date et heure de suppression de cet objet. Toujours null lorsque l’objet n’a pas été supprimé. | string (ReadOnly) |
description | Description facultative du groupe | string |
displayName | Nom complet du groupe. Obligatoire. La longueur maximale est de 256 caractères | chaîne (obligatoire) |
expirationDateTime | Horodatage de l’expiration du groupe. Il s’agit de la valeur Null pour les groupes de sécurité, mais pour les groupes Microsoft 365, elle représente le moment où le groupe est défini comme défini dans groupLifecyclePolicy. Le type Timestamp représente les informations de date et d’heure au format ISO 8601 et est toujours au format UTC. Par exemple, minuit UTC le 1er janvier 2014 est 2014-01-01T00:00:00Z. Lecture seule. | string (ReadOnly) |
groupTypes | Spécifie le type de groupe et son appartenance. Si la collection contient Unified, le groupe est un groupe Microsoft 365 ; sinon, il s’agit d’un groupe de sécurité ou d’un groupe de distribution. Pour plus d’informations, consultez la vue d’ensemble des groupes. Si la collection inclut DynamicMembership, le groupe a une appartenance dynamique ; sinon, l’appartenance est statique | string[] |
id | Identificateur unique d’une entité. Lecture seule. | string (ReadOnly) |
infoCatalogs | Identifie les segments d’informations affectés au groupe | string[] |
isAssignableToRole | Indique si ce groupe peut être affecté à un rôle Microsoft Entra. facultatif. Cette propriété ne peut être définie que lors de la création du groupe et est immuable. Si la valeur est true, la propriété securityEnabled doit également être définie sur true, la visibilité doit être Masquée et le groupe ne peut pas être un groupe dynamique (autrement dit, groupTypes ne peut pas contenir DynamicMembership). Seuls les appelants disposant au moins du rôle Administrateur de rôle privilégié peuvent définir cette propriété. L’appelant doit également être affecté à l’autorisation RoleManagement.ReadWrite.Directory pour définir cette propriété ou mettre à jour l’appartenance de ces groupes. Pour plus d’informations, consultez Utilisation d’un groupe pour gérer les attributions de rôles Microsoft EntraUsing cette fonctionnalité nécessite une licence Microsoft Entra ID P1 | bool |
isManagementRestricted | Indique si le groupe est membre d’une unité administrative de gestion restreinte. La valeur par défaut est false (Faux). Lecture seule. Pour gérer un membre de groupe d’une unité administrative de gestion restreinte, l’administrateur ou l’application appelante doit être affecté à un rôle Microsoft Entra dans l’étendue de l’unité administrative de gestion restreinte. | bool (ReadOnly) |
Adresse SMTP du groupe, par exemple «serviceadmins@contoso.com ». Lecture seule | string (ReadOnly) | |
mailEnabled | Spécifie si le groupe est activé pour la messagerie. Requis | bool (Obligatoire) |
mailNickname | Alias de messagerie pour le groupe, unique pour les groupes Microsoft 365 dans l’organisation. La longueur maximale est de 64 caractères. Cette propriété ne peut contenir que des caractères dans le jeu de caractères ASCII 0 - 127, à l’exception des éléments suivants : @ () / [] ' ; : <> , ESPACE | chaîne (obligatoire) |
membres | Les membres de groupe directs, qui peuvent être des utilisateurs, des appareils, d’autres groupes ou des principaux de service. Prend en charge les membres de liste, ajouter un membre et supprimer des opérations de membre. Nullable | string[] |
membershipRule | Règle qui détermine les membres de ce groupe si le groupe est un groupe dynamique (groupTypes contient DynamicMembership). Pour plus d’informations sur la syntaxe de la règle d’appartenance, consultez la syntaxe règles d’appartenance | string |
membershipRuleProcessingState | Indique si le traitement d’appartenance dynamique est activé ou suspendu. Les valeurs possibles sont activées ou suspendues | string |
onPremisesDomainName | Contient le nom de domaine complet du domaine local, également appelé dnsDomainName synchronisé à partir du répertoire local. Lecture seule. | string (ReadOnly) |
onPremisesLastSyncDateTime | Indique la dernière fois où le groupe a été synchronisé avec le répertoire local. Le type Timestamp représente les informations de date et d’heure au format ISO 8601 et est toujours au format UTC. Par exemple, minuit UTC le 1er janvier 2014 est 2014-01-01T00:00:00Z. Lecture seule | string (ReadOnly) |
onPremisesNetBiosName | Contient le nom netBios local synchronisé à partir du répertoire local. Lecture seule. | string (ReadOnly) |
onPremisesProvisioningErrors | Erreurs lors de l’utilisation du produit de synchronisation Microsoft lors de l’approvisionnement | MicrosoftGraphOnPremisesProvisioningError[] (ReadOnly) |
onPremisesSamAccountName | Contient le nom du compte SAM local synchronisé à partir du répertoire local. Lecture seule. | string (ReadOnly) |
onPremisesSecurityIdentifier | Contient l’identificateur de sécurité local (SID) pour le groupe synchronisé d’un emplacement local vers le cloud. Lecture seule | string (ReadOnly) |
onPremisesSyncEnabled | true si ce groupe est synchronisé à partir d’un répertoire local ; false si ce groupe a été initialement synchronisé à partir d’un répertoire local, mais n’est plus synchronisé ; Null si cet objet n’a jamais été synchronisé à partir d’un répertoire local (valeur par défaut). Lecture seule | bool (ReadOnly) |
organizationId | string | |
owners | Propriétaires du groupe qui peuvent être des utilisateurs ou des principaux de service. Limité à 100 propriétaires. Autorise la valeur Null. Si cette propriété n’est pas spécifiée lors de la création d’un groupe Microsoft 365, l’utilisateur appelant (administrateur ou non administrateur) est automatiquement affecté en tant que propriétaire du groupe. Un utilisateur non administrateur ne peut pas s’ajouter explicitement à cette collection lorsqu’il crée le groupe. Pour plus d’informations, consultez le problème connu associé. Pour les groupes de sécurité, l’utilisateur administrateur n’est pas automatiquement ajouté à cette collection. Pour plus d’informations, consultez le problème connu associé | string[] |
preferredDataLocation | Emplacement de données préféré pour le groupe Microsoft 365. Par défaut, le groupe hérite de l’emplacement de données préféré du créateur de groupe. Pour définir cette propriété, l’application appelante doit disposer de l’autorisation Directory.ReadWrite.All et l’utilisateur doit disposer d’au moins l’un des rôles Microsoft Entra suivants : Administrateur SharePoint Administrateur d’annuaire administrateur de compte d’utilisateur Administrateur Exchange Pour plus d’informations sur cette propriété, consultez OneDrive Online Multi-Geo et Créer un groupe Microsoft 365 avec un fichier PDL spécifique. Nullable | string |
preferredLanguage | Langue préférée pour un groupe Microsoft 365. Doit suivre le code ISO 639-1 ; par exemple, en-US | string |
proxyAddresses | Adresses e-mail pour le groupe qui dirige vers la même boîte aux lettres de groupe. Par exemple : ['SMTP : bob@contoso.com', 'smtp : bob@sales.contoso.com']. L’opérateur n’importe quel opérateur est requis pour les expressions de filtre sur les propriétés à valeurs multiples. Lecture seule. N'accepte pas la valeur null | string[] (ReadOnly) |
renewedDateTime | Horodatage du moment où le groupe a été renouvelé pour la dernière fois. Cela ne peut pas être modifié directement et n’est mis à jour que via l’action de renouvellement du service. Le type Timestamp représente les informations de date et d’heure au format ISO 8601 et est toujours au format UTC. Par exemple, minuit UTC le 1er janvier 2014 est 2014-01-01T00:00:00Z. Lecture seule. | string (ReadOnly) |
resourceBehaviorOptions | Spécifie les comportements de groupe qui peuvent être définis pour un groupe Microsoft 365 lors de la création. Cette propriété ne peut être définie que dans le cadre de la création (POST). Pour obtenir la liste des valeurs possibles, consultez les comportements de groupe Microsoft 365 et les options d’approvisionnement. | string[] |
resourceProvisioningOptions | Spécifie les ressources de groupe associées au groupe Microsoft 365. La valeur possible est Team. Pour plus d’informations, consultez les options de comportement et d’approvisionnement des groupes Microsoft 365 | string[] |
securityEnabled | Spécifie si le groupe est un groupe de sécurité | bool (Obligatoire) |
securityIdentifier | Identificateur de sécurité du groupe, utilisé dans les scénarios Windows. Lecture seule | string (ReadOnly) |
serviceProvisioningErrors | Erreurs publiées par un service fédéré décrivant une erreur non temporaire spécifique au service concernant les propriétés ou le lien à partir d’un objet de groupe. | MicrosoftGraphServiceProvisioningError[] (ReadOnly) |
theme | Spécifie le thème de couleur d’un groupe Microsoft 365. Les valeurs possibles sont Teal, Violet, Vert, Bleu, Rose, Orange ou Rouge | string |
type | Type de ressource | 'Microsoft.Graph/groups' (ReadOnly) |
uniqueName | Identificateur unique qui peut être affecté à un groupe et utilisé comme autre clé. Non modifiable | chaîne (obligatoire) |
visibility | Spécifie la stratégie de jointure de groupe et la visibilité du contenu de groupe pour les groupes. Les valeurs possibles sont les suivantes : Private, Public ou HiddenMembership. HiddenMembership ne peut être défini que pour les groupes Microsoft 365 lorsque les groupes sont créés. Elle ne peut pas être mise à jour ultérieurement. D’autres valeurs de visibilité peuvent être mises à jour après la création du groupe. Si la valeur de visibilité n’est pas spécifiée lors de la création du groupe sur Microsoft Graph, un groupe de sécurité est créé en tant que privé par défaut et le groupe Microsoft 365 est public. Les groupes assignables aux rôles sont toujours privés. Pour en savoir plus, consultez les options de visibilité de groupe. Autorise la valeur Null. | string |
writebackConfiguration | Spécifie si un groupe est configuré pour réécrire les propriétés d’objet de groupe dans Active Directory local. Ces propriétés sont utilisées lorsque l’écriture différée de groupe est configurée dans le client de synchronisation Microsoft Entra Connect. | MicrosoftGraphGroupWritebackConfiguration |
MicrosoftGraphOnPremisesProvisioningError
Nom | Description | active |
---|---|---|
category | Catégorie de l’erreur d’approvisionnement. Remarque : Actuellement, il n’existe qu’une seule valeur possible. Valeur possible : PropertyConflict : indique qu’une valeur de propriété n’est pas unique. Les autres objets contiennent la même valeur pour la propriété. | string |
occurredDateTime | Date et heure à laquelle l’erreur s’est produite. | string |
propertyCausingError | Nom de la propriété de répertoire à l’origine de l’erreur. Valeurs possibles actuelles : UserPrincipalName ou ProxyAddress | string |
valeur | Valeur de la propriété à l’origine de l’erreur. | string |
MicrosoftGraphServiceProvisioningError
Nom | Description | active |
---|---|---|
createdDateTime | Date et heure à laquelle l’erreur s’est produite. | string |
isResolved | Indique si l’erreur a été suivie. | bool |
serviceInstance | Instance de service qualifiée (par exemple, « SharePoint/Dublin ») qui a publié les informations d’erreur du service. | string |
MicrosoftGraphGroupWritebackConfiguration
Nom | Description | active |
---|---|---|
isEnabled | Indique si l’écriture différée de groupes cloud sur Active Directory local est activée. La valeur par défaut est true pour les groupes Microsoft 365 et false pour les groupes de sécurité. | bool |
onPremisesGroupType | Indique que le type de groupe local cible que l’objet cloud est réécrit comme suit. Autorise la valeur Null. Les valeurs possibles sont : universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.Si le groupe cloud est un groupe unifié (Microsoft 365), cette propriété peut être l’une des suivantes : universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. Les groupes de sécurité Microsoft Entra peuvent être réécrits en tant que universalSecurityGroup. Si isEnabled ou le paramètre de groupe NewUnifiedGroupWritebackDefault a la valeur true, mais cette propriété n’est pas configurée explicitement : les groupes Microsoft 365 sont réécrits en tant que groupes universalDistributionGroup par défaut sont réécrits en tant que universalSecurityGroup par défaut | string |