Hinzufügen von benutzerdefinierten Daten zu Gruppen mithilfe von Schemaerweiterungen

Artikel
02/07/2024

In diesem Tutorial erfahren Sie, wie Sie Schemaerweiterungen verwenden.

Stellen Sie sich vor, Sie sind Entwickler in einem Learning Management Software-Unternehmen namens Bellows College , das Schulungskurse und Materialien für Unternehmen erstellt. Sie verwenden die Zusammenarbeitserfahrung von Microsoft 365-Gruppen, um Kursinhalte bereitzustellen und Übungen zwischen Teilnehmern sowohl für Onlinekurse als auch für kursleitergeführte Kurse aufzuzeichnen. Sie möchten die microsoft 365-Gruppen, die für Schulungskurse verwendet werden, leicht als Schulungskurse identifizierbar machen, sodass andere Entwickler Ihre Gruppen entdecken und umfassende Erfahrungen auf Grundlage Ihrer Lernkurse erstellen können.

Für dieses Szenario wird in diesem Artikel Folgendes beschrieben:

Ermitteln Sie die verfügbaren Schemaerweiterungsdefinitionen, die Sie verwenden können.
Registrieren einer Schemaerweiterungsdefinition, die auf Gruppen für Schulungskurse abzielt
Erstellen Sie eine neue Gruppe mit benutzerdefinierten Daten basierend auf der schemaerweiterungsdefinition, die Sie registriert haben.
Hinzufügen, Aktualisieren oder Entfernen von benutzerdefinierten Daten in einer vorhandenen Gruppe basierend auf einer Schemaerweiterungsdefinition
Liest eine Gruppe und die Erweiterungsdaten.
Löschen Sie die Schemaerweiterungsdefinition und die Erweiterungsdaten.

Hinweis

Neben Gruppen werden auch Schemaerweiterungen unterstützt und können für andere Ressourcentypen verwaltet werden.

Voraussetzungen

Um die Schritte in diesem Artikel zu reproduzieren, benötigen Sie die folgenden Berechtigungen:

Melden Sie sich bei einem API-Client wie Graph Explorer an.
Erteilen Sie der App die delegierten Berechtigungen Group.ReadWrite.All und Application.ReadWrite.All für den angemeldeten Benutzer.
Seien Sie der Besitzer einer Anwendung, der Sie den Besitz der Schemaerweiterungsdefinition in diesem Tutorial zuweisen. In diesem Tutorial heißt die Anwendung extensions-application und verfügt über appIdd1e6f196-fca3-48ad-8cd3-1a98e3bd46d2.

Schritt 1. Anzeigen verfügbarer Schemaerweiterungen

Als Entwickler sollten Sie zunächst alle vorhandenen Schemaerweiterungsdefinitionen wiederverwenden, wenn sie für den Zweck geeignet sind. Im folgenden Beispiel fragen Sie Schemaerweiterungen mit dem Namen (durch die ID) bellowscollege_coursesab. Angenommen, die Antwort zeigt, dass es keine Schemaerweiterungen gibt, die in Ihrem Mandanten benannt bellowscollege_courses sind.

Anforderung

GET https://graph.microsoft.com/v1.0/schemaExtensions?$filter=id eq 'bellowscollege_courses'


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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.SchemaExtensions.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "id eq 'bellowscollege_courses'";
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc schema-extensions list --filter "id eq 'bellowscollege_courses'"



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphschemaextensions "github.com/microsoftgraph/msgraph-sdk-go/schemaextensions"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestFilter := "id eq 'bellowscollege_courses'"

requestParameters := &graphschemaextensions.SchemaExtensionsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphschemaextensions.SchemaExtensionsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

schemaExtensions, err := graphClient.SchemaExtensions().Get(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SchemaExtensionCollectionResponse result = graphClient.schemaExtensions().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "id eq 'bellowscollege_courses'";
});


const options = {
	authProvider,
};

const client = Client.init(options);

let schemaExtensions = await client.api('/schemaExtensions')
	.filter('id eq \'bellowscollege_courses\'')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\SchemaExtensions\SchemaExtensionsRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new SchemaExtensionsRequestBuilderGetRequestConfiguration();
$queryParameters = SchemaExtensionsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "id eq 'bellowscollege_courses'";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->schemaExtensions()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.SchemaExtensions

Get-MgSchemaExtension -Filter "id eq 'bellowscollege_courses'"


from msgraph import GraphServiceClient
from msgraph.generated.schema_extensions.schema_extensions_request_builder import SchemaExtensionsRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = SchemaExtensionsRequestBuilder.SchemaExtensionsRequestBuilderGetQueryParameters(
		filter = "id eq 'bellowscollege_courses'",
)

request_configuration = SchemaExtensionsRequestBuilder.SchemaExtensionsRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.schema_extensions.get(request_configuration = request_configuration)

