Durchführen von API-Aufrufen mithilfe der Microsoft Graph SDKs

Die Microsoft Graph SDK-Dienstbibliotheken stellen eine Clientklasse bereit, die als Ausgangspunkt für die Erstellung aller API-Anforderungen verwendet werden kann. Es gibt zwei Arten von Clientklassen: Eine verwendet eine Fluent-Schnittstelle zum Erstellen der Anforderung (z. B client.Users["user-id"].Manager. ) und die andere akzeptiert eine Pfadzeichenfolge (z. B api("/users/user-id/manager"). ). Wenn Sie über ein Anforderungsobjekt verfügen, können Sie verschiedene Optionen angeben, z. B. Filtern und Sortieren, und schließlich den Typ des Vorgangs auswählen, den Sie ausführen möchten.

Es gibt auch das Microsoft Graph PowerShell SDK, das über keine Clientklasse verfügt. Stattdessen werden alle Anforderungen als PowerShell-Befehle dargestellt. Um beispielsweise den Vorgesetzten eines Benutzers abzurufen, lautet Get-MgUserManagerder Befehl . Weitere Informationen zum Suchen von Befehlen für API-Aufrufe finden Sie unter Navigieren im Microsoft Graph PowerShell SDK.

Lesen von Informationen aus Microsoft Graph

Zum Lesen von Informationen aus Microsoft Graph müssen Sie zunächst ein Anforderungsobjekt erstellen und dann die GET -Methode für die Anforderung ausführen.

C#

// GET https://graph.microsoft.com/v1.0/me
var user = await graphClient.Me
    .GetAsync();

OK

// GET https://graph.microsoft.com/v1.0/me
result, _ := graphClient.Me().Get(context.Background(), nil)

Java

// GET https://graph.microsoft.com/v1.0/me
final User user = graphClient.me().get();

PHP

// GET https://graph.microsoft.com/v1.0/me
/** @var Models\User $user */
$user = $graphClient->me()
    ->get()
    ->wait();

PowerShell

# GET https://graph.microsoft.com/v1.0/users/{user-id}

$userId = "71766077-aacc-470a-be5e-ba47db3b2e88"

$user = Get-MgUser -UserId $userId

Python

# GET https://graph.microsoft.com/v1.0/me
user = await graph_client.me.get()

TypeScript

// GET https://graph.microsoft.com/v1.0/me
const user = await graphClient.api('/me').get();

Verwenden von $select zum Steuern der zurückgegebenen Eigenschaften

Beim Abrufen einer Entität werden nicht alle Eigenschaften automatisch abgerufen. manchmal müssen sie explizit ausgewählt werden. Außerdem ist die Rückgabe des Standardsatzes von Eigenschaften in einigen Szenarien nicht erforderlich. Wenn Sie nur die erforderlichen Eigenschaften auswählen, kann die Leistung der Anforderung verbessert werden. Sie können die Anforderung so anpassen, dass sie den $select Abfrageparameter in eine Liste von Eigenschaften einschließt.

C#

// GET https://graph.microsoft.com/v1.0/me?$select=displayName,jobTitle
var user = await graphClient.Me
    .GetAsync(requestConfiguration =>
    {
        requestConfiguration.QueryParameters.Select =
            ["displayName", "jobTitle"];
    });

OK

// GET https://graph.microsoft.com/v1.0/me?$select=displayName,jobTitle

// import github.com/microsoftgraph/msgraph-sdk-go/users
query := users.UserItemRequestBuilderGetQueryParameters{
    Select: []string{"displayName", "jobTitle"},
}

options := users.UserItemRequestBuilderGetRequestConfiguration{
    QueryParameters: &query,
}

result, _ := graphClient.Me().Get(context.Background(), &options)

Java

// GET https://graph.microsoft.com/v1.0/me?$select=displayName,jobTitle
final User user = graphClient.me().get( requestConfiguration -> {
    requestConfiguration.queryParameters.select = new String[] {"displayName", "jobTitle"};
});

PHP

// GET https://graph.microsoft.com/v1.0/me?$select=displayName,jobTitle
// Microsoft\Graph\Generated\Users\Item\UserItemRequestBuilderGetQueryParameters
$query = new UserItemRequestBuilderGetQueryParameters(
    select: ['displayName', 'jobTitle']);

