名前空間: microsoft.graph
指定した onlineMeeting オブジェクトのプロパティを更新します。
更新をサポートするプロパティの一覧については、「 要求本文 」セクションを参照してください。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
✅ |
✅ |
✅ |
❌ |
アクセス許可
次の表は、サポートされている各リソースの種類でこの API を呼び出すために必要な最小特権のアクセス許可またはアクセス許可を示しています。
ベスト プラクティスに従って、最小限の特権のアクセス許可を要求します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
次の HTTP 要求のアクセス許可:
PATCH /me/onlineMeetings/{meetingId}
アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
委任 (職場または学校のアカウント) |
OnlineMeetings.ReadWrite |
注意事項なし。 |
委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
アプリケーション |
サポートされていません。 |
サポートされていません。 |
次の HTTP 要求のアクセス許可:
PATCH /users/{userId}/onlineMeetings/{meetingId}
アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
委任 (職場または学校のアカウント) |
OnlineMeetings.ReadWrite |
注意事項なし。 |
委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
アプリケーション |
OnlineMeetings.ReadWrite.All |
注意事項なし。 |
注:
この API のアプリケーションアクセス許可を使用するには、テナント管理者は アプリケーション アクセス ポリシー を作成し、そのユーザーに代わってオンライン会議を更新するようにポリシーで構成されたアプリを承認するようにユーザーに付与する必要があります (要求パスにユーザー ID が指定されています)。
HTTP 要求
委任された (/me
) とアプリ (/users/{userId}/
) アクセス許可を持つ会議 ID を使用して、指定した onlineMeeting を更新するには:
PATCH /me/onlineMeetings/{meetingId}
PATCH /users/{userId}/onlineMeetings/{meetingId}
名前 |
説明 |
Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
Content-type |
application/json. 必須です。 |
要求本文
次の表に、更新できるプロパティの一覧を示します。 要求本文で、更新する必要があるプロパティの値 のみを 指定しますが、次の例外があります。
- オンライン会議の開始日または終了日時を調整するには、常に要求本文の startDateTime プロパティと endDateTime プロパティの両方が必要です。
-
participants プロパティの開催者フィールドは更新できません。 会議の作成後、会議の開催者を変更することはできません。
-
会議への出席者の追加や削除など、participants プロパティの出席者フィールドを調整するには、常に要求本文の出席者の完全な一覧が必要です。
最後の列は、このプロパティの更新が進行中の会議に有効かどうかを示します。
プロパティ |
型 |
説明 |
進行中の会議に適用されますか? |
allowAttendeeToEnableCamera |
ブール型 |
出席者がカメラをオンにできるかどうかを示します。 |
はい |
allowAttendeeToEnableMic |
ブール型 |
出席者がマイクをオンにできるかどうかを示します。 |
はい |
allowBreakoutRooms |
ブール型 |
ブレークアウト ルームが会議に対して有効になっているかどうかを示します。 |
不要 |
allowedLobbyAdmitters |
allowedLobbyAdmitterRoles |
ロビーから許可できるユーザーを指定します。 可能な値は organizerAndCoOrganizersAndPresenters 、organizerAndCoOrganizers 、unknownFutureValue です。 |
はい |
allowedPresenters |
onlineMeetingPresenters |
会議で発表者になることができるユーザーを指定します。 |
はい |
allowLiveShare |
meetingLiveShareOptions |
会議のライブ共有が有効かどうかを示します。 |
不要 |
allowMeetingChat |
meetingChatMode |
会議チャットのモードを指定します。 |
はい |
allowPowerPointSharing |
ブール型 |
会議PowerPointライブが有効になっているかどうかを示します。 |
不要 |
allowRecording |
ブール型 |
会議の記録が有効かどうかを示します。
onlineMeetingBase から継承されます。 |
はい |
allowTeamworkReactions |
ブール型 |
会議で Teams の反応が有効になっているかどうかを示します。 |
はい |
allowTranscription |
ブール型 |
会議で文字起こしが有効かどうかを示します。
onlineMeetingBase から継承されます。 |
はい |
allowWhiteboard |
ブール型 |
会議でホワイトボードが有効かどうかを示します。 |
不要 |
anonymizeIdentityForRoles |
onlineMeetingRole コレクション |
会議で匿名化される ID を指定します。 使用可能な値は、 attendee です。
attendee 値は、追加後の PATCH 操作では削除できません。
onlineMeetingBase から継承されます。 |
不要 |
endDateTime |
DateTime |
会議の終了時刻 (UTC)。 |
不要 |
isEntryExitAnnounced |
ブール型 |
呼び出し元が参加または退出するタイミングをアナウンスするかどうか。 |
はい |
lobbyBypassSettings |
lobbyBypassSettings |
会議ロビーをバイパスできる参加者を指定します。 |
はい |
participants |
meetingParticipants |
オンライン会議に関連付けられている参加者。 出席者のみが更新できます。 |
不要 |
recordAutomatically |
ブール型 |
会議を自動的に記録するかどうかを示します。 |
不要 |
startDateTime |
DateTime |
UTC での会議の開始時刻。 |
不要 |
subject |
String |
オンライン会議の件名。 |
不要 |
watermarkProtection |
watermarkProtectionValues |
クライアント アプリケーションがコンテンツ タイプに透かしを適用するかどうかを指定します。
onlineMeetingBase から継承されます。
onlineMeetingBase から継承されます。 |
不要 |
broadcastSettings (非推奨) |
broadcastMeetingSettings |
ライブ イベントに関連する設定。 |
いいえ |
注:
-
allowedPresenters、allowLiveShare、allowMeetingChat の使用可能な値の一覧については、「onlineMeeting」を参照してください。
-
allowedPresenters の値を
roleIsPresenter
に更新する場合は、指定した出席者のロールが要求本文にpresenter
に設定されている出席者の完全な一覧を含めます。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で更新された onlineMeeting オブジェクトを 返します。
例
例 1: startDateTime、endDateTime、件名を更新する
要求
手記: 読みやすくするために、会議 ID が短縮されました。
PATCH https://graph.microsoft.com/v1.0/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi
Content-Type: application/json
{
"startDateTime": "2020-09-09T14:33:30.8546353-07:00",
"endDateTime": "2020-09-09T15:03:30.8566356-07:00",
"subject": "Patch Meeting Subject"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new OnlineMeeting
{
StartDateTime = DateTimeOffset.Parse("2020-09-09T14:33:30.8546353-07:00"),
EndDateTime = DateTimeOffset.Parse("2020-09-09T15:03:30.8566356-07:00"),
Subject = "Patch Meeting Subject",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.OnlineMeetings["{onlineMeeting-id}"].PatchAsync(requestBody);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
mgc users online-meetings patch --user-id {user-id} --online-meeting-id {onlineMeeting-id} --body '{\
"startDateTime": "2020-09-09T14:33:30.8546353-07:00",\
"endDateTime": "2020-09-09T15:03:30.8566356-07:00",\
"subject": "Patch Meeting Subject"\
}\
'
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
"time"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewOnlineMeeting()
startDateTime , err := time.Parse(time.RFC3339, "2020-09-09T14:33:30.8546353-07:00")
requestBody.SetStartDateTime(&startDateTime)
endDateTime , err := time.Parse(time.RFC3339, "2020-09-09T15:03:30.8566356-07:00")
requestBody.SetEndDateTime(&endDateTime)
subject := "Patch Meeting Subject"
requestBody.SetSubject(&subject)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
onlineMeetings, err := graphClient.Me().OnlineMeetings().ByOnlineMeetingId("onlineMeeting-id").Patch(context.Background(), requestBody, nil)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OnlineMeeting onlineMeeting = new OnlineMeeting();
OffsetDateTime startDateTime = OffsetDateTime.parse("2020-09-09T14:33:30.8546353-07:00");
onlineMeeting.setStartDateTime(startDateTime);
OffsetDateTime endDateTime = OffsetDateTime.parse("2020-09-09T15:03:30.8566356-07:00");
onlineMeeting.setEndDateTime(endDateTime);
onlineMeeting.setSubject("Patch Meeting Subject");
OnlineMeeting result = graphClient.me().onlineMeetings().byOnlineMeetingId("{onlineMeeting-id}").patch(onlineMeeting);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
const onlineMeeting = {
startDateTime: '2020-09-09T14:33:30.8546353-07:00',
endDateTime: '2020-09-09T15:03:30.8566356-07:00',
subject: 'Patch Meeting Subject'
};
await client.api('/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi')
.update(onlineMeeting);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\OnlineMeeting;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new OnlineMeeting();
$requestBody->setStartDateTime(new \DateTime('2020-09-09T14:33:30.8546353-07:00'));
$requestBody->setEndDateTime(new \DateTime('2020-09-09T15:03:30.8566356-07:00'));
$requestBody->setSubject('Patch Meeting Subject');
$result = $graphServiceClient->me()->onlineMeetings()->byOnlineMeetingId('onlineMeeting-id')->patch($requestBody)->wait();
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
Import-Module Microsoft.Graph.CloudCommunications
$params = @{
startDateTime = [System.DateTime]::Parse("2020-09-09T14:33:30.8546353-07:00")
endDateTime = [System.DateTime]::Parse("2020-09-09T15:03:30.8566356-07:00")
subject = "Patch Meeting Subject"
}
# A UPN can also be used as -UserId.
Update-MgUserOnlineMeeting -UserId $userId -OnlineMeetingId $onlineMeetingId -BodyParameter $params
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.online_meeting import OnlineMeeting
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = OnlineMeeting(
start_date_time = "2020-09-09T14:33:30.8546353-07:00",
end_date_time = "2020-09-09T15:03:30.8566356-07:00",
subject = "Patch Meeting Subject",
)
result = await graph_client.me.online_meetings.by_online_meeting_id('onlineMeeting-id').patch(request_body)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
応答
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-Type: application/json
{
"id":"MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi",
"creationDateTime":"2020-07-03T00:23:39.444642Z",
"startDateTime":"2020-09-09T21:33:30.8546353Z",
"endDateTime":"2020-09-09T22:03:30.8566356Z",
"joinWebUrl":"url",
"subject":"Patch Meeting Subject",
"isBroadcast":false,
"autoAdmittedUsers":"EveryoneInCompany",
"outerMeetingAutoAdmittedUsers":null,
"participants":{
"organizer":{
"upn":"upn",
"role": "presenter",
"identity":{
"azureApplicationInstance":null,
"applicationInstance":null,
"application":null,
"device":null,
"user":{
"id":"8716745d-77a9-4be3-afff-009e4b81658e",
"displayName":null,
"tenantId":"0823831b-1f1b-424b-b90a-1caa345a742a",
"identityProvider":"AAD"
}
}
}
},
"audioConferencing":{
"conferenceId":"id",
"tollNumber":"+1-900-555-0100",
"tollFreeNumber":"+1-800-555-0100",
"dialinUrl":"url"
}
}
例 2: lobbyBypassSettings を更新する
手記: 読みやすくするために、会議 ID が短縮されました。
PATCH https://graph.microsoft.com/v1.0/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi
Content-Type: application/json
{
"lobbyBypassSettings": {
"isDialInBypassEnabled": true
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Models;
var requestBody = new OnlineMeeting
{
LobbyBypassSettings = new LobbyBypassSettings
{
IsDialInBypassEnabled = true,
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.OnlineMeetings["{onlineMeeting-id}"].PatchAsync(requestBody);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
mgc users online-meetings patch --user-id {user-id} --online-meeting-id {onlineMeeting-id} --body '{\
"lobbyBypassSettings": {\
"isDialInBypassEnabled": true\
}\
}\
'
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest major version. Current major version is $v1.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewOnlineMeeting()
lobbyBypassSettings := graphmodels.NewLobbyBypassSettings()
isDialInBypassEnabled := true
lobbyBypassSettings.SetIsDialInBypassEnabled(&isDialInBypassEnabled)
requestBody.SetLobbyBypassSettings(lobbyBypassSettings)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
onlineMeetings, err := graphClient.Me().OnlineMeetings().ByOnlineMeetingId("onlineMeeting-id").Patch(context.Background(), requestBody, nil)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
OnlineMeeting onlineMeeting = new OnlineMeeting();
LobbyBypassSettings lobbyBypassSettings = new LobbyBypassSettings();
lobbyBypassSettings.setIsDialInBypassEnabled(true);
onlineMeeting.setLobbyBypassSettings(lobbyBypassSettings);
OnlineMeeting result = graphClient.me().onlineMeetings().byOnlineMeetingId("{onlineMeeting-id}").patch(onlineMeeting);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
const onlineMeeting = {
lobbyBypassSettings: {
isDialInBypassEnabled: true
}
};
await client.api('/me/onlineMeetings/MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi')
.update(onlineMeeting);
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\OnlineMeeting;
use Microsoft\Graph\Generated\Models\LobbyBypassSettings;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new OnlineMeeting();
$lobbyBypassSettings = new LobbyBypassSettings();
$lobbyBypassSettings->setIsDialInBypassEnabled(true);
$requestBody->setLobbyBypassSettings($lobbyBypassSettings);
$result = $graphServiceClient->me()->onlineMeetings()->byOnlineMeetingId('onlineMeeting-id')->patch($requestBody)->wait();
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
Import-Module Microsoft.Graph.CloudCommunications
$params = @{
lobbyBypassSettings = @{
isDialInBypassEnabled = $true
}
}
# A UPN can also be used as -UserId.
Update-MgUserOnlineMeeting -UserId $userId -OnlineMeetingId $onlineMeetingId -BodyParameter $params
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.models.online_meeting import OnlineMeeting
from msgraph.generated.models.lobby_bypass_settings import LobbyBypassSettings
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = OnlineMeeting(
lobby_bypass_settings = LobbyBypassSettings(
is_dial_in_bypass_enabled = True,
),
)
result = await graph_client.me.online_meetings.by_online_meeting_id('onlineMeeting-id').patch(request_body)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
応答
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": "MSpkYzE3Njc0Yy04MWQ5LTRhZGItYmZi",
"creationDateTime":"2020-07-03T00:23:39.444642Z",
"startDateTime":"2020-09-09T21:33:30.8546353Z",
"endDateTime":"2020-09-09T22:03:30.8566356Z",
"joinWebUrl":"(redacted)",
"subject":"Patch Meeting Subject",
"autoAdmittedUsers": "EveryoneInCompany",
"isEntryExitAnnounced": true,
"allowedPresenters": "everyone",
"videoTeleconferenceId": "(redacted)",
"participants": {
"organizer": {
"upn": "(redacted)",
"role": "presenter",
"identity": {
"user": {
"id": "dc17674c-81d9-4adb-bfb2-8f6a442e4622",
"displayName": null,
"tenantId": "909c6581-5130-43e9-88f3-fcb3582cde38",
"identityProvider": "AAD"
}
}
},
"attendees": [],
},
"lobbyBypassSettings": {
"scope": "organization",
"isDialInBypassEnabled": true
}
}