Antwort

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#schemaExtensions",
    "@microsoft.graph.tips": "Use $select to choose only the properties your app needs, as this can lead to performance improvements. For example: GET schemaExtensions?$select=description,owner",
    "value": []
}

Sie können auch nach der ID als Pfadparameter wie folgt abfragen: GET https://graph.microsoft.com/v1.0/schemaExtensions/bellowscollege_courses. Wenn keine Schemaerweiterungen vorhanden sind, die mit der ID übereinstimmen, lautet 404 Not Founddie Antwort .

Schritt 2. Registrieren einer Schemaerweiterungsdefinition

Sie möchten eine neue Erweiterungsdefinition für Schulungskurse für die Gruppenressource erstellen und registrieren. Geben Sie die folgenden Eigenschaften an:

id: Geben Sie eine Zeichenfolge für diese Eigenschaft auf eine von zwei Arten an:
- Option 1: Verketten Sie einen überprüften Vanity-Domänennamen für Ihren Mandanten mit einem Namen für die Schemaerweiterung. Wenn die Domäne beispielsweise ist bellowscollege.comund der Name der Schemaerweiterung ist courses, können Sie die IDbellowscollege_courses verwenden.
- Option 2: Eine alternative Möglichkeit besteht darin, nur einen Schemanamen anzugeben, z courses. B. , und Microsoft Graph die ID automatisch generieren zu lassen, indem dem angegebenen Namen eine zufällige alphanumerische Zeichenfolge vorangestellt wird.
  
  Diese ID wird zum Namen der Schemaerweiterungseigenschaft für eine Gruppe.
description
targetTypes: Geben Sie die Ressourcentypen an, auf die die Schemaerweiterung angewendet werden kann. In diesem Beispiel ist Groupder Ressourcentyp . Sie können weitere Ressourcentypen hinzufügen, indem Sie die Schemaerweiterungsdefinition später aktualisieren.
properties: Geben Sie die benutzerdefinierten Eigenschaften an, aus denen das Schema besteht. Geben Sie in diesem Beispiel die courseIdbenutzerdefinierten Eigenschaften , courseName und courseType sowie deren Typen an. Nach dem Erstellen der Schemaerweiterungsdefinition sind nur additive Änderungen zulässig.
owner: Geben Sie die Anwendung an, die besitzer der Schemaerweiterungsdefinition ist. Wenn Sie dieses Beispiel von einer App aus ausführen, der Sie nicht als Besitzer zugewiesen sind, geben Sie die appId der Anwendung an, die Ihnen in der Eigenschaft owner zugewiesen ist.

Anforderung

POST https://graph.microsoft.com/v1.0/schemaExtensions
Content-type: application/json