// Microsoft\Graph\Generated\Users\Item\UserItemRequestBuilderGetRequestConfiguration
$config = new UserItemRequestBuilderGetRequestConfiguration(
    queryParameters: $query);

/** @var Models\User $user */
$user = $graphClient->me()
    ->get($config)
    ->wait();

PowerShell

# GET https://graph.microsoft.com/v1.0/users/{user-id}?$select=displayName,jobTitle

$userId = "71766077-aacc-470a-be5e-ba47db3b2e88"

# The -Property parameter causes a $select parameter to be included in the request
$user = Get-MgUser -UserId $userId -Property DisplayName,JobTitle

Python

# GET https://graph.microsoft.com/v1.0/me?$select=displayName,jobTitle

# msgraph.generated.users.item.user_item_request_builder
query_params = UserItemRequestBuilder.UserItemRequestBuilderGetQueryParameters(
    select=['displayName', 'jobTitle']
)

config = RequestConfiguration(
    query_parameters=query_params
)

user = await graph_client.me.get(config)

TypeScript

// GET https://graph.microsoft.com/v1.0/me?$select=displayName,jobTitle
const user = await graphClient
  .api('/me')
  .select(['displayName', 'jobTitle'])
  .get();

Abrufen einer Liste von Entitäten

Das Abrufen einer Liste von Entitäten ähnelt dem Abrufen einer einzelnen Entität, mit dem Unterschied, dass andere Optionen zum Konfigurieren der Anforderung vorhanden sind. Der $filter Abfrageparameter kann das Resultset auf die Zeilen reduzieren, die der angegebenen Bedingung entsprechen. Der $orderby Abfrageparameter fordert an, dass der Server die Liste der Entitäten bereitstellt, die nach den angegebenen Eigenschaften sortiert sind.

Hinweis

Einige Anforderungen für Microsoft Entra Ressourcen erfordern die Verwendung erweiterter Abfragefunktionen. Wenn Sie eine Antwort erhalten, die auf eine ungültige Anforderung, eine nicht unterstützte Abfrage oder eine Antwort mit unerwarteten Ergebnissen hinweist, kann es möglich sein, dass die Anforderung erfolgreich ist, einschließlich des $count Abfrageparameters und ConsistencyLevel des Headers. Ausführliche Informationen und Beispiele finden Sie unter Erweiterte Abfragefunktionen für Verzeichnisobjekte.

C#

// GET https://graph.microsoft.com/v1.0/me/messages?
// $select=subject,sender&$filter=subject eq 'Hello world'
var messages = await graphClient.Me.Messages
    .GetAsync(requestConfig =>
    {
        requestConfig.QueryParameters.Select =
            ["subject", "sender"];
        requestConfig.QueryParameters.Filter =
            "subject eq 'Hello world'";
    });

OK

// GET https://graph.microsoft.com/v1.0/me/messages?
// $select=subject,sender&$filter=subject eq 'Hello world'

// import github.com/microsoftgraph/msgraph-sdk-go/users
filterValue := "subject eq 'Hello world'"
query := users.ItemMessagesRequestBuilderGetQueryParameters{
    Select: []string{"subject", "sender"},
    Filter: &filterValue,
}

options := users.ItemMessagesRequestBuilderGetRequestConfiguration{
    QueryParameters: &query,
}

result, _ := graphClient.Me().Messages().
    Get(context.Background(), &options)

Java

// GET https://graph.microsoft.com/v1.0/me/messages?
// $select=subject,sender&$filter=subject eq 'Hello world'
final MessageCollectionResponse messages = graphClient.me().messages().get( requestConfiguration -> {
    requestConfiguration.queryParameters.select = new String[] {"subject", "sender"};
    requestConfiguration.queryParameters.filter = "subject eq 'Hello world'";
});

PHP

// GET https://graph.microsoft.com/v1.0/me/messages?
// $select=subject,sender&$filter=subject eq 'Hello world'
// Microsoft\Graph\Generated\Users\Item\Messages\MessagesRequestBuilderGetQueryParameters
$query = new MessagesRequestBuilderGetQueryParameters(
    select: ['subject', 'sender'],
    filter: 'subject eq \'Hello world\''
);

