Gruppi di Microsoft.Graph
Importante
Le API nella /beta
versione in Microsoft Graph sono soggette a modifiche. L'uso di queste API nelle applicazioni di produzione non è supportato. Per determinare se un'API è disponibile nella versione 1.0, usare il selettore versione .
Autorizzazioni
Scegliere l'autorizzazione o le autorizzazioni contrassegnate come con privilegi minimi per questa API. Usare un'autorizzazione o autorizzazioni con privilegi più elevati solo se l'app lo richiede. Per informazioni dettagliate sulle autorizzazioni delegate e dell'applicazione, vedere Tipi di autorizzazioni. Per altre informazioni su queste autorizzazioni, vedere le informazioni di riferimento sulle autorizzazioni.
Nota
Le autorizzazioni per gli account Microsoft personali non possono essere usate per distribuire le risorse di Microsoft Graph dichiarate nei file Bicep.
Tipo di autorizzazione | Autorizzazioni con privilegi minimi | Autorizzazioni con privilegi più elevati |
---|---|---|
Delegata (account di lavoro o dell'istituto di istruzione) | Group.ReadWrite.All | Directory.ReadWrite.All |
Delegata (account Microsoft personale) | Non supportata. | Non supportata. |
Applicazione | Group.ReadWrite.All | Directory.ReadWrite.All |
Formato di risorsa
Per creare una risorsa Microsoft.Graph/groups, aggiungere il bicep seguente al modello.
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'
}
}
Valori delle proprietà
gruppi
Nome | Descrizione | valore |
---|---|---|
apiVersion | Versione dell'API della risorsa | 'beta' (ReadOnly) |
classificazione | Descrive una classificazione per il gruppo ( ad esempio basso, medio o alto impatto aziendale) | string |
createdByAppId | ID app dell'app usata per creare il gruppo. Può essere Null per alcuni gruppi. Sola lettura | string (ReadOnly) |
createdDateTime | Timestamp di quando è stato creato il gruppo. Il valore non può essere modificato e viene popolato automaticamente quando viene creato il gruppo. Il tipo Timestamp rappresenta le informazioni di data e ora usando il formato ISO 8601 ed è sempre in formato UTC. Ad esempio, mezzanotte UTC il 1 gennaio 2014 è 2014-01-01T00:00:00Z. Sola lettura. | string (ReadOnly) |
deletedDateTime | Data e ora di eliminazione dell'oggetto. Sempre Null quando l'oggetto non è stato eliminato. | string (ReadOnly) |
description | Descrizione facoltativa per il gruppo | string |
displayName | Nome visualizzato per il gruppo. Obbligatorio. La lunghezza massima è di 256 caratteri | string (obbligatorio) |
expirationDateTime | Timestamp di quando il gruppo è impostato per la scadenza. È null per i gruppi di sicurezza, ma per i gruppi di Microsoft 365, rappresenta quando il gruppo è impostato per scadere come definito in groupLifecyclePolicy. Il tipo Timestamp rappresenta le informazioni di data e ora usando il formato ISO 8601 ed è sempre in formato UTC. Ad esempio, mezzanotte UTC il 1 gennaio 2014 è 2014-01-01T00:00:00Z. Sola lettura. | string (ReadOnly) |
groupTypes | Specifica il tipo di gruppo e la relativa appartenenza. Se la raccolta contiene Unified, il gruppo è un gruppo di Microsoft 365; in caso contrario, si tratta di un gruppo di sicurezza o di un gruppo di distribuzione. Per informazioni dettagliate, vedere Panoramica dei gruppi. Se la raccolta include DynamicMembership, il gruppo ha appartenenza dinamica; in caso contrario, l'appartenenza è statica | string[] |
id | Identificatore univoco per un'entità. Sola lettura. | string (ReadOnly) |
infoCatalogs | Identifica i segmenti di informazioni assegnati al gruppo | string[] |
isAssignableToRole | Indica se questo gruppo può essere assegnato a un ruolo Microsoft Entra. Facoltativo. Questa proprietà può essere impostata solo durante la creazione del gruppo ed è non modificabile. Se impostato su true, la proprietà securityEnabled deve essere impostata anche su true, la visibilità deve essere Hidden e il gruppo non può essere un gruppo dinamico, ovvero groupTypes non può contenere DynamicMembership. Solo i chiamanti con almeno il ruolo Amministratore ruolo con privilegi possono impostare questa proprietà. Al chiamante deve essere assegnata anche l'autorizzazione RoleManagement.ReadWrite.Directory per impostare questa proprietà o aggiornare l'appartenenza di tali gruppi. Per altre informazioni, vedere Uso di un gruppo per gestire le assegnazioni di ruolo di Microsoft EntraUsing this feature richiede una licenza microsoft Entra ID P1 | bool |
isManagementRestricted | Indica se il gruppo è membro di un'unità amministrativa di gestione con restrizioni, nel qual caso richiede un ruolo con ambito per l'unità amministrativa limitata da gestire. Il valore predefinito è false. Sola lettura. Per gestire un membro del gruppo di un'unità amministrativa con restrizioni, all'app chiamante deve essere assegnata l'autorizzazione Directory.Write.Restricted. Per gli scenari delegati, gli amministratori devono anche essere assegnati in modo esplicito ai ruoli supportati nell'ambito dell'unità amministrativa con restrizioni. | bool (ReadOnly) |
Indirizzo SMTP per il gruppo, ad esempio 'serviceadmins@contoso.com'. Sola lettura | string (ReadOnly) | |
mailEnabled | Specifica se il gruppo è abilitato alla posta elettronica. Richiesto | bool (obbligatorio) |
mailNickname | Alias di posta elettronica per il gruppo, univoco per i gruppi di Microsoft 365 nell'organizzazione. La lunghezza massima consentita è di 64 caratteri. Questa proprietà può contenere solo caratteri nel set di caratteri ASCII da 0 a 127, ad eccezione del seguente: @ () / [] ' ; : <> , SPAZIO | string (obbligatorio) |
membri | Membri del gruppo diretto, che possono essere utenti, dispositivi, altri gruppi o entità servizio. Supporta le operazioni List members, Add member e Remove member. Nullable | string[] |
membershipRule | Regola che determina i membri per questo gruppo se il gruppo è un gruppo dinamico (groupTypes contiene DynamicMembership). Per altre informazioni sulla sintassi della regola di appartenenza, vedere sintassi delle regole di appartenenza | string |
membershipRuleProcessingState | Indica se l'elaborazione dell'appartenenza dinamica è attiva o sospesa. I valori possibili sono On o Paused | string |
onPremisesDomainName | Contiene il nome di dominio completo del dominio locale, denominato anche dnsDomainName sincronizzato dalla directory locale. Sola lettura. | string (ReadOnly) |
onPremisesLastSyncDateTime | Indica l'ultima volta in cui il gruppo è stato sincronizzato con la directory locale. Il tipo Timestamp rappresenta le informazioni di data e ora usando il formato ISO 8601 ed è sempre in formato UTC. Ad esempio, mezzanotte UTC il 1 gennaio 2014 è 2014-01-01T00:00:00Z. Sola lettura | string (ReadOnly) |
onPremisesNetBiosName | Contiene il nome netBios locale sincronizzato dalla directory locale. Sola lettura. | string (ReadOnly) |
onPremisesProvisioningErrors | Errori durante l'uso del prodotto di sincronizzazione Microsoft durante il provisioning | MicrosoftGraphOnPremisesProvisioningError[] (ReadOnly) |
onPremisesSamAccountName | Contiene il nome dell'account SAM locale sincronizzato dalla directory locale. Sola lettura. | string (ReadOnly) |
onPremisesSecurityIdentifier | Contiene l'identificatore di sicurezza locale (SID) per il gruppo sincronizzato dall'ambiente locale al cloud. Sola lettura | string (ReadOnly) |
onPremisesSyncEnabled | true se questo gruppo viene sincronizzato da una directory locale; false se il gruppo è stato originariamente sincronizzato da una directory locale ma non è più sincronizzato; Null se questo oggetto non è mai stato sincronizzato da una directory locale (impostazione predefinita). Sola lettura | bool (ReadOnly) |
organizationId | string | |
owners | Proprietari del gruppo che possono essere utenti o entità servizio. Ammette valori Null. Se questa proprietà non viene specificata durante la creazione di un gruppo di Microsoft 365, l'utente chiamante viene assegnato automaticamente come proprietario del gruppo | string[] |
preferredDataLocation | Posizione dei dati preferita per il gruppo di Microsoft 365. Per impostazione predefinita, il gruppo eredita la posizione dei dati preferita dell'autore del gruppo. Per impostare questa proprietà, all'app chiamante deve essere concessa l'autorizzazione Directory.ReadWrite.All e all'utente devono essere assegnati almeno uno dei seguenti ruoli di Microsoft Entra: Amministratore directory amministratore directory dell'account utente Amministratore di Exchange Amministratore sharePoint di Exchange Per ulteriori informazioni su questa proprietà, vedere OneDrive Online Multi-Geo e Creare un gruppo di Microsoft 365 con un PDL specifico. Nullable | string |
linguaPreferita | Lingua preferita per un gruppo di Microsoft 365. Deve seguire il codice ISO 639-1; ad esempio en-US | string |
proxyAddresses | Indirizzi di posta elettronica per il gruppo diretto alla stessa cassetta postale del gruppo. Ad esempio: ['SMTP: bob@contoso.com', 'smtp: bob@sales.contoso.com']. L'operatore any è necessario per le espressioni di filtro sulle proprietà multivalore. Sola lettura. Non nullable | string[] (ReadOnly) |
renewedDateTime | Timestamp dell'ultimo rinnovo del gruppo. Questa operazione non può essere modificata direttamente e viene aggiornata solo tramite l'azione di rinnovo del servizio. Il tipo Timestamp rappresenta le informazioni di data e ora usando il formato ISO 8601 ed è sempre in formato UTC. Ad esempio, mezzanotte UTC il 1 gennaio 2014 è 2014-01-01T00:00:00Z. Sola lettura. | string (ReadOnly) |
resourceBehaviorOptions | Specifica i comportamenti del gruppo che possono essere impostati per un gruppo di Microsoft 365 durante la creazione. Questa proprietà può essere impostata solo come parte della creazione (POST). Per l'elenco dei valori possibili, vedere Comportamenti e opzioni di provisioning dei gruppi di Microsoft 365. | string[] |
resourceProvisioningOptions | Specifica le risorse del gruppo associate al gruppo di Microsoft 365. Il valore possibile è Team. Per altre informazioni, vedere Comportamenti e opzioni di provisioning dei gruppi di Microsoft 365 | string[] |
securityEnabled | Specifica se il gruppo è un gruppo di sicurezza | bool (obbligatorio) |
securityIdentifier | Identificatore di sicurezza del gruppo, usato negli scenari di Windows. Sola lettura | string (ReadOnly) |
serviceProvisioningErrors | Errori pubblicati da un servizio federato che descrive un errore non temporaneo specifico del servizio relativo alle proprietà o al collegamento da un oggetto gruppo. | MicrosoftGraphServiceProvisioningError[] |
tema | Specifica il tema colore di un gruppo di Microsoft 365. I valori possibili sono Teal, Purple, Green, Blue, Pink, Orange o Red | string |
type | Tipo di risorsa | 'Microsoft.Graph/groups' (ReadOnly) |
uniqueName | Identificatore univoco che può essere assegnato a un gruppo e usato come chiave alternativa. non modificabile | string (obbligatorio) |
visibility | Specifica i criteri di join di gruppo e la visibilità del contenuto del gruppo per i gruppi. I valori possibili sono: Private, Public o HiddenMembership. HiddenMembership può essere impostato solo per i gruppi di Microsoft 365 quando vengono creati i gruppi. Non può essere aggiornato in un secondo momento. È possibile aggiornare altri valori di visibilità dopo la creazione del gruppo. Se il valore di visibilità non viene specificato durante la creazione di gruppi in Microsoft Graph, un gruppo di sicurezza viene creato come Privato per impostazione predefinita e il gruppo di Microsoft 365 è Pubblico. I gruppi assegnabili ai ruoli sono sempre Privati. Per altre informazioni, vedere Opzioni di visibilità dei gruppi. Ammette valori Null. | string |
writebackConfiguration | Specifica se un gruppo è configurato per il writeback delle proprietà dell'oggetto gruppo in Active Directory locale. Queste proprietà vengono usate quando il writeback del gruppo è configurato nel client di sincronizzazione Microsoft Entra Connect. | MicrosoftGraphGroupWritebackConfiguration |
MicrosoftGraphOnPremisesProvisioningError
Nome | Descrizione | valore |
---|---|---|
category | Categoria dell'errore di provisioning. Nota: attualmente esiste un solo valore possibile. Valore possibile: PropertyConflict : indica che un valore della proprietà non è univoco. Altri oggetti contengono lo stesso valore per la proprietà . | string |
occurredDateTime | Data e ora in cui si è verificato l'errore. | string |
propertyCausingError | Nome della proprietà della directory che causa l'errore. Valori possibili correnti: UserPrincipalName o ProxyAddress | string |
value | Valore della proprietà che causa l'errore. | string |
MicrosoftGraphServiceProvisioningError
Nome | Descrizione | valore |
---|---|---|
createdDateTime | Data e ora in cui si è verificato l'errore. | string |
isResolved | Indica se l'errore è stato partecipato. | bool |
serviceInstance | Istanza di servizio qualificata (ad esempio, 'SharePoint/Dublino') che ha pubblicato le informazioni sull'errore del servizio. | string |
MicrosoftGraphGroupWritebackConfiguration
Nome | Descrizione | valore |
---|---|---|
isEnabled | Indica se il writeback dei gruppi cloud in Active Directory locale è abilitato. Il valore predefinito è true per i gruppi di Microsoft 365 e false per i gruppi di sicurezza. | bool |
onPremisesGroupType | Indica il tipo di gruppo locale di destinazione in cui viene riscritto l'oggetto cloud. Ammette valori Null. I valori possibili sono: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. Se il gruppo cloud è un gruppo unificato (Microsoft 365), questa proprietà può essere una delle seguenti: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. I gruppi di sicurezza Microsoft Entra possono essere riscritto come universalSecurityGroup. Se isEnabled o l'impostazione del gruppo NewUnifiedGroupWritebackDefault è true, ma questa proprietà non è configurata in modo esplicito: i gruppi di Microsoft 365 vengono scritti come universalDistributionGroup per impostazione predefinita I gruppi di sicurezza vengono scritti come universalSecurityGroup per impostazione predefinita | string |