{
    "id": "bellowscollege_courses",
    "description": "Bellows College training courses extensions",
    "targetTypes": [
        "Group"
    ],
    "owner": "d1e6f196-fca3-48ad-8cd3-1a98e3bd46d2",
    "properties": [
        {
            "name": "courseId",
            "type": "Integer"
        },
        {
            "name": "courseName",
            "type": "String"
        },
        {
            "name": "courseType",
            "type": "String"
        }
    ]
}


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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new SchemaExtension
{
	Id = "bellowscollege_courses",
	Description = "Bellows College training courses extensions",
	TargetTypes = new List<string>
	{
		"Group",
	},
	Owner = "d1e6f196-fca3-48ad-8cd3-1a98e3bd46d2",
	Properties = new List<ExtensionSchemaProperty>
	{
		new ExtensionSchemaProperty
		{
			Name = "courseId",
			Type = "Integer",
		},
		new ExtensionSchemaProperty
		{
			Name = "courseName",
			Type = "String",
		},
		new ExtensionSchemaProperty
		{
			Name = "courseType",
			Type = "String",
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.SchemaExtensions.PostAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc schema-extensions create --body '{\
    "id": "bellowscollege_courses",\
    "description": "Bellows College training courses extensions",\
    "targetTypes": [\
        "Group"\
    ],\
    "owner": "d1e6f196-fca3-48ad-8cd3-1a98e3bd46d2",\
    "properties": [\
        {\
            "name": "courseId",\
            "type": "Integer"\
        },\
        {\
            "name": "courseName",\
            "type": "String"\
        },\
        {\
            "name": "courseType",\
            "type": "String"\
        }\
    ]\
}\
'



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewSchemaExtension()
id := "bellowscollege_courses"
requestBody.SetId(&id) 
description := "Bellows College training courses extensions"
requestBody.SetDescription(&description) 
targetTypes := []string {
	"Group",
}
requestBody.SetTargetTypes(targetTypes)
owner := "d1e6f196-fca3-48ad-8cd3-1a98e3bd46d2"
requestBody.SetOwner(&owner) 


extensionSchemaProperty := graphmodels.NewExtensionSchemaProperty()
name := "courseId"
extensionSchemaProperty.SetName(&name) 
type := "Integer"
extensionSchemaProperty.SetType(&type) 
extensionSchemaProperty1 := graphmodels.NewExtensionSchemaProperty()
name := "courseName"
extensionSchemaProperty1.SetName(&name) 
type := "String"
extensionSchemaProperty1.SetType(&type) 
extensionSchemaProperty2 := graphmodels.NewExtensionSchemaProperty()
name := "courseType"
extensionSchemaProperty2.SetName(&name) 
type := "String"
extensionSchemaProperty2.SetType(&type) 

properties := []graphmodels.ExtensionSchemaPropertyable {
	extensionSchemaProperty,
	extensionSchemaProperty1,
	extensionSchemaProperty2,
}
requestBody.SetProperties(properties)

schemaExtensions, err := graphClient.SchemaExtensions().Post(context.Background(), requestBody, nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SchemaExtension schemaExtension = new SchemaExtension();
schemaExtension.setId("bellowscollege_courses");
schemaExtension.setDescription("Bellows College training courses extensions");
LinkedList<String> targetTypes = new LinkedList<String>();
targetTypes.add("Group");
schemaExtension.setTargetTypes(targetTypes);
schemaExtension.setOwner("d1e6f196-fca3-48ad-8cd3-1a98e3bd46d2");
LinkedList<ExtensionSchemaProperty> properties = new LinkedList<ExtensionSchemaProperty>();
ExtensionSchemaProperty extensionSchemaProperty = new ExtensionSchemaProperty();
extensionSchemaProperty.setName("courseId");
extensionSchemaProperty.setType("Integer");
properties.add(extensionSchemaProperty);
ExtensionSchemaProperty extensionSchemaProperty1 = new ExtensionSchemaProperty();
extensionSchemaProperty1.setName("courseName");
extensionSchemaProperty1.setType("String");
properties.add(extensionSchemaProperty1);
ExtensionSchemaProperty extensionSchemaProperty2 = new ExtensionSchemaProperty();
extensionSchemaProperty2.setName("courseType");
extensionSchemaProperty2.setType("String");
properties.add(extensionSchemaProperty2);
schemaExtension.setProperties(properties);
SchemaExtension result = graphClient.schemaExtensions().post(schemaExtension);


const options = {
	authProvider,
};

const client = Client.init(options);

const schemaExtension = {
    id: 'bellowscollege_courses',
    description: 'Bellows College training courses extensions',
    targetTypes: [
        'Group'
    ],
    owner: 'd1e6f196-fca3-48ad-8cd3-1a98e3bd46d2',
    properties: [
        {
            name: 'courseId',
            type: 'Integer'
        },
        {
            name: 'courseName',
            type: 'String'
        },
        {
            name: 'courseType',
            type: 'String'
        }
    ]
};

await client.api('/schemaExtensions')
	.post(schemaExtension);


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\SchemaExtension;
use Microsoft\Graph\Generated\Models\ExtensionSchemaProperty;


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

$requestBody = new SchemaExtension();
$requestBody->setId('bellowscollege_courses');
$requestBody->setDescription('Bellows College training courses extensions');
$requestBody->setTargetTypes(['Group', 	]);
$requestBody->setOwner('d1e6f196-fca3-48ad-8cd3-1a98e3bd46d2');
$propertiesExtensionSchemaProperty1 = new ExtensionSchemaProperty();
$propertiesExtensionSchemaProperty1->setName('courseId');
$propertiesExtensionSchemaProperty1->setType('Integer');
$propertiesArray []= $propertiesExtensionSchemaProperty1;
$propertiesExtensionSchemaProperty2 = new ExtensionSchemaProperty();
$propertiesExtensionSchemaProperty2->setName('courseName');
$propertiesExtensionSchemaProperty2->setType('String');
$propertiesArray []= $propertiesExtensionSchemaProperty2;
$propertiesExtensionSchemaProperty3 = new ExtensionSchemaProperty();
$propertiesExtensionSchemaProperty3->setName('courseType');
$propertiesExtensionSchemaProperty3->setType('String');
$propertiesArray []= $propertiesExtensionSchemaProperty3;
$requestBody->setProperties($propertiesArray);


$result = $graphServiceClient->schemaExtensions()->post($requestBody)->wait();


Import-Module Microsoft.Graph.SchemaExtensions

$params = @{
	id = "bellowscollege_courses"
	description = "Bellows College training courses extensions"
	targetTypes = @(
	"Group"
)
owner = "d1e6f196-fca3-48ad-8cd3-1a98e3bd46d2"
properties = @(
	@{
		name = "courseId"
		type = "Integer"
	}
	@{
		name = "courseName"
		type = "String"
	}
	@{
		name = "courseType"
		type = "String"
	}
)
}

New-MgSchemaExtension -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.schema_extension import SchemaExtension
from msgraph.generated.models.extension_schema_property import ExtensionSchemaProperty

graph_client = GraphServiceClient(credentials, scopes)

request_body = SchemaExtension(
	id = "bellowscollege_courses",
	description = "Bellows College training courses extensions",
	target_types = [
		"Group",
	],
	owner = "d1e6f196-fca3-48ad-8cd3-1a98e3bd46d2",
	properties = [
		ExtensionSchemaProperty(
			name = "courseId",
			type = "Integer",
		),
		ExtensionSchemaProperty(
			name = "courseName",
			type = "String",
		),
		ExtensionSchemaProperty(
			name = "courseType",
			type = "String",
		),
	],
)

result = await graph_client.schema_extensions.post(request_body)

Antwort

Das folgende Beispiel zeigt die Antwort.

In der Antwort ist InDevelopmentder standard anfängliche status der Schemaerweiterung . Während Sie die Erweiterung entwickeln, können Sie sie in diesem status beibehalten, in dem nur die App, die sie erstellt hat, sie mit zusätzlichen Änderungen aktualisieren oder löschen kann. Wenn Sie bereit sind, die Erweiterung für die Verwendung durch andere Apps freizugeben, legen Sie status auf Verfügbar fest.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#schemaExtensions/$entity",
    "id": "bellowscollege_courses",
    "description": "Bellows College training courses extensions",
    "targetTypes": [
        "Group"
    ],
    "status": "InDevelopment",
    "owner": "d1e6f196-fca3-48ad-8cd3-1a98e3bd46d2",
    "properties": [
        {
            "name": "courseId",
            "type": "Integer"
        },
        {
            "name": "courseName",
            "type": "String"
        },
        {
            "name": "courseType",
            "type": "String"
        }
    ]
}

Schritt 3: Erweitern einer Gruppe mit benutzerdefinierten Daten

Sie können eine Gruppe entweder während der Gruppenerstellung oder durch Aktualisieren einer vorhandenen Gruppe mit benutzerdefinierten Daten erweitern.

Option 1: Erstellen einer neuen Gruppe mit erweiterten Daten

Die folgende Anforderung erstellt eine neue Gruppe und verwendet die bellowscollege_courses Schemaerweiterung, um die Gruppe mit benutzerdefinierten Daten zu erweitern. Wenn Sie über eine vorhandene Gruppe verfügen, können Sie sie auch mit benutzerdefinierten Daten erweitern, indem Sie die Gruppe mit den Erweiterungsdaten aktualisieren.

Die Antwort Spiegel keine Datenerweiterungen zurück. Sie müssen die Erweiterung mithilfe eines GET /group/{id} Vorgangs explizit $select anhand des Namens angeben.

Anforderung

POST https://graph.microsoft.com/v1.0/groups
Content-type: application/json

{
    "displayName": "New Managers March 2024",
    "description": "New Managers training course for March 2024",
    "groupTypes": [
        "Unified"
    ],
    "mailEnabled": true,
    "mailNickname": "newMan202403",
    "securityEnabled": false,
    "bellowscollege_courses": {
        "courseId": "123",
        "courseName": "New Managers",
        "courseType": "Online"
    }
}


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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Group
{
	DisplayName = "New Managers March 2024",
	Description = "New Managers training course for March 2024",
	GroupTypes = new List<string>
	{
		"Unified",
	},
	MailEnabled = true,
	MailNickname = "newMan202403",
	SecurityEnabled = false,
	AdditionalData = new Dictionary<string, object>
	{
		{
			"bellowscollege_courses" , new 
			{
				CourseId = "123",
				CourseName = "New Managers",
				CourseType = "Online",
			}
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Groups.PostAsync(requestBody);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups create --body '{\
    "displayName": "New Managers March 2024",\
    "description": "New Managers training course for March 2024",\
    "groupTypes": [\
        "Unified"\
    ],\
    "mailEnabled": true,\
    "mailNickname": "newMan202403",\
    "securityEnabled": false,\
    "bellowscollege_courses": {\
        "courseId": "123",\
        "courseName": "New Managers",\
        "courseType": "Online"\
    }\
}\
'



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()
displayName := "New Managers March 2024"
requestBody.SetDisplayName(&displayName) 
description := "New Managers training course for March 2024"
requestBody.SetDescription(&description) 
groupTypes := []string {
	"Unified",
}
requestBody.SetGroupTypes(groupTypes)
mailEnabled := true
requestBody.SetMailEnabled(&mailEnabled) 
mailNickname := "newMan202403"
requestBody.SetMailNickname(&mailNickname) 
securityEnabled := false
requestBody.SetSecurityEnabled(&securityEnabled) 
additionalData := map[string]interface{}{
bellowscollege_courses := graphmodels.New()
courseId := "123"
bellowscollege_courses.SetCourseId(&courseId) 
courseName := "New Managers"
bellowscollege_courses.SetCourseName(&courseName) 
courseType := "Online"
bellowscollege_courses.SetCourseType(&courseType) 
	requestBody.SetBellowscollege_courses(bellowscollege_courses)
}
requestBody.SetAdditionalData(additionalData)

groups, err := graphClient.Groups().Post(context.Background(), requestBody, nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
group.setDisplayName("New Managers March 2024");
group.setDescription("New Managers training course for March 2024");
LinkedList<String> groupTypes = new LinkedList<String>();
groupTypes.add("Unified");
group.setGroupTypes(groupTypes);
group.setMailEnabled(true);
group.setMailNickname("newMan202403");
group.setSecurityEnabled(false);
HashMap<String, Object> additionalData = new HashMap<String, Object>();
 bellowscollegeCourses = new ();
bellowscollegeCourses.setCourseId("123");
bellowscollegeCourses.setCourseName("New Managers");
bellowscollegeCourses.setCourseType("Online");
additionalData.put("bellowscollege_courses", bellowscollegeCourses);
group.setAdditionalData(additionalData);
Group result = graphClient.groups().post(group);


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
    displayName: 'New Managers March 2024',
    description: 'New Managers training course for March 2024',
    groupTypes: [
        'Unified'
    ],
    mailEnabled: true,
    mailNickname: 'newMan202403',
    securityEnabled: false,
    bellowscollege_courses: {
        courseId: '123',
        courseName: 'New Managers',
        courseType: 'Online'
    }
};

await client.api('/groups')
	.post(group);


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


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

$requestBody = new Group();
$requestBody->setDisplayName('New Managers March 2024');
$requestBody->setDescription('New Managers training course for March 2024');
$requestBody->setGroupTypes(['Unified', 	]);
$requestBody->setMailEnabled(true);
$requestBody->setMailNickname('newMan202403');
$requestBody->setSecurityEnabled(false);
$additionalData = [
	'bellowscollege_courses' => [
		'courseId' => '123',
		'courseName' => 'New Managers',
		'courseType' => 'Online',
	],
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->groups()->post($requestBody)->wait();


Import-Module Microsoft.Graph.Groups

$params = @{
	displayName = "New Managers March 2024"
	description = "New Managers training course for March 2024"
	groupTypes = @(
	"Unified"
)
mailEnabled = $true
mailNickname = "newMan202403"
securityEnabled = $false
bellowscollege_courses = @{
	courseId = "123"
	courseName = "New Managers"
	courseType = "Online"
}
}

New-MgGroup -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.group import Group

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	display_name = "New Managers March 2024",
	description = "New Managers training course for March 2024",
	group_types = [
		"Unified",
	],
	mail_enabled = True,
	mail_nickname = "newMan202403",
	security_enabled = False,
	additional_data = {
			"bellowscollege_courses" : {
					"course_id" : "123",
					"course_name" : "New Managers",
					"course_type" : "Online",
			},
	}
)

result = await graph_client.groups.post(request_body)

Antwort

Das folgende Beispiel zeigt die Antwort. Die Antwort enthält die neue Erweiterung nicht. Sie müssen die Erweiterung mithilfe eines GET /group/{id} Vorgangs explizit $select anhand des Namens angeben.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups/$entity",
    "id": "8fb45944-4085-449f-b95d-f7dd74a1b081",
    "createdDateTime": "2024-01-24T09:09:03Z",
    "description": "New Managers training course for March 2024",
    "displayName": "New Managers March 2024",
    "groupTypes": [
        "Unified"
    ],
    "mail": "newMan202403@bellowscollege.com",
    "mailEnabled": true,
    "mailNickname": "newMan202403"
}

Option 2: Aktualisieren einer vorhandenen Gruppe mit erweiterten Daten

Wenn Sie über eine vorhandene Gruppe verfügen, können Sie diese auch wie folgt mit benutzerdefinierten Daten erweitern. Die Anforderung gibt eine 204 No Content Antwort zurück.

PATCH https://graph.microsoft.com/v1.0/groups/dfc8016f-db97-4c47-a582-49cb8f849355
Content-type: application/json

{
    "bellowscollege_courses": {
        "courseId": "123",
        "courseName": "New Managers",
        "courseType": "Online"
    }
}


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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Group
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"bellowscollege_courses" , new 
			{
				CourseId = "123",
				CourseName = "New Managers",
				CourseType = "Online",
			}
		},
	},
};

// 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);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups patch --group-id {group-id} --body '{\
    "bellowscollege_courses": {\
        "courseId": "123",\
        "courseName": "New Managers",\
        "courseType": "Online"\
    }\
}\
'



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()
additionalData := map[string]interface{}{
bellowscollege_courses := graphmodels.New()
courseId := "123"
bellowscollege_courses.SetCourseId(&courseId) 
courseName := "New Managers"
bellowscollege_courses.SetCourseName(&courseName) 
courseType := "Online"
bellowscollege_courses.SetCourseType(&courseType) 
	requestBody.SetBellowscollege_courses(bellowscollege_courses)
}
requestBody.SetAdditionalData(additionalData)

groups, err := graphClient.Groups().ByGroupId("group-id").Patch(context.Background(), requestBody, nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
 bellowscollegeCourses = new ();
bellowscollegeCourses.setCourseId("123");
bellowscollegeCourses.setCourseName("New Managers");
bellowscollegeCourses.setCourseType("Online");
additionalData.put("bellowscollege_courses", bellowscollegeCourses);
group.setAdditionalData(additionalData);
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
    bellowscollege_courses: {
        courseId: '123',
        courseName: 'New Managers',
        courseType: 'Online'
    }
};

await client.api('/groups/dfc8016f-db97-4c47-a582-49cb8f849355')
	.update(group);


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


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

$requestBody = new Group();
$additionalData = [
	'bellowscollege_courses' => [
		'courseId' => '123',
		'courseName' => 'New Managers',
		'courseType' => 'Online',
	],
];
$requestBody->setAdditionalData($additionalData);

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


Import-Module Microsoft.Graph.Groups

$params = @{
	bellowscollege_courses = @{
		courseId = "123"
		courseName = "New Managers"
		courseType = "Online"
	}
}

Update-MgGroup -GroupId $groupId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.group import Group

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	additional_data = {
			"bellowscollege_courses" : {
					"course_id" : "123",
					"course_name" : "New Managers",
					"course_type" : "Online",
			},
	}
)

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