// Microsoft\Graph\Generated\Users\Item\Messages\MessagesRequestBuilderGetRequestConfiguration
$config = new MessagesRequestBuilderGetRequestConfiguration(
    queryParameters: $query);

/** @var Models\MessageCollectionResponse $messages */
$messages = $graphClient->me()
    ->messages()
    ->get($config)
    ->wait();

PowerShell

# GET https://graph.microsoft.com/v1.0/users/{user-id}/messages?$select=subject,sender&
# $filter=<some condition>&orderBy=receivedDateTime

$userId = "71766077-aacc-470a-be5e-ba47db3b2e88"

# -Sort is equivalent to $orderby
# -Filter is equivalent to $filter
$messages = Get-MgUserMessage -UserId $userId -Property Subject,Sender `
-Sort ReceivedDateTime -Filter "some condition"

Python

# GET https://graph.microsoft.com/v1.0/me/messages?
# $select=subject,sender&$filter=subject eq 'Hello world'

# msgraph.generated.users.item.messages.messages_request_builder
query_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters(
    select=['subject', 'sender'],
    filter='subject eq \'Hello world\''
)

config = RequestConfiguration(
    query_parameters=query_params
)

messages = await graph_client.me.messages.get(config)

TypeScript

// GET https://graph.microsoft.com/v1.0/me/messages?
// $select=subject,sender&$filter=subject eq 'Hello world'
const messages = await graphClient
  .api('/me/messages')
  .select(['subject', 'sender'])
  .filter(`subject eq 'Hello world'`)
  .get();

Das beim Abrufen einer Liste von Entitäten zurückgegebene Objekt ist wahrscheinlich eine ausgelagerte Auflistung. Ausführliche Informationen zum Abrufen der vollständigen Liste der Entitäten finden Sie unter Paging durch eine Sammlung.

Zugreifen auf ein Element einer Sammlung

Für SDKs, die einen Fluent-Stil unterstützen, kann mithilfe eines Arrayindexes auf Sammlungen von Entitäten zugegriffen werden. Bei vorlagenbasierten SDKs ist es ausreichend, den Elementbezeichner in das Pfadsegment einzubetten, das der Sammlung folgt. Für PowerShell werden Bezeichner als Parameter übergeben.

C#

// GET https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
var message = await graphClient.Me.Messages[messageId]
    .GetAsync();

OK

// GET https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
result, _ := graphClient.Me().Messages().
    ByMessageId(messageId).Get(context.Background(), nil)

Java

// GET https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
final Message message = graphClient.me().messages().byMessageId(messageId).get();

PHP

// GET https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
/** @var Models\Message $message */
$message = $graphClient->me()
    ->messages()
    ->byMessageId($messageId)
    ->get()
    ->wait();

PowerShell

# GET https://graph.microsoft.com/v1.0/users/{user-id}/messages/{message-id}

$userId = "71766077-aacc-470a-be5e-ba47db3b2e88"
$messageId = "AQMkAGUy.."

$message = Get-MgUserMessage -UserId $userId -MessageId $messageId

Python

# GET https://graph.microsoft.com/v1.0/me/messages/{message-id}
# message_id is a string containing the id property of the message
message = await graph_client.me.messages.by_message_id(message_id).get()

TypeScript

// GET https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
const message = await graphClient.api(`/me/messages/${messageId}`).get();

Verwenden von $expand für den Zugriff auf verwandte Entitäten

Sie können den $expand Filter verwenden, um gleichzeitig mit der Anforderung der Hauptentität eine verknüpfte Entität oder eine Sammlung von Entitäten anzufordern.

C#

// GET https://graph.microsoft.com/v1.0/me/messages/{message-id}?$expand=attachments
// messageId is a string containing the id property of the message
var message = await graphClient.Me.Messages[messageId]
    .GetAsync(requestConfig =>
        requestConfig.QueryParameters.Expand =
            ["attachments"]);

OK

// GET https://graph.microsoft.com/v1.0/me/messages/{message-id}?$expand=attachments

// import github.com/microsoftgraph/msgraph-sdk-go/users
expand := users.ItemMessagesMessageItemRequestBuilderGetQueryParameters{
    Expand: []string{"attachments"},
}

options := users.ItemMessagesMessageItemRequestBuilderGetRequestConfiguration{
    QueryParameters: &expand,
}
// messageId is a string containing the id property of the message
result, _ := graphClient.Me().Messages().
    ByMessageId(messageId).Get(context.Background(), &options)

Java

// GET
// https://graph.microsoft.com/v1.0/me/messages/{message-id}?$expand=attachments
// messageId is a string containing the id property of the message
final Message message = graphClient.me().messages().byMessageId(messageId).get( requestConfiguration -> {
    requestConfiguration.queryParameters.expand = new String[] {"attachments"};
});

PHP

// GET https://graph.microsoft.com/v1.0/me/messages/{message-id}?$expand=attachments
// messageId is a string containing the id property of the message
// Microsoft\Graph\Generated\Users\Item\Messages\Item\MessageItemRequestBuilderGetQueryParameters
$query = new MessageItemRequestBuilderGetQueryParameters(
    expand: ['attachments']
);

// Microsoft\Graph\Generated\Users\Item\Messages\Item\MessageItemRequestBuilderGetRequestConfiguration
$config = new MessageItemRequestBuilderGetRequestConfiguration(
    queryParameters: $query);

/** @var Models\Message $message */
$message = $graphClient->me()
    ->messages()
    ->byMessageId($messageId)
    ->get($config)
    ->wait();

PowerShell

# GET https://graph.microsoft.com/v1.0/users/{user-id}/messages?$expand=attachments

$userId = "71766077-aacc-470a-be5e-ba47db3b2e88"
$messageId = "AQMkAGUy.."

# -ExpandProperty is equivalent to $expand
$message = Get-MgUserMessage -UserId $userId -MessageId $messageId -ExpandProperty Attachments

Python

# GET https://graph.microsoft.com/v1.0/me/messages/{message-id}?$expand=attachments
# message_id is a string containing the id property of the message

# msgraph.generated.users.item.messages.item.message_item_request_builder
query_params = MessageItemRequestBuilder.MessageItemRequestBuilderGetQueryParameters(
    expand=['attachments']
)

config = RequestConfiguration(
    query_parameters=query_params
)

message = await graph_client.me.messages.by_message_id(message_id).get(config)

TypeScript

// GET https://graph.microsoft.com/v1.0/me/messages/{message-id}?$expand=attachments
// messageId is a string containing the id property of the message
const message = await graphClient
  .api(`/me/messages/${messageId}`)
  .expand('attachments')
  .get();

Löschen einer Entität

Löschanforderungen werden auf die gleiche Weise wie Anforderungen zum Abrufen einer Entität erstellt, verwenden aber eine DELETE Anforderung anstelle von GET.

C#

// DELETE https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
await graphClient.Me.Messages[messageId]
    .DeleteAsync();

OK

// DELETE https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
err := graphClient.Me().Messages().
    ByMessageId(messageId).Delete(context.Background(), nil)

Java

// DELETE https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
graphClient.me().messages().byMessageId(messageId).delete();

PHP

// DELETE https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
$graphClient->me()
    ->messages()
    ->byMessageId($messageId)
    ->delete()
    ->wait();

PowerShell

# DELETE https://graph.microsoft.com/v1.0/users/{user-id}/messages/{message-id}

$userId = "71766077-aacc-470a-be5e-ba47db3b2e88"
$messageId = "AQMkAGUy.."

Remove-MgUserMessage -UserId $userId -MessageId $messageId

Python

# DELETE https://graph.microsoft.com/v1.0/me/messages/{message-id}
# message_id is a string containing the id property of the message
await graph_client.me.messages.by_message_id(message_id).delete()

TypeScript

// DELETE https://graph.microsoft.com/v1.0/me/messages/{message-id}
// messageId is a string containing the id property of the message
await graphClient.api(`/me/messages/${messageId}`).delete();

Erstellen einer neuen Entität mit POST

Für Fluent-Stil- und vorlagenbasierte SDKs können sammlungen mit einer POST -Methode neue Elemente hinzugefügt werden. Für PowerShell akzeptiert ein New-* Befehl Parameter, die der hinzuzufügenden Entität zugeordnet sind. Die erstellte Entität wird vom Aufruf zurückgegeben.

C#

// POST https://graph.microsoft.com/v1.0/me/calendars
var calendar = new Calendar
{
    Name = "Volunteer",
};

var newCalendar = await graphClient.Me.Calendars
    .PostAsync(calendar);

OK

// POST https://graph.microsoft.com/v1.0/me/calendars

calendar := models.NewCalendar()
name := "Volunteer"
calendar.SetName(&name)

result, _ := graphClient.Me().Calendars().Post(context.Background(), calendar, nil)

Java

// POST https://graph.microsoft.com/v1.0/me/calendars
final Calendar calendar = new Calendar();
calendar.setName("Volunteer");

final Calendar newCalendar = graphClient.me().calendars().post(calendar);

PHP

// POST https://graph.microsoft.com/v1.0/me/calendars
$calendar = new Models\Calendar();
$calendar->setName('Volunteer');

/** @var Models\Calendar $newCalendar */
$newCalendar = $graphClient->me()
    ->calendars()
    ->post($calendar)
    ->wait();

PowerShell

# POST https://graph.microsoft.com/v1.0/users/{user-id}/calendars

$userId = "71766077-aacc-470a-be5e-ba47db3b2e88"

New-MgUserCalendar -UserId $userId -Name "Volunteer"

Python

# POST https://graph.microsoft.com/v1.0/me/calendars

# msgraph.generated.models.calendar
calendar = Calendar()
calendar.name = 'Volunteer'

new_calendar = await graph_client.me.calendars.post(calendar)

TypeScript

// POST https://graph.microsoft.com/v1.0/me/calendars
const calendar: Calendar = {
  name: 'Volunteer',
};

const newCalendar = await graphClient.api('/me/calendars').post(calendar);

Aktualisieren einer vorhandenen Entität mit PATCH

Die meisten Updates in Microsoft Graph werden mithilfe einer PATCH -Methode ausgeführt. Daher ist es nur erforderlich, die Eigenschaften, die Sie ändern möchten, in das übergebene Objekt einzuschließen.

C#

// PATCH https://graph.microsoft.com/v1.0/teams/{team-id}
var team = new Team
{
    FunSettings = new TeamFunSettings
    {
        AllowGiphy = true,
        GiphyContentRating = GiphyRatingType.Strict,
    },
};

// teamId is a string containing the id property of the team
await graphClient.Teams[teamId]
    .PatchAsync(team);

OK

// PATCH https://graph.microsoft.com/v1.0/teams/{team-id}

funSettings := models.NewTeamFunSettings()
allowGiphy := true
funSettings.SetAllowGiphy(&allowGiphy)
giphyRating := models.STRICT_GIPHYRATINGTYPE
funSettings.SetGiphyContentRating(&giphyRating)

team := models.NewTeam()
team.SetFunSettings(funSettings)

graphClient.Teams().ByTeamId(teamId).Patch(context.Background(), team, nil)

Java

// PATCH https://graph.microsoft.com/v1.0/teams/{team-id}
final Team team = new Team();
final TeamFunSettings funSettings = new TeamFunSettings();
funSettings.setAllowGiphy(true);
funSettings.setGiphyContentRating(GiphyRatingType.Strict);
team.setFunSettings(funSettings);

// teamId is a string containing the id property of the team
graphClient.teams().byTeamId(teamId).patch(team);

PHP

// PATCH https://graph.microsoft.com/v1.0/teams/{team-id}
$funSettings = new Models\TeamFunSettings();
$funSettings->setAllowGiphy(true);
$funSettings->setGiphyContentRating(
    new Models\GiphyRatingType(Models\GiphyRatingType::STRICT));

$team = new Models\Team();
$team->setFunSettings($funSettings);

// $teamId is a string containing the id property of the team
$graphClient->teams()
    ->byTeamId($teamId)
    ->patch($team);

PowerShell

# PATCH https://graph.microsoft.com/v1.0/teams/{team-id}

$teamId = "71766077-aacc-470a-be5e-ba47db3b2e88"

Update-MgTeam -TeamId $teamId -FunSettings @{ AllowGiphy = $true; GiphyContentRating = "strict" }

Python

# PATCH https://graph.microsoft.com/v1.0/teams/{team-id}

# msgraph.generated.models.team_fun_settings.TeamFunSettings
fun_settings = TeamFunSettings()
fun_settings.allow_giphy = True
# msgraph.generated.models.giphy_rating_type
fun_settings.giphy_content_rating = GiphyRatingType.Strict

# msgraph.generated.models.team.Team
team = Team()
team.fun_settings = fun_settings

# team_id is a string containing the id property of the team
await graph_client.teams.by_team_id(team_id).patch(team)

TypeScript

// PATCH https://graph.microsoft.com/v1.0/teams/{team-id}
const team: Team = {
  funSettings: {
    allowGiphy: true,
    giphyContentRating: 'strict',
  },
};

// teamId is a string containing the id property of the team
await graphClient.api(`/teams/${teamId}`).update(team);

Verwenden von HTTP-Headern zum Steuern des Anforderungsverhaltens

Sie können benutzerdefinierte Header mithilfe der Headers Sammlung an eine Anforderung anfügen. Für PowerShell ist das Hinzufügen von Headern nur mit der Invoke-GraphRequest -Methode möglich. In einigen Microsoft Graph-Szenarien werden benutzerdefinierte Header verwendet, um das Verhalten der Anforderung anzupassen.

C#

// GET https://graph.microsoft.com/v1.0/me/events
var events = await graphClient.Me.Events
    .GetAsync(requestConfig =>
    {
        requestConfig.Headers.Add(
            "Prefer", @"outlook.timezone=""Pacific Standard Time""");
    });

OK

// GET https://graph.microsoft.com/v1.0/me/events

// import abstractions "github.com/microsoft/kiota-abstractions-go"
headers := abstractions.NewRequestHeaders()
headers.Add("Prefer", "outlook.timezone=\"Pacific Standard Time\"")

// import github.com/microsoftgraph/msgraph-sdk-go/users
options := users.ItemEventsRequestBuilderGetRequestConfiguration{
    Headers: headers,
}

result, _ := graphClient.Me().Events().Get(context.Background(), &options)

Java

// GET https://graph.microsoft.com/v1.0/me/events
final EventCollectionResponse events = graphClient.me().events().get( requestConfiguration -> {
    requestConfiguration.headers.add("Prefer", "outlook.timezone=\"Pacific Standard Time\"");
});

PHP

// GET https://graph.microsoft.com/v1.0/me/events
// Microsoft\Graph\Generated\Users\Item\Events\EventsRequestBuilderGetRequestConfiguration
$config = new EventsRequestBuilderGetRequestConfiguration(
    headers: ['Prefer' => 'outlook.timezone="Pacific Standard Time"']
);

/** @var Models\EventCollectionResponse $events */
$events = $graphClient->me()
    ->events()
    ->get($config)
    ->wait();

PowerShell

# GET https://graph.microsoft.com/v1.0/users/{user-id}/events

$userId = "71766077-aacc-470a-be5e-ba47db3b2e88"
$requestUri = "/v1.0/users/" + $userId + "/events"

$events = Invoke-GraphRequest -Method GET -Uri $requestUri `
-Headers @{ Prefer = "outlook.timezone=""Pacific Standard Time""" }

