Microsoft.Graph-grupper
Viktigt!
API:er under /beta
versionen i Microsoft Graph kan komma att ändras. Användning av dessa API:er i produktionsprogram stöds inte. Om du vill avgöra om ett API är tillgängligt i v1.0 använder du versionsväljaren.
Behörigheter
Välj behörigheten eller behörigheterna som markerats som minst privilegierade för det här API:et. Använd endast behörigheter med högre privilegier om din app kräver det. Mer information om delegerade behörigheter och programbehörigheter finns i Behörighetstyper. Mer information om dessa behörigheter finns i behörighetsreferensen.
Kommentar
Behörigheter för personliga Microsoft-konton kan inte användas för att distribuera Microsoft Graph-resurser som deklarerats i Bicep-filer.
Resursdistribution
Välj den minst privilegierade behörigheten i följande tabell för att skapa eller uppdatera en Microsoft.Graph/groups-resurs.
Behörighetstyp | Minst privilegierade behörigheter | Behörigheter med högre privilegier |
---|---|---|
Delegerad (arbets- eller skolkonto) | Group.ReadWrite.All | Directory.ReadWrite.All |
Delegerad (personligt Microsoft-konto) | Stöds inte. | Stöds inte. |
Program | Group.ReadWrite.All | Directory.ReadWrite.All |
Skrivskyddade befintliga resurser
Välj den minst privilegierade behörigheten i följande tabell för att läsa en Microsoft.Graph/groups-resurs med hjälp av nyckelordet existing
.
Behörighetstyp | Minst privilegierade behörigheter | Behörigheter med högre privilegier |
---|---|---|
Delegerad (arbets- eller skolkonto) | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Delegerad (personligt Microsoft-konto) | Stöds inte. | Stöds inte. |
Program | GroupMember.Read.All | Group.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All |
Resursformat
Om du vill skapa en Microsoft.Graph/groups-resurs lägger du till följande Bicep i mallen.
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'
}
}
Egenskapsvärden
grupper
Name | Beskrivning | Värde |
---|---|---|
apiVersion | Resurs-API-versionen | 'beta' (ReadOnly) |
klassificering | Beskriver en klassificering för gruppen (till exempel låg, medelhög eller hög affärspåverkan) | sträng |
cloudLicensing | Relationerna mellan en grupp och molnlicensieringsresurser. | någon |
createdByAppId | App-ID för den app som används för att skapa gruppen. Kan vara null för vissa grupper. Skrivskydd | sträng (ReadOnly) |
createdDateTime | Tidsstämpel för när gruppen skapades. Värdet kan inte ändras och fylls i automatiskt när gruppen skapas. Tidsstämpeltypen representerar datum- och tidsinformation med ISO 8601-format och är alltid i UTC. Till exempel är midnatt UTC den 1 januari 2014 2014-01-01T00:00:00Z. Skrivskyddat. | sträng (ReadOnly) |
deletedDateTime | Datum och tid då objektet togs bort. Alltid null när objektet inte har tagits bort. | sträng (ReadOnly) |
description | En valfri beskrivning för gruppen | sträng |
displayName | Visningsnamnet för gruppen. Obligatoriskt. Maximal längd är 256 tecken | sträng (krävs) |
expirationDateTime | Tidsstämpel för när gruppen är inställd på att upphöra att gälla. Den är null för säkerhetsgrupper, men för Microsoft 365-grupper representerar den när gruppen är inställd på att upphöra enligt definitionen i groupLifecyclePolicy. Tidsstämpeltypen representerar datum- och tidsinformation med ISO 8601-format och är alltid i UTC. Till exempel är midnatt UTC den 1 januari 2014 2014-01-01T00:00:00Z. Skrivskyddat. | sträng (ReadOnly) |
groupTypes | Anger grupptypen och dess medlemskap. Om samlingen innehåller Unified är gruppen en Microsoft 365-grupp. Annars är det antingen en säkerhetsgrupp eller en distributionsgrupp. Mer information finns i översikten över grupper. Om samlingen innehåller DynamicMembership har gruppen dynamiskt medlemskap. annars är medlemskap statiskt | string[] |
id | Den unika identifieraren för en entitet. Skrivskyddat. | sträng (ReadOnly) |
infoCatalogs | Identifierar de informationssegment som tilldelats gruppen | string[] |
isAssignableToRole | Anger om den här gruppen kan tilldelas en Microsoft Entra-roll. Valfritt. Den här egenskapen kan bara anges när du skapar gruppen och är oföränderlig. Om värdet är true måste egenskapen securityEnabled också vara inställd på true, synligheten måste vara Dold och gruppen kan inte vara en dynamisk grupp (det vill: groupTypes kan inte innehålla DynamicMembership). Endast anropare med rollen Privilegierad rolladministratör kan ange den här egenskapen. Anroparen måste också tilldelas behörigheten RoleManagement.ReadWrite.Directory för att kunna ange den här egenskapen eller uppdatera medlemskapet för sådana grupper. Mer information finns i Använda en grupp för att hantera Microsoft Entra-rolltilldelningarAnvända den här funktionen kräver en Microsoft Entra ID P1-licens | bool |
isManagementRestricted | Anger om gruppen är medlem i en administrativ enhet för begränsad hantering. Standardvärdet är "false". Skrivskyddat. Om du vill hantera en gruppmedlem i en administrativ enhet för begränsad hantering måste administratören eller den anropande appen tilldelas en Microsoft Entra-roll i omfånget för den administrativa enheten för begränsad hantering. | bool (ReadOnly) |
e-post | SMTP-adressen för gruppen, till exempel "serviceadmins@contoso.com". Skrivskydd | sträng (ReadOnly) |
mailEnabled | Anger om gruppen är e-postaktiverad. Obligatoriskt | bool (krävs) |
mailNickname | E-postaliaset för gruppen, unikt för Microsoft 365-grupper i organisationen. Maximal längd är 64 tecken. Den här egenskapen får endast innehålla tecken i ASCII-teckenuppsättningen 0–127 förutom följande: @ () / [] ' ; : <> , BLANKSTEG | sträng (krävs) |
medlemmar | Direkta gruppmedlemmar, som kan vara användare, enheter, andra grupper eller tjänstens huvudnamn. Stöder åtgärderna Listmedlemmar, Lägg till medlem och Ta bort medlem. Kan ha värdet null | string[] |
membershipRule | Regeln som avgör medlemmar för den här gruppen om gruppen är en dynamisk grupp (groupTypes innehåller DynamicMembership). Mer information om syntaxen för medlemskapsregeln finns i Syntax för medlemskapsregler | sträng |
membershipRuleProcessingState | Anger om den dynamiska medlemskapsbearbetningen är aktiverad eller pausad. Möjliga värden är På eller Pausade | sträng |
onPremisesDomainName | Innehåller det lokala domän-FQDN, även kallat dnsDomainName synkroniserat från den lokala katalogen. Skrivskyddat. | sträng (ReadOnly) |
onPremisesLastSyncDateTime | Anger den senaste gången som gruppen synkroniserades med den lokala katalogen. Tidsstämpeltypen representerar datum- och tidsinformation med ISO 8601-format och är alltid i UTC. Till exempel är midnatt UTC den 1 januari 2014 2014-01-01T00:00:00Z. Skrivskydd | sträng (ReadOnly) |
onPremisesNetBiosName | Innehåller det lokala netBios-namnet som synkroniserats från den lokala katalogen. Skrivskyddat. | sträng (ReadOnly) |
onPremisesProvisioningErrors | Fel vid användning av Microsoft-synkroniseringsprodukt under etablering | MicrosoftGraphOnPremisesProvisioningError[] (ReadOnly) |
onPremisesSamAccountName | Innehåller det lokala SAM-kontonamnet som synkroniserats från den lokala katalogen. Skrivskyddat. | sträng (ReadOnly) |
onPremisesSecurityIdentifier | Innehåller den lokala säkerhetsidentifieraren (SID) för gruppen som synkroniserats från en lokal plats till molnet. Skrivskydd | sträng (ReadOnly) |
onPremisesSyncEnabled | sant om den här gruppen synkroniseras från en lokal katalog. false om den här gruppen ursprungligen synkroniserades från en lokal katalog men inte längre synkroniseras. null om det här objektet aldrig har synkroniserats från en lokal katalog (standard). Skrivskydd | bool (ReadOnly) |
organizationId | sträng | |
ägare | Ägare till gruppen som kan vara användare eller tjänstens huvudnamn. Begränsat till 100 ägare. Nullbar. Om den här egenskapen inte anges när du skapar en Microsoft 365-grupp tilldelas den anropande användaren (administratör eller icke-administratör) automatiskt som gruppägare. En icke-administratörsanvändare kan inte uttryckligen lägga till sig själva i den här samlingen när de skapar gruppen. Mer information finns i det relaterade kända problemet. För säkerhetsgrupper läggs inte administratörsanvändaren automatiskt till i den här samlingen. Mer information finns i det relaterade kända problemet | string[] |
preferredDataLocation | Önskad dataplats för Microsoft 365-gruppen. Som standard ärver gruppen den gruppskapares önskade dataplats. Om du vill ange den här egenskapen måste den anropande appen beviljas behörigheten Directory.ReadWrite.All och användaren tilldelas minst en av följande Microsoft Entra-roller: Administratör för användarkonto KatalogFörfattare Exchange Administratör SharePoint-administratör För mer information om den här egenskapen, se OneDrive Online Multi-Geo och Skapa en Microsoft 365-grupp med en specifik PDL. Kan ha värdet null | sträng |
preferredLanguage | Det föredragna språket för en Microsoft 365-grupp. Bör följa ISO 639-1 Code; till exempel en-US | sträng |
proxyAddresses | E-postadresser för gruppen som dirigerar till samma grupppostlåda. Exempel: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. Alla operatorer krävs för filteruttryck på egenskaper med flera värden. Skrivskyddat. Inte nullbar | string[] (ReadOnly) |
renewedDateTime | Tidsstämpel för när gruppen senast förnyades. Detta kan inte ändras direkt och uppdateras endast via åtgärden förnya tjänsten. Tidsstämpeltypen representerar datum- och tidsinformation med ISO 8601-format och är alltid i UTC. Till exempel är midnatt UTC den 1 januari 2014 2014-01-01T00:00:00Z. Skrivskyddat. | sträng (ReadOnly) |
resourceBehaviorOptions | Anger vilka gruppbeteenden som kan anges för en Microsoft 365-grupp när den skapas. Den här egenskapen kan endast anges som en del av skapandet (POST). En lista över möjliga värden finns i Microsoft 365-gruppbeteenden och etableringsalternativ. | string[] |
resourceProvisioningOptions | Anger de gruppresurser som är associerade med Microsoft 365-gruppen. Det möjliga värdet är Team. Mer information finns i Microsoft 365-gruppbeteenden och etableringsalternativ | string[] |
securityEnabled | Anger om gruppen är en säkerhetsgrupp | bool (krävs) |
securityIdentifier | Säkerhetsidentifierare för gruppen som används i Windows-scenarier. Skrivskydd | sträng (ReadOnly) |
serviceProvisioningErrors | Fel som publicerats av en federerad tjänst som beskriver ett icke-tillfälligt, tjänstspecifikt fel om egenskaperna eller länken från ett gruppobjekt. | MicrosoftGraphServiceProvisioningError[] (ReadOnly) |
tema | Anger en Microsoft 365-grupps färgtema. Möjliga värden är kricka, lila, grön, blå, rosa, orange eller röd | sträng |
type | Resurstypen | "Microsoft.Graph/groups" (ReadOnly) |
uniqueName | Den unika identifierare som kan tilldelas till en grupp och användas som en alternativ nyckel. Oföränderliga | sträng (krävs) |
synlighet | Anger gruppkopplingsprincipen och synligheten för gruppinnehåll för grupper. Möjliga värden är: Privat, Offentlig eller HiddenMembership. HiddenMembership kan endast anges för Microsoft 365-grupper när grupperna skapas. Det kan inte uppdateras senare. Andra synlighetsvärden kan uppdateras när gruppen har skapats. Om synlighetsvärdet inte anges när gruppen skapas i Microsoft Graph skapas en säkerhetsgrupp som privat som standard och Microsoft 365-gruppen är offentlig. Grupper som kan tilldelas roller är alltid privata. Mer information finns i alternativ för gruppsynlighet. Nullbar. | sträng |
writebackConfiguration | Anger om en grupp har konfigurerats för att skriva tillbaka gruppobjektegenskaper till lokal Active Directory. Dessa egenskaper används när tillbakaskrivning av grupper konfigureras i Microsoft Entra Connect-synkroniseringsklienten. | MicrosoftGraphGroupWritebackConfiguration |
MicrosoftGraphOnPremisesProvisioningError
Name | Beskrivning | Värde |
---|---|---|
category | Kategorin för etableringsfelet. Obs! För närvarande finns det bara ett möjligt värde. Möjligt värde: PropertyConflict – anger att ett egenskapsvärde inte är unikt. Andra objekt innehåller samma värde för egenskapen. | sträng |
occurredDateTime | Datum och tid då felet inträffade. | sträng |
propertyCausingError | Namnet på katalogegenskapen som orsakar felet. Aktuella möjliga värden: UserPrincipalName eller ProxyAddress | sträng |
värde | Värdet för egenskapen som orsakar felet. | sträng |
MicrosoftGraphServiceProvisioningError
Name | Beskrivning | Värde |
---|---|---|
createdDateTime | Datum och tid då felet inträffade. | sträng |
isResolved | Anger om felet har lagts till. | bool |
serviceInstance | Kvalificerad tjänstinstans (till exempel SharePoint/Dublin) som publicerade felinformationen för tjänsten. | sträng |
MicrosoftGraphGroupWritebackConfiguration
Name | Beskrivning | Värde |
---|---|---|
isEnabled | Anger om tillbakaskrivning av molngrupper till lokal Active Directory är aktiverat. Standardvärdet är sant för Microsoft 365-grupper och falskt för säkerhetsgrupper. | bool |
onPremisesGroupType | Anger den lokala målgruppstypen som molnobjektet skrivs tillbaka som. Nullbar. Möjliga värden är: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.Om molngruppen är en enhetlig grupp (Microsoft 365) kan den här egenskapen vara något av följande: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. Microsoft Entra-säkerhetsgrupper kan skrivas tillbaka som universalSecurityGroup. Om isEnabled eller gruppinställningen NewUnifiedGroupWritebackDefault är sann men den här egenskapen inte är uttryckligen konfigurerad: Microsoft 365-grupper skrivs tillbaka som universalDistributionGroup som standardSäkerhetsgrupper skrivs tillbaka som universalSecurityGroup som standard | sträng |