Schritt 4. Aktualisieren von benutzerdefinierten Daten in einer Gruppe

Die folgende Anforderung aktualisiert die courseType-Eigenschaft in der bellowscollege_courses Erweiterung für die Gruppe in Hybrid. Obwohl Sie nur die courseType-Eigenschaft aktualisieren möchten, müssen Sie auch die anderen Eigenschaften und ihre vorhandenen Werte in den Anforderungstext einschließen. Andernfalls legt Microsoft Graph sie auf fest null und entfernt ihre Daten.

Die folgende Anforderung gibt eine 204 No Content Antwort zurück.

PATCH https://graph.microsoft.com/v1.0/groups/dfc8016f-db97-4c47-a582-49cb8f849355
Content-type: application/json

{
    "bellowscollege_courses": {
        "courseId": "123",
        "courseName": "New Managers",
        "courseType": "Hybrid"
    }
}


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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Group
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"bellowscollege_courses" , new 
			{
				CourseId = "123",
				CourseName = "New Managers",
				CourseType = "Hybrid",
			}
		},
	},
};

// 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);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups patch --group-id {group-id} --body '{\
    "bellowscollege_courses": {\
        "courseId": "123",\
        "courseName": "New Managers",\
        "courseType": "Hybrid"\
    }\
}\
'



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()
additionalData := map[string]interface{}{
bellowscollege_courses := graphmodels.New()
courseId := "123"
bellowscollege_courses.SetCourseId(&courseId) 
courseName := "New Managers"
bellowscollege_courses.SetCourseName(&courseName) 
courseType := "Hybrid"
bellowscollege_courses.SetCourseType(&courseType) 
	requestBody.SetBellowscollege_courses(bellowscollege_courses)
}
requestBody.SetAdditionalData(additionalData)