Python

# GET https://graph.microsoft.com/v1.0/me/events

# msgraph.generated.users.item.events.events_request_builder
config = RequestConfiguration()
config.headers.add('Prefer', 'outlook.timezone="Pacific Standard Time"')

events = await graph_client.me.events.get(config)

TypeScript

// GET https://graph.microsoft.com/v1.0/me/events
const events = await graphClient
  .api('/me/events')
  .header('Prefer', 'outlook.timezone="Pacific Standard Time"')
  .get();

Bereitstellen benutzerdefinierter Abfrageparameter

Für SDKs, die den Fluent-Stil unterstützen, können Sie mithilfe des QueryParameters -Objekts benutzerdefinierte Abfrageparameterwerte bereitstellen. Bei vorlagenbasierten SDKs werden die Parameter URL-codiert und dem Anforderungs-URI hinzugefügt. Für PowerShell und Go werden definierte Abfrageparameter für eine bestimmte API als Parameter für den entsprechenden Befehl verfügbar gemacht.

C#

// GET https://graph.microsoft.com/v1.0/me/calendarView?
// startDateTime=2023-06-14T00:00:00Z&endDateTime=2023-06-15T00:00:00Z
var events = await graphClient.Me.CalendarView
    .GetAsync(requestConfiguration =>
    {
        requestConfiguration.QueryParameters.StartDateTime =
            "2023-06-14T00:00:00Z";
        requestConfiguration.QueryParameters.EndDateTime =
            "2023-06-15T00:00:00Z";
    });

