Gruppe abrufenGet group

• 10.12.2020
• 3 Minuten Lesedauer
• • y
  • o

Namespace: microsoft.graphNamespace: microsoft.graph

Dient zum Abrufen der Eigenschaften und Beziehungen eines Gruppenobjekts.Get the properties and relationships of a group object.

Dieser Vorgang gibt standardmäßig nur eine Teilmenge aller verfügbaren Eigenschaften zurück, wie im Abschnitt Eigenschaften beschrieben.This operation returns by default only a subset of all the available properties, as noted in the Properties section. Zum Abrufen von Eigenschaften, die nicht standardmäßig zurückgegeben werden, geben sie diese in einer OData-Abfrageoption $select an.To get properties that are not returned by default, specify them in a $select OData query option. Die hasMembersWithLicenseErrors-Eigenschaft ist eine Ausnahme und wird in der $select-Abfrage nicht zurückgegeben.The hasMembersWithLicenseErrors property is an exception and is not returned in the $select query.

BerechtigungenPermissions

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Hinweis: Abhängig von den Gruppenfeatures, auf die Sie zugreifen möchten, sind Berechtigungen möglicherweise eingeschränkt.Note: Depending on the group features you're trying to access, permissions might be limited. Weitere Informationen finden Sie im Abschnitt Gruppen unter Bekannte Probleme in Microsoft Graph.For more information, see the Groups section in Known issues with Microsoft Graph.

HTTP-AnforderungHTTP request

GET /groups/{id}

Optionale AbfrageparameterOptional query parameters

Mit $select können Sie bestimmte Gruppeneigenschaften abrufen, einschließlich derjenigen, die standardmäßig nicht zurückgegeben werden.You can use $select to get specific group properties, including those that are not returned by default.

Weitere Informationen zu OData-Abfrageoptionen finden Sie unter OData-Abfrageparameter.For more information on OData query options, see OData Query Parameters.

AnforderungsheaderRequest headers

AnforderungstextRequest body

Geben Sie für diese Methode keinen Anforderungstext an.Do not supply a request body for this method.

AntwortResponse

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und das group-Objekt im Antworttext zurückgegeben.If successful, this method returns a 200 OK response code and group object in the response body. Es werden die Standardeigenschaften zurückgegeben, sofern Sie nicht mit $select bestimmte Eigenschaften angeben.It returns the default properties unless you use $select to specify specific properties.

BeispielExample

Beispiel 1: Zurückgeben aller StandardeigenschaftenExample 1: Return all default properties

Alle Standardeigenschaften zurückgeben.Return all default properties.

AnforderungRequest

Nachfolgend sehen Sie ein Beispiel für eine GET-Anforderung.The following is an example of a GET request.

GET https://graph.microsoft.com/v1.0/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var group = await graphClient.Groups["b320ee12-b1cd-4cca-b648-a437be61c5cd"]
    .Request()
    .GetAsync();

const options = {
    authProvider,
};

const client = Client.init(options);

let res = await client.api('/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd')
    .get();

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        MSGraphGroup *group = [[MSGraphGroup alloc] initWithData:data error:&nserror];

}];

[meDataTask execute];

IGraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Group group = graphClient.groups("b320ee12-b1cd-4cca-b648-a437be61c5cd")
    .buildRequest()
    .get();

AntwortResponse

Nachfolgend sehen Sie ein Beispiel der Antwort.The following is an example of the response. Es enthält nur die Standardeigenschaften.It includes only the default properties.

Hinweis: Das hier gezeigte Antwortobjekt kann zwecks besserer Lesbarkeit gekürzt werden.Note: The response object shown here might be shortened for readability. Bei einem tatsächlichen Aufruf werden alle Standardeigenschaften zurückgegeben.All the default properties are returned in an actual call.

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

{
    "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
    "deletedDateTime": null,
    "classification": null,
    "createdDateTime": "2018-12-22T00:51:37Z",
    "creationOptions": [],
    "description": "Self help community for library",
    "displayName": "Library Assist",
    "groupTypes": [
        "Unified"
    ],
    "mail": "library2@contoso.com",
    "mailEnabled": true,
    "mailNickname": "library",
    "onPremisesLastSyncDateTime": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSyncEnabled": null,
    "preferredDataLocation": "CAN",
    "proxyAddresses": [
        "smtp:library7423@contoso.com",
        "SMTP:library2@contoso.com"
    ],
    "renewedDateTime": "2018-12-22T00:51:37Z",
    "resourceBehaviorOptions": [],
    "resourceProvisioningOptions": [],
    "securityEnabled": false,
    "visibility": "Public",
    "onPremisesProvisioningErrors": []
}

Beispiel 2: Zurückgeben zusätzlicher Eigenschaften mithilfe von $selectExample 2: Return additional properties by using $select

Zusätzliche Eigenschaften mithilfe von $select zurückgeben.Return additional properties by using $select.

AnforderungRequest

Nachfolgend sehen Sie ein Beispiel für eine GET-Anforderung.The following is an example of a GET request.

GET https://graph.microsoft.com/v1.0/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount

GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var group = await graphClient.Groups["b320ee12-b1cd-4cca-b648-a437be61c5cd"]
    .Request()
    .Select("allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount")
    .GetAsync();

const options = {
    authProvider,
};

const client = Client.init(options);

let res = await client.api('/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd')
    .select('allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount')
    .get();

MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/groups/b320ee12-b1cd-4cca-b648-a437be61c5cd?$select=allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        MSGraphGroup *group = [[MSGraphGroup alloc] initWithData:data error:&nserror];

}];

[meDataTask execute];

IGraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

Group group = graphClient.groups("b320ee12-b1cd-4cca-b648-a437be61c5cd")
    .buildRequest()
    .select("allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount")
    .get();

AntwortResponse

Nachfolgend finden Sie ein Beispiel der Antwort, die die angeforderten nicht standardmäßigen Eigenschaften umfasst.The following is an example of the response which includes the requested non-default properties.

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups(allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,unseenCount)/$entity",
    "id": "b320ee12-b1cd-4cca-b648-a437be61c5cd",
    "allowExternalSenders": false,
    "autoSubscribeNewMembers": false,
    "isSubscribedByMail": false,
    "unseenCount": 0
}