groups, err := graphClient.Groups().ByGroupId("group-id").Patch(context.Background(), requestBody, nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
 bellowscollegeCourses = new ();
bellowscollegeCourses.setCourseId("123");
bellowscollegeCourses.setCourseName("New Managers");
bellowscollegeCourses.setCourseType("Hybrid");
additionalData.put("bellowscollege_courses", bellowscollegeCourses);
group.setAdditionalData(additionalData);
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
    bellowscollege_courses: {
        courseId: '123',
        courseName: 'New Managers',
        courseType: 'Hybrid'
    }
};

await client.api('/groups/dfc8016f-db97-4c47-a582-49cb8f849355')
	.update(group);


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


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

$requestBody = new Group();
$additionalData = [
	'bellowscollege_courses' => [
		'courseId' => '123',
		'courseName' => 'New Managers',
		'courseType' => 'Hybrid',
	],
];
$requestBody->setAdditionalData($additionalData);

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


Import-Module Microsoft.Graph.Groups

$params = @{
	bellowscollege_courses = @{
		courseId = "123"
		courseName = "New Managers"
		courseType = "Hybrid"
	}
}

Update-MgGroup -GroupId $groupId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.group import Group

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	additional_data = {
			"bellowscollege_courses" : {
					"course_id" : "123",
					"course_name" : "New Managers",
					"course_type" : "Hybrid",
			},
	}
)

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