OK

// GET https://graph.microsoft.com/v1.0/me/calendarView?
// startDateTime=2023-06-14T00:00:00Z&endDateTime=2023-06-15T00:00:00Z

startDateTime := "2023-06-14T00:00:00"
endDateTime := "2023-06-15T00:00:00Z"

// import github.com/microsoftgraph/msgraph-sdk-go/users
query := users.ItemCalendarViewRequestBuilderGetQueryParameters{
    StartDateTime: &startDateTime,
    EndDateTime:   &endDateTime,
}

options := users.ItemCalendarViewRequestBuilderGetRequestConfiguration{
    QueryParameters: &query,
}

result, _ := graphClient.Me().CalendarView().Get(context.Background(), &options)

Java

// GET https://graph.microsoft.com/v1.0/me/calendarView?
// startDateTime=2023-06-14T00:00:00Z&endDateTime=2023-06-15T00:00:00Z
final EventCollectionResponse events = graphClient.me().calendarView().get( requestConfiguration -> {
    requestConfiguration.queryParameters.startDateTime = "2023-06-14T00:00:00Z";
    requestConfiguration.queryParameters.endDateTime = "2023-06-15T00:00:00Z";
});

PHP

// GET https://graph.microsoft.com/v1.0/me/calendarView?
// startDateTime=2023-06-14T00:00:00Z&endDateTime=2023-06-15T00:00:00Z
// Microsoft\Graph\Generated\Users\Item\CalendarView\CalendarViewRequestBuilderGetQueryParameters
$query = new CalendarViewRequestBuilderGetQueryParameters(
    startDateTime: '2023-06-14T00:00:00Z',
    endDateTime: '2023-06-15T00:00:00Z');

