Gruppe aktualisieren

Artikel
08/20/2024

Namespace: microsoft.graph

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 die Version Selektor.

Aktualisiert die Eigenschaften eines Gruppenobjekts .

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service	US Government L4	US Government L5 (DOD)	China, betrieben von 21Vianet
✅	✅	✅	✅

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp	Berechtigungen mit den geringsten Berechtigungen	Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto)	Group.ReadWrite.All	Directory.ReadWrite.All
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt	Nicht unterstützt
Anwendung	Group.ReadWrite.All	Directory.ReadWrite.All

HTTP-Anforderung

PATCH /groups/{id}

Anforderungsheader

Name	Typ	Beschreibung
Authorization	string	Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie im Anforderungstext nur die Werte für die Eigenschaften an, die aktualisiert werden sollen. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.

In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.

Eigenschaft	Typ	Beschreibung
allowExternalSenders	Boolesch	Der Standardwert ist `false`. Gibt an, ob Personen außerhalb der Organisation Nachrichten an die Gruppe senden können.
assignedLabels	assignedLabel-Sammlung	Die Liste der Vertraulichkeitsbezeichnungspaare (Bezeichnungs-ID, Bezeichnungsname), die einer Office 365-Gruppe zugeordnet sind. Diese Eigenschaft kann nur in delegierten Szenarien aktualisiert werden, in denen der Aufrufer sowohl die Microsoft Graph-Berechtigung als auch eine unterstützte Administratorrolle benötigt.
autoSubscribeNewMembers	Boolesch	Der Standardwert ist `false`. Gibt an, ob neu zur Gruppe hinzugefügte Mitglieder automatisch für E-Mail-Benachrichtigungen abonniert werden. autoSubscribeNewMembers kann nicht `true` sein, wenn subscriptionEnabled auf der Gruppe auf `false` festgelegt ist.
description	String	Eine optionale Beschreibung für die Gruppe.
displayName	Zeichenfolge	Der Anzeigename der Gruppe. Diese Eigenschaft ist beim Erstellen einer Gruppe erforderlich und kann bei Updates nicht deaktiviert werden.
mailNickname	String	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 darf nur Zeichen im ASCII-Zeichensatz 0 bis 127 mit Ausnahme der folgenden enthalten: `@ () \ [] " ; : . <> , SPACE`.
preferredDataLocation	String	Der bevorzugte Datenspeicherort für die Microsoft 365-Gruppe. Um diese Eigenschaft zu aktualisieren, muss dem aufrufenden Benutzer mindestens eine der folgenden Microsoft Entra Rollen zugewiesen sein: Benutzerkontoadministrator Verzeichnisschreibberechtigter Exchange-Administrator SharePoint-Administrator Weitere Informationen zu dieser Eigenschaft finden Sie unter OneDrive Online Multi-Geo.
securityEnabled	Boolean	Gibt an, ob es sich bei der Gruppe um eine Sicherheitsgruppe handelt, einschließlich Microsoft 365-Gruppen.
uniqueName	Zeichenfolge	Der eindeutige Bezeichner, der einer Gruppe zugewiesen und als Alternativer Schlüssel verwendet werden kann. Kann nur aktualisiert werden, wenn `null` und nach dem Festlegen unveränderlich ist.
visibility	String	Gibt die Sichtbarkeit einer Microsoft 365-Gruppe an. Die folgenden Werte sind möglich: Private, Public oder leer (als öffentlich interpretiert).
writebackConfiguration	groupWritebackConfiguration	Gibt an, ob eine Gruppe so konfiguriert ist, dass Gruppenobjekteigenschaften in das lokale Active Directory zurückgeschrieben werden. Diese Eigenschaften werden verwendet, wenn das Gruppenrückschreiben im Microsoft Entra Connect-Synchronisierungsclient konfiguriert ist.

Wichtig