Schritt 5. Abrufen einer Gruppe und ihrer Erweiterungsdaten

Um die benutzerdefinierten Daten in einer Gruppe abzurufen, verwenden Sie $select , um die Erweiterung anhand des Namens einzuschließen.

Neben der Filterung nach der ID der Schemaerweiterung können Sie auch nach den Erweiterungseigenschaftswerten filtern. Im folgenden Beispiel wird nach der Gruppe gesucht, die über die bellowscollege_courses Erweiterung mit einem courseId Eigenschaftswert verfügt, der mit übereinstimmt 123, und ruft die Erweiterungsdaten sowie die displayName-, id- und description-Eigenschaften der Gruppe ab.

Anforderung

GET https://graph.microsoft.com/v1.0/groups?$filter=bellowscollege_courses/courseId eq '123'&$select=displayName,id,description,bellowscollege_courses


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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Groups.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "bellowscollege_courses/courseId eq '123'";
	requestConfiguration.QueryParameters.Select = new string []{ "displayName","id","description","bellowscollege_courses" };
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups list --filter "bellowscollege_courses/courseId eq '123'" --select "displayName,id,description,bellowscollege_courses"



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphgroups "github.com/microsoftgraph/msgraph-sdk-go/groups"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestFilter := "bellowscollege_courses/courseId eq '123'"

