Microsoft.Graph-Gruppen
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie den Versions-Selektor.
Berechtigungen
Wählen Sie die Berechtigung oder Berechtigungen aus, die als am wenigsten privilegierte für diese API gekennzeichnet sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App sie benötigt. Ausführliche Informationen zu delegierten und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
Hinweis
Berechtigungen für persönliche Microsoft-Konten können nicht zum Bereitstellen von Microsoft Graph-Ressourcen verwendet werden, die in Bicep-Dateien deklariert sind.
Ressourcenbereitstellung
Wählen Sie die Berechtigung mit den geringsten Rechten aus der folgenden Tabelle aus, um eine Microsoft.Graph/Groups-Ressource zu erstellen oder zu aktualisieren.
Berechtigungstyp | Berechtigungen mit geringsten Berechtigungen | Berechtigungen mit höheren Berechtigungen |
---|---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | Group.ReadWrite.All | Directory.ReadWrite.All |
Delegiert (persönliches Microsoft-Konto) | Wird nicht unterstützt. | Wird nicht unterstützt. |
Application | Group.ReadWrite.All | Directory.ReadWrite.All |
Nur vorhandene Ressourcen lesen
Wählen Sie die Berechtigung mit den geringsten Rechten aus der folgenden Tabelle aus, um eine Microsoft.Graph/groups-Ressource mithilfe des Schlüsselworts existing
zu lesen.
Berechtigungstyp | Berechtigungen mit geringsten Berechtigungen | Berechtigungen mit höheren Berechtigungen |
---|---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Delegiert (persönliches Microsoft-Konto) | Wird nicht unterstützt. | Wird nicht unterstützt. |
Application | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Ressourcenformat
Um eine Microsoft.Graph/groups-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.
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'
}
}
Eigenschaftswerte
groups
Name | Beschreibung | Wert |
---|---|---|
apiVersion | Die Ressourcen-API-Version | "Beta" (ReadOnly) |
Klassifizierung | Beschreibt eine Klassifizierung für die Gruppe (z. B. niedrige, mittlere oder hohe Geschäftliche Auswirkungen) | Zeichenfolge |
cloudLicensing | Die Beziehungen einer Gruppe zu Cloudlizenzressourcen. | jegliche |
createdByAppId | App-ID der App, die zum Erstellen der Gruppe verwendet wird. Kann für einige Gruppen NULL sein. Schreibgeschützt | string (ReadOnly) |
createdDateTime | Zeitstempel der Erstellung der Gruppe. Der Wert kann nicht geändert werden und wird automatisch aufgefüllt, wenn die Gruppe erstellt wird. Der Timestamp-Typ stellt Datums- und Uhrzeitinformationen im ISO 8601-Format dar und ist immer in UTC enthalten. Mitternacht UTC-Zeit am 1. Januar 2014 lautet beispielsweise 2014-01-01T00:00:00Z. Schreibgeschützt. | string (ReadOnly) |
deletedDateTime | Datum und Uhrzeit, zu der dieses Objekt gelöscht wurde. Immer NULL, wenn das Objekt nicht gelöscht wurde. | string (ReadOnly) |
Beschreibung | Eine optionale Beschreibung für die Gruppe | Zeichenfolge |
displayName | Der Anzeigename für die Gruppe. Erforderlich. Maximale Länge beträgt 256 Zeichen | Zeichenfolge (Erforderlich) |
expirationDateTime | Zeitstempel des Ablaufs der Gruppe. Es ist null für Sicherheitsgruppen, aber für Microsoft 365-Gruppen stellt sie dar, wann die Gruppe so festgelegt ist, dass sie abläuft, wie in der groupLifecyclePolicy definiert. Der Timestamp-Typ stellt Datums- und Uhrzeitinformationen im ISO 8601-Format dar und ist immer in UTC enthalten. Mitternacht UTC-Zeit am 1. Januar 2014 lautet beispielsweise 2014-01-01T00:00:00Z. Schreibgeschützt. | string (ReadOnly) |
groupTypes | Gibt den Gruppentyp und seine Mitgliedschaft an. Wenn die Sammlung Unified enthält, ist die Gruppe eine Microsoft 365-Gruppe; andernfalls ist es entweder eine Sicherheitsgruppe oder eine Verteilergruppe. Ausführliche Informationen finden Sie unter "Gruppenübersicht". Wenn die Sammlung DynamicMembership enthält, weist die Gruppe dynamische Mitgliedschaft auf; andernfalls ist die Mitgliedschaft statisch. | string[] |
id | Der eindeutige Bezeichner für eine Entität. Schreibgeschützt. | string (ReadOnly) |
infoCatalogs | Identifiziert die Infosegmente, die der Gruppe zugewiesen sind. | string[] |
isAssignableToRole | Gibt an, ob diese Gruppe einer Microsoft Entra-Rolle zugewiesen werden kann. Optional. Diese Eigenschaft kann nur beim Erstellen der Gruppe festgelegt werden und ist unveränderlich. Wenn dieser Wert auf "true" festgelegt ist, muss die securityEnabled-Eigenschaft auch auf "true" festgelegt sein, die Sichtbarkeit muss ausgeblendet sein, und die Gruppe kann keine dynamische Gruppe sein (d. h. groupTypes können keine DynamicMembership enthalten). Nur Aufrufer mit mindestens der Rolle "Privileged Role Administrator" können diese Eigenschaft festlegen. Dem Aufrufer muss auch die Berechtigung "RoleManagement.ReadWrite.Directory" zugewiesen werden, um diese Eigenschaft festzulegen oder die Mitgliedschaft solcher Gruppen zu aktualisieren. Weitere Informationen finden Sie unter Verwenden einer Gruppe zum Verwalten von Microsoft Entra-Rollenzuweisungen. Für dieses Feature ist eine Microsoft Entra ID P1-Lizenz erforderlich. | bool |
isManagementRestricted | Gibt an, ob die Gruppe Mitglied einer verwaltungsbeschränkten Verwaltungseinheit ist. Der Standardwert ist false. Schreibgeschützt. Um ein Gruppenmitglied einer verwaltungsbeschränkten Verwaltungseinheit zu verwalten, muss dem Administrator oder der aufrufenden App eine Microsoft Entra-Rolle im Rahmen der verwaltungsbeschränkten Verwaltungseinheit zugewiesen werden. | bool (ReadOnly) |
Die SMTP-Adresse für die Gruppe, z. B. "serviceadmins@contoso.com". Schreibgeschützt | string (ReadOnly) | |
mailEnabled | Gibt an, ob die Gruppe E-Mail-aktiviert ist. Erforderlich | bool (Erforderlich) |
mailNickname | Der E-Mail-Alias für die Gruppe, eindeutig für Microsoft 365-Gruppen in der Organisation. Die maximale Länge beträgt 64 Zeichen. Diese Eigenschaft kann nur Zeichen im ASCII-Zeichensatz 0 - 127 enthalten, mit Ausnahme der folgenden: @ () / [] ' ; : <> , LEERZEICHEN | Zeichenfolge (Erforderlich) |
members | Direkte Gruppenmitglieder, die Benutzer, Geräte, andere Gruppen oder Dienstprinzipale sein können. Unterstützt die Vorgänge "Mitglieder hinzufügen", "Mitglied hinzufügen" und "Mitglieder entfernen". NULL zulassen | string[] |
membershipRule | Die Regel, die Mitglieder für diese Gruppe bestimmt, wenn es sich bei der Gruppe um eine dynamische Gruppe handelt (groupTypes enthält DynamicMembership). Weitere Informationen zur Syntax der Mitgliedschaftsregel finden Sie unter Syntax der Mitgliedschaftsregeln | Zeichenfolge |
membershipRuleProcessingState | Gibt an, ob die Verarbeitung der dynamischen Mitgliedschaft aktiviert oder angehalten ist. Mögliche Werte sind "Ein" oder "Angehalten" | Zeichenfolge |
onPremisesDomainName | Enthält den lokalen Domänen-FQDN, auch als dnsDomainName synchronisiert aus dem lokalen Verzeichnis. Schreibgeschützt. | string (ReadOnly) |
onPremisesLastSyncDateTime | Gibt das letzte Mal an, zu dem die Gruppe mit dem lokalen Verzeichnis synchronisiert wurde. Der Timestamp-Typ stellt Datums- und Uhrzeitinformationen im ISO 8601-Format dar und ist immer in UTC enthalten. Mitternacht UTC-Zeit am 1. Januar 2014 lautet beispielsweise 2014-01-01T00:00:00Z. Schreibgeschützt | string (ReadOnly) |
onPremisesNetBiosName | Enthält den lokalen NetBios-Namen, der aus dem lokalen Verzeichnis synchronisiert wird. Schreibgeschützt. | string (ReadOnly) |
onPremisesProvisioningErrors | Fehler beim Verwenden des Microsoft-Synchronisierungsprodukts während der Bereitstellung | MicrosoftGraphOnPremisesProvisioningError[] (ReadOnly) |
onPremisesSamAccountName | Enthält den lokalen SAM-Kontonamen, der aus dem lokalen Verzeichnis synchronisiert wird. Schreibgeschützt. | string (ReadOnly) |
onPremisesSecurityIdentifier | Enthält die lokale Sicherheits-ID (SID) für die Gruppe, die von lokal mit der Cloud synchronisiert wird. Schreibgeschützt | string (ReadOnly) |
onPremisesSyncEnabled | true, wenn diese Gruppe aus einem lokalen Verzeichnis synchronisiert wird; false, wenn diese Gruppe ursprünglich aus einem lokalen Verzeichnis synchronisiert wurde, aber nicht mehr synchronisiert wird; null, wenn dieses Objekt nie aus einem lokalen Verzeichnis synchronisiert wurde (Standard). Schreibgeschützt | bool (ReadOnly) |
organizationId | Zeichenfolge | |
Besitzer | Die Besitzer der Gruppe, die Benutzer oder Dienstprinzipale sein können. Auf 100 Besitzer beschränkt. NULL-Werte sind zulässig. Wenn diese Eigenschaft beim Erstellen einer Microsoft 365-Gruppe nicht angegeben wird, wird der aufrufende Benutzer (Administrator oder Nichtadministrator) automatisch als Gruppenbesitzer zugewiesen. Ein Nicht-Administrator-Benutzer kann sich nicht explizit zu dieser Sammlung hinzufügen, wenn er die Gruppe erstellt. Weitere Informationen finden Sie im zugehörigen bekannten Problem. Bei Sicherheitsgruppen wird der Administratorbenutzer dieser Sammlung nicht automatisch hinzugefügt. Weitere Informationen finden Sie im zugehörigen bekannten Problem. | string[] |
preferredDataLocation | Der bevorzugte Datenspeicherort für die Microsoft 365-Gruppe. Standardmäßig erbt die Gruppe den bevorzugten Datenspeicherort der Gruppe. Um diese Eigenschaft festzulegen, muss die aufrufende App die Berechtigung "Directory.ReadWrite.All" erhalten und dem Benutzer mindestens eine der folgenden Microsoft Entra-Rollen zugewiesen werden: Administrator des Administratoradministrators des Exchange-Administratoradministrators für Benutzerkonten, SharePoint-Administrator Für weitere Informationen zu dieser Eigenschaft finden Sie unter OneDrive Online Multi-Geo und Erstellen einer Microsoft 365-Gruppe mit einer bestimmten PDL. NULL zulassen | Zeichenfolge |
preferredLanguage | Die bevorzugte Sprache für eine Microsoft 365-Gruppe. Sollte dem ISO 639-1-Code folgen; z. B. "en-US" | Zeichenfolge |
proxyAddresses | E-Mail-Adressen für die Gruppe, die an dasselbe Gruppenpostfach weiterleiten. Beispiel: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. Der beliebige Operator ist für Filterausdrücke für mehrwertige Eigenschaften erforderlich. Schreibgeschützt. Lässt keine NULL-Werte zu | string[] (ReadOnly) |
renewalDateTime | Zeitstempel der letzten Verlängerung der Gruppe. Dies kann nicht direkt geändert werden und wird nur über die Verlängerungsdienstaktion aktualisiert. Der Timestamp-Typ stellt Datums- und Uhrzeitinformationen im ISO 8601-Format dar und ist immer in UTC enthalten. Mitternacht UTC-Zeit am 1. Januar 2014 lautet beispielsweise 2014-01-01T00:00:00Z. Schreibgeschützt. | string (ReadOnly) |
resourceBehaviorOptions | Gibt das Gruppenverhalten an, das während der Erstellung für eine Microsoft 365-Gruppe festgelegt werden kann. Diese Eigenschaft kann nur als Teil der Erstellung (POST) festgelegt werden. Eine Liste der möglichen Werte finden Sie unter Microsoft 365-Gruppenverhalten und Bereitstellungsoptionen. | string[] |
resourceProvisioningOptions | Gibt die Gruppenressourcen an, die der Microsoft 365-Gruppe zugeordnet sind. Der mögliche Wert ist Team. Weitere Informationen finden Sie unter Microsoft 365-Gruppenverhalten und Bereitstellungsoptionen | string[] |
securityEnabled | Gibt an, ob es sich bei der Gruppe um eine Sicherheitsgruppe handelt. | bool (Erforderlich) |
securityIdentifier | Sicherheitsbezeichner der Gruppe, die in Windows-Szenarien verwendet wird. Schreibgeschützt | string (ReadOnly) |
serviceProvisioningErrors | Fehler, die von einem Verbunddienst veröffentlicht wurden, der einen nicht vorübergehenden, dienstspezifischen Fehler in Bezug auf die Eigenschaften oder Verknüpfungen aus einem Gruppenobjekt beschreibt. | MicrosoftGraphServiceProvisioningError[] (ReadOnly) |
Design | Gibt das Farbdesign einer Microsoft 365-Gruppe an. Mögliche Werte sind Teal, Purple, Green, Blue, Pink, Orange oder Red. | Zeichenfolge |
Typ | Der Ressourcentyp | "Microsoft.Graph/groups" (ReadOnly) |
uniqueName | Der eindeutige Bezeichner, der einer Gruppe zugewiesen und als alternativer Schlüssel verwendet werden kann. Unveränderlich | Zeichenfolge (Erforderlich) |
Sichtbarkeit | Gibt die Gruppenbeitrittsrichtlinie und die Sichtbarkeit von Gruppeninhalten für Gruppen an. Mögliche Werte sind: Private, Public oder HiddenMembership. HiddenMembership kann nur für Microsoft 365-Gruppen festgelegt werden, wenn die Gruppen erstellt werden. Sie kann später nicht aktualisiert werden. Andere Werte der Sichtbarkeit können nach der Gruppenerstellung aktualisiert werden. Wenn während der Gruppenerstellung in Microsoft Graph kein Sichtbarkeitswert angegeben wird, wird standardmäßig eine Sicherheitsgruppe als "Privat" erstellt, und die Microsoft 365-Gruppe ist öffentlich. Gruppen, die Rollen zugewiesen werden können, sind immer privat. Weitere Informationen finden Sie unter Gruppensichtbarkeitsoptionen. NULL-Werte sind zulässig. | Zeichenfolge |
writebackConfiguration | Gibt an, ob eine Gruppe so konfiguriert ist, dass gruppenobjekteigenschaften in lokales Active Directory zurückgeschrieben werden. Diese Eigenschaften werden verwendet, wenn gruppenrückschreiben im Microsoft Entra Connect-Synchronisierungsclient konfiguriert ist. | MicrosoftGraphGroupWritebackConfiguration |
MicrosoftGraphOnPremisesProvisioningError
Name | Beschreibung | Wert |
---|---|---|
category | Kategorie des Bereitstellungsfehlers. Hinweis: Derzeit gibt es nur einen möglichen Wert. Möglicher Wert: PropertyConflict - gibt an, dass ein Eigenschaftswert nicht eindeutig ist. Andere Objekte enthalten denselben Wert für die Eigenschaft. | Zeichenfolge |
occurredDateTime | Das Datum und die Uhrzeit, zu dem der Fehler aufgetreten ist. | Zeichenfolge |
propertyCausingError | Name der Verzeichniseigenschaft, die den Fehler verursacht. Aktuelle mögliche Werte: UserPrincipalName oder ProxyAddress | Zeichenfolge |
value | Der Wert der Eigenschaft, die den Fehler verursacht. | Zeichenfolge |
MicrosoftGraphServiceProvisioningError
Name | Beschreibung | Wert |
---|---|---|
createdDateTime | Das Datum und die Uhrzeit, zu dem der Fehler aufgetreten ist. | Zeichenfolge |
isResolved | Gibt an, ob der Fehler besucht wurde. | bool |
serviceInstance | Qualifizierte Dienstinstanz (z. B. "SharePoint/Dublin"), die die Dienstfehlerinformationen veröffentlicht hat. | Zeichenfolge |
MicrosoftGraphGroupWritebackConfiguration
Name | Beschreibung | Wert |
---|---|---|
isEnabled | Gibt an, ob das Zurückschreiben von Cloudgruppen in lokales Active Directory aktiviert ist. Der Standardwert gilt für Microsoft 365-Gruppen und "false" für Sicherheitsgruppen. | bool |
onPremisesGroupType | Gibt den Lokalen Zielgruppentyp an, in den das Cloudobjekt zurückgeschrieben wird. NULL-Werte sind zulässig. Die folgenden Werte sind möglich: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.If the cloud group is a unified (Microsoft 365) group, this property can be one of the following: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. Microsoft Entra-Sicherheitsgruppen können als universalSecurityGroup zurückgeschrieben werden. Wenn isEnabled oder die Einstellung der Gruppe NewUnifiedGroupWritebackDefault true ist, diese Eigenschaft jedoch nicht explizit konfiguriert ist: Microsoft 365-Gruppen werden standardmäßig als universalDistributionGroup zurückgeschrieben. | Zeichenfolge |