Um die folgenden Eigenschaften zu aktualisieren, müssen Sie sie in ihrer eigenen PATCH-Anforderung angeben, ohne die anderen in der vorherigen Tabelle aufgeführten Eigenschaften einzufügen: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.
Nur eine Teilmenge der Gruppen-API, die sich auf die Hauptgruppenverwaltung und -verwaltung bezieht, unterstützt Anwendungs- und delegierte Berechtigungen. Alle anderen Mitglieder der Gruppen-API, einschließlich der Aktualisierung von autoSubscribeNewMembers, unterstützen nur delegierte Berechtigungen.
Die Regeln für die Aktualisierung von E-Mail-aktivierten Sicherheitsgruppen in Microsoft Exchange Server können komplex sein. Weitere Informationen finden Sie unter Verwalten von E-Mail-aktivierten Sicherheitsgruppen in Exchange Server.
Anwendungsberechtigungen werden beim Aktualisieren von assignedLabels nicht unterstützt.

Erweiterungen und zugehörige Daten verwalten

Diese API verwenden, um das Verzeichnis, Schema und offene Erweiterungen und ihre Daten für Gruppen wie folgt zu verwalten:

Hinzufügen, Aktualisieren und Speichern von Daten in den Erweiterungen für eine vorhandene Gruppe.
Bei Verzeichnis und Schemaerweiterungen alle gespeicherten Daten entfernen, indem Sie den Wert der benutzerdefinierten Erweiterungseigenschaft auf null. Für offene Erweiterungen die API zum Löschen offener Erweiterungen verwenden.

Antwort

Bei Erfolg wird diese Methode einen 204 No Content-Antwortcode zurückgeben, mit Ausnahme eines 200 OK-Antwortcodes beim Aktualisieren der folgenden Eigenschaften: allowExternalSenders, autoSubscribeNewMembers, hideFromAddressLists, hideFromOutlookClients, isSubscribedByMail, unseenCount.

Beispiele

Beispiel 1: Aktualisieren des Anzeigenamens und der Beschreibung einer Gruppe

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

PATCH https://graph.microsoft.com/beta/groups/0d09007d-45b2-458c-b180-880dde3a302e
Content-type: application/json