requestParameters := &graphgroups.GroupsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
	Select: [] string {"displayName","id","description","bellowscollege_courses"},
}
configuration := &graphgroups.GroupsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

groups, err := graphClient.Groups().Get(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

GroupCollectionResponse result = graphClient.groups().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "bellowscollege_courses/courseId eq '123'";
	requestConfiguration.queryParameters.select = new String []{"displayName", "id", "description", "bellowscollege_courses"};
});


const options = {
	authProvider,
};

const client = Client.init(options);

let groups = await client.api('/groups')
	.filter('bellowscollege_courses/courseId eq \'123\'')
	.select('displayName,id,description,bellowscollege_courses')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Groups\GroupsRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new GroupsRequestBuilderGetRequestConfiguration();
$queryParameters = GroupsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "bellowscollege_courses/courseId eq '123'";
$queryParameters->select = ["displayName","id","description","bellowscollege_courses"];
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->groups()->get($requestConfiguration)->wait();


Import-Module Microsoft.Graph.Groups

Get-MgGroup -Filter "bellowscollege_courses/courseId eq '123'" -Property "displayName,id,description,bellowscollege_courses"


from msgraph import GraphServiceClient
from msgraph.generated.groups.groups_request_builder import GroupsRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = GroupsRequestBuilder.GroupsRequestBuilderGetQueryParameters(
		filter = "bellowscollege_courses/courseId eq '123'",
		select = ["displayName","id","description","bellowscollege_courses"],
)

request_configuration = GroupsRequestBuilder.GroupsRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.groups.get(request_configuration = request_configuration)

Antwort

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups(displayName,id,description,bellowscollege_courses)",
    "value": [
        {
            "displayName": "New Managers March 2024",
            "id": "8fb45944-4085-449f-b95d-f7dd74a1b081",
            "description": "New Managers training course for March 2024",
            "bellowscollege_courses": {
                "@odata.type": "#microsoft.graph.ComplexExtensionValue",
                "courseType": "Hybrid",
                "courseName": "New Managers",
                "courseId": 123
            }
        }
    ]
}

Schritt 6: Löschen von Erweiterungsdaten und Schemaerweiterungsdefinition

Sie können eine Schemaerweiterungsdefinition löschen, wenn Sie sie nicht mehr benötigen. Wenn auf Ressourceninstanzen die Erweiterungseigenschaft angewendet wurde, werden durch das Löschen der Schemaerweiterungsdefinition die Erweiterungsdaten in den Ressourceninstanzen nicht gelöscht. Stattdessen sind die Erweiterungsdaten verfügbar, aber nicht mehr zugänglich. Sie können die Schemaerweiterungsdefinition mit der gleichen Konfiguration neu erstellen , wenn Sie die überprüfte Domäne für die Schemaerweiterungs-ID verwendet haben, um die Erweiterungsdaten löschen zu können.

Die folgende Anforderung löscht die bellowscollege_courses Schemaerweiterungseigenschaft und die zugehörigen Daten aus der Gruppe. Die Anforderung gibt eine 204 No Content Antwort zurück.