// Microsoft\Graph\Generated\Users\Item\CalendarView\CalendarViewRequestBuilderGetRequestConfiguration
$config = new CalendarViewRequestBuilderGetRequestConfiguration(
    queryParameters: $query);

/** @var Models\EventCollectionResponse $events */
$events = $graphClient->me()
    ->calendarView()
    ->get($config)
    ->wait();

PowerShell

# GET https://graph.microsoft.com/v1.0/users/{user-id}/calendars/{calendar-id}/calendarView

$userId = "71766077-aacc-470a-be5e-ba47db3b2e88"
$calendarId = "AQMkAGUy..."

$events = Get-MgUserCalendarView -UserId $userId -CalendarId $calendarId `
-StartDateTime "2020-08-31T00:00:00Z" -EndDateTime "2020-09-02T00:00:00Z"

Python

# GET https://graph.microsoft.com/v1.0/me/calendarView?
# startDateTime=2023-06-14T00:00:00Z&endDateTime=2023-06-15T00:00:00Z

# msgraph.generated.users.item.calendar_view.calendar_view_request_builder
query_params = CalendarViewRequestBuilder.CalendarViewRequestBuilderGetQueryParameters(
    start_date_time='2023-06-14T00:00:00Z',
    end_date_time='2023-06-15T00:00:00Z'
)

config = RequestConfiguration(
    query_parameters=query_params
)

events = await graph_client.me.calendar_view.get(config)

TypeScript

// GET https://graph.microsoft.com/v1.0/me/calendarView?
// startDateTime=2023-06-14T00:00:00Z&endDateTime=2023-06-15T00:00:00Z
const events = await graphClient
  .api('me/calendar/calendarView')
  .query({
    startDateTime: '2023-06-14T00:00:00Z',
    endDateTime: '2023-06-15T00:00:00Z',
  })
  .get();