{
   "description":"Contoso Life v2.0",
   "displayName":"Contoso Life Renewed"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Group
{
	Description = "Contoso Life v2.0",
	DisplayName = "Contoso Life Renewed",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Groups["{group-id}"].PatchAsync(requestBody);

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



mgc-beta groups patch --group-id {group-id} --body '{\
   "description":"Contoso Life v2.0",\
   "displayName":"Contoso Life Renewed"\
}\
'

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewGroup()
description := "Contoso Life v2.0"
requestBody.SetDescription(&description) 
displayName := "Contoso Life Renewed"
requestBody.SetDisplayName(&displayName) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
groups, err := graphClient.Groups().ByGroupId("group-id").Patch(context.Background(), requestBody, nil)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
group.setDescription("Contoso Life v2.0");
group.setDisplayName("Contoso Life Renewed");
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
   description: 'Contoso Life v2.0',
   displayName: 'Contoso Life Renewed'
};

await client.api('/groups/0d09007d-45b2-458c-b180-880dde3a302e')
	.version('beta')
	.update(group);

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Group;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Group();
$requestBody->setDescription('Contoso Life v2.0');
$requestBody->setDisplayName('Contoso Life Renewed');

$result = $graphServiceClient->groups()->byGroupId('group-id')->patch($requestBody)->wait();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


Import-Module Microsoft.Graph.Beta.Groups

$params = @{
	description = "Contoso Life v2.0"
	displayName = "Contoso Life Renewed"
}

Update-MgBetaGroup -GroupId $groupId -BodyParameter $params

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.group import Group
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Group(
	description = "Contoso Life v2.0",
	display_name = "Contoso Life Renewed",
)

result = await graph_client.groups.by_group_id('group-id').patch(request_body)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content

Beispiel 2: Anwenden einer Vertraulichkeitsbezeichnung auf eine Microsoft 365-Gruppe

Anforderung

Sie können die ID der Bezeichnung abrufen, die Sie auf eine Microsoft 365-Gruppe anwenden möchten, indem Sie die Listenbezeichnung verwenden. Anschließend können Sie die assignedLabels-Eigenschaft der Gruppe mit der Bezeichnungs-ID aktualisieren.

Anmerkung: Die Verwendung dieser API zum Anwenden von Vertraulichkeitsbezeichnungen auf Microsoft 365-Gruppen wird nur für Szenarien mit delegierten Berechtigungen unterstützt.

PATCH https://graph.microsoft.com/beta/groups/{id}
Content-type: application/json

{
  "assignedLabels":
  [
    {
        "labelId" : "45cd0c48-c540-4358-ad79-a3658cdc5b88"
    }
  ]
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Group
{
	AssignedLabels = new List<AssignedLabel>
	{
		new AssignedLabel
		{
			LabelId = "45cd0c48-c540-4358-ad79-a3658cdc5b88",
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Groups["{group-id}"].PatchAsync(requestBody);

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



mgc-beta groups patch --group-id {group-id} --body '{\
  "assignedLabels":\
  [\
    {\
        "labelId" : "45cd0c48-c540-4358-ad79-a3658cdc5b88"\
    }\
  ]\
}\
'

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewGroup()


assignedLabel := graphmodels.NewAssignedLabel()
labelId := "45cd0c48-c540-4358-ad79-a3658cdc5b88"
assignedLabel.SetLabelId(&labelId) 

assignedLabels := []graphmodels.AssignedLabelable {
	assignedLabel,
}
requestBody.SetAssignedLabels(assignedLabels)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
groups, err := graphClient.Groups().ByGroupId("group-id").Patch(context.Background(), requestBody, nil)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
LinkedList<AssignedLabel> assignedLabels = new LinkedList<AssignedLabel>();
AssignedLabel assignedLabel = new AssignedLabel();
assignedLabel.setLabelId("45cd0c48-c540-4358-ad79-a3658cdc5b88");
assignedLabels.add(assignedLabel);
group.setAssignedLabels(assignedLabels);
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
  assignedLabels: 
  [
    {
        labelId: '45cd0c48-c540-4358-ad79-a3658cdc5b88'
    }
  ]
};

await client.api('/groups/{id}')
	.version('beta')
	.update(group);

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Group;
use Microsoft\Graph\Beta\Generated\Models\AssignedLabel;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new Group();
$assignedLabelsAssignedLabel1 = new AssignedLabel();
$assignedLabelsAssignedLabel1->setLabelId('45cd0c48-c540-4358-ad79-a3658cdc5b88');
$assignedLabelsArray []= $assignedLabelsAssignedLabel1;
$requestBody->setAssignedLabels($assignedLabelsArray);


$result = $graphServiceClient->groups()->byGroupId('group-id')->patch($requestBody)->wait();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


Import-Module Microsoft.Graph.Beta.Groups

$params = @{
	assignedLabels = @(
		@{
			labelId = "45cd0c48-c540-4358-ad79-a3658cdc5b88"
		}
	)
}

Update-MgBetaGroup -GroupId $groupId -BodyParameter $params

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.group import Group
from msgraph_beta.generated.models.assigned_label import AssignedLabel
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Group(
	assigned_labels = [
		AssignedLabel(
			label_id = "45cd0c48-c540-4358-ad79-a3658cdc5b88",
		),
	],
)

result = await graph_client.groups.by_group_id('group-id').patch(request_body)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content

Freigeben über

Gruppe aktualisieren

Berechtigungen

HTTP-Anforderung

Anforderungsheader

Anforderungstext

Erweiterungen und zugehörige Daten verwalten

Antwort

Beispiele

Beispiel 1: Aktualisieren des Anzeigenamens und der Beschreibung einer Gruppe

Anforderung

Antwort

Beispiel 2: Anwenden einer Vertraulichkeitsbezeichnung auf eine Microsoft 365-Gruppe

Anforderung

Antwort

Feedback

Zusätzliche Ressourcen

Freigeben über

Gruppe aktualisieren

Berechtigungen

HTTP-Anforderung

Anforderungsheader

Anforderungstext

Erweiterungen und zugehörige Daten verwalten

Antwort

Beispiele

Beispiel 1: Aktualisieren des Anzeigenamens und der Beschreibung einer Gruppe

Anforderung

Antwort

Beispiel 2: Anwenden einer Vertraulichkeitsbezeichnung auf eine Microsoft 365-Gruppe

Anforderung

Antwort

Verwandte Inhalte

Feedback

Zusätzliche Ressourcen