PATCH https://graph.microsoft.com/v1.0/groups/8fb45944-4085-449f-b95d-f7dd74a1b081

{
    "bellowscollege_courses": null
}


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

// Dependencies
using Microsoft.Graph.Models;

var requestBody = new Group
{
	AdditionalData = new Dictionary<string, object>
	{
		{
			"bellowscollege_courses" , null
		},
	},
};

// 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);


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups patch --group-id {group-id}



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewGroup()
additionalData := map[string]interface{}{
	bellowscollege_courses := null
requestBody.SetBellowscollege_courses(&bellowscollege_courses) 
}
requestBody.SetAdditionalData(additionalData)

groups, err := graphClient.Groups().ByGroupId("group-id").Patch(context.Background(), requestBody, nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Group group = new Group();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("bellowscollege_courses", null);
group.setAdditionalData(additionalData);
Group result = graphClient.groups().byGroupId("{group-id}").patch(group);


const options = {
	authProvider,
};

const client = Client.init(options);

const group = {
    bellowscollege_courses: null
};

await client.api('/groups/8fb45944-4085-449f-b95d-f7dd74a1b081')
	.update(group);


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


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

$requestBody = new Group();
$additionalData = [
	'bellowscollege_courses' => null,
];
$requestBody->setAdditionalData($additionalData);

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


Import-Module Microsoft.Graph.Groups

$params = @{
	bellowscollege_courses = $null
}

Update-MgGroup -GroupId $groupId -BodyParameter $params


from msgraph import GraphServiceClient
from msgraph.generated.models.group import Group

graph_client = GraphServiceClient(credentials, scopes)

request_body = Group(
	additional_data = {
			"bellowscollege_courses" : None,
	}
)

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

Die folgende Anforderung löscht die bellowscollege_courses Schemaerweiterungsdefinition. Die Anforderung gibt eine 204 No Content Antwort zurück.

DELETE https://graph.microsoft.com/v1.0/schemaExtensions/bellowscollege_courses


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

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


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc schema-extensions delete --schema-extension-id {schemaExtension-id}



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



graphClient.SchemaExtensions().BySchemaExtensionId("schemaExtension-id").Delete(context.Background(), nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.schemaExtensions().bySchemaExtensionId("{schemaExtension-id}").delete();


const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/schemaExtensions/bellowscollege_courses')
	.delete();


<?php
use Microsoft\Graph\GraphServiceClient;


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


$graphServiceClient->schemaExtensions()->bySchemaExtensionId('schemaExtension-id')->delete()->wait();


Import-Module Microsoft.Graph.SchemaExtensions

Remove-MgSchemaExtension -SchemaExtensionId $schemaExtensionId


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


await graph_client.schema_extensions.by_schema_extension_id('schemaExtension-id').delete()

Hinzufügen von benutzerdefinierten Daten zu Gruppen mithilfe von Schemaerweiterungen

Voraussetzungen

Schritt 1. Anzeigen verfügbarer Schemaerweiterungen

Anforderung

Antwort

Schritt 2. Registrieren einer Schemaerweiterungsdefinition

Anforderung

Antwort

Schritt 3: Erweitern einer Gruppe mit benutzerdefinierten Daten

Option 1: Erstellen einer neuen Gruppe mit erweiterten Daten

Anforderung

Antwort

Option 2: Aktualisieren einer vorhandenen Gruppe mit erweiterten Daten

Schritt 4. Aktualisieren von benutzerdefinierten Daten in einer Gruppe

Schritt 5. Abrufen einer Gruppe und ihrer Erweiterungsdaten

Anforderung

Antwort

Schritt 6: Löschen von Erweiterungsdaten und Schemaerweiterungsdefinition

Feedback

Feedback

Zusätzliche Ressourcen

Hinzufügen von benutzerdefinierten Daten zu Gruppen mithilfe von Schemaerweiterungen

Voraussetzungen

Schritt 1. Anzeigen verfügbarer Schemaerweiterungen

Anforderung

Antwort

Schritt 2. Registrieren einer Schemaerweiterungsdefinition

Anforderung

Antwort

Schritt 3: Erweitern einer Gruppe mit benutzerdefinierten Daten

Option 1: Erstellen einer neuen Gruppe mit erweiterten Daten

Anforderung

Antwort

Option 2: Aktualisieren einer vorhandenen Gruppe mit erweiterten Daten

Schritt 4. Aktualisieren von benutzerdefinierten Daten in einer Gruppe

Schritt 5. Abrufen einer Gruppe und ihrer Erweiterungsdaten

Anforderung

Antwort

Schritt 6: Löschen von Erweiterungsdaten und Schemaerweiterungsdefinition

Verwandte Inhalte

Feedback

Feedback

Zusätzliche Ressourcen