名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
distributionList にメンバーを追加します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
❌ |
❌ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
Contacts.ReadWrite |
注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) |
Contacts.ReadWrite |
注意事項なし。 |
| アプリケーション |
Contacts.ReadWrite |
注意事項なし。 |
HTTP 要求
POST /me/distributionLists/{distributionList-id}/addMembers
POST /users/{id | userPrincipalName}/distributionLists/{distributionList-id}/addMembers
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
| Content-Type |
application/json. 必須です。 |
要求本文
要求本文で、パラメーターの JSON 表現を指定します。
次の表に、このアクションを呼び出すときに必要なパラメーターを示します。
| パラメーター |
型 |
説明 |
| members |
メンバー コレクション |
配布リストに追加するメンバー。 各メンバーには 、型 と キー、 memberId、またはその両方を含める必要があります。 必須です。 |
応答
成功した場合、このアクションは応答本文で 200 OK 応答コードと distributionList オブジェクトを返します。
例
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/me/distributionLists/AAMkAGI2THVSAAA=/addMembers
Content-Type: application/json
{
"members": [
{
"displayName": "Megan Bowen",
"key": "MeganB@contoso.com",
"type": "mailbox"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Me.DistributionLists.Item.AddMembers;
using Microsoft.Graph.Beta.Models;
var requestBody = new AddMembersPostRequestBody
{
Members = new List<Member>
{
new Member
{
DisplayName = "Megan Bowen",
Key = "MeganB@contoso.com",
Type = RecipientType.Mailbox,
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.DistributionLists["{distributionList-id}"].AddMembers.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphusers "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphusers.NewItemAddMembersPostRequestBody()
member := graphmodels.NewMember()
displayName := "Megan Bowen"
member.SetDisplayName(&displayName)
key := "MeganB@contoso.com"
member.SetKey(&key)
type := graphmodels.MAILBOX_RECIPIENTTYPE
member.SetType(&type)
members := []graphmodels.Memberable {
member,
}
requestBody.SetMembers(members)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
addMembers, err := graphClient.Me().DistributionLists().ByDistributionListId("distributionList-id").AddMembers().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.users.item.distributionlists.item.addmembers.AddMembersPostRequestBody addMembersPostRequestBody = new com.microsoft.graph.beta.users.item.distributionlists.item.addmembers.AddMembersPostRequestBody();
LinkedList<Member> members = new LinkedList<Member>();
Member member = new Member();
member.setDisplayName("Megan Bowen");
member.setKey("MeganB@contoso.com");
member.setType(RecipientType.Mailbox);
members.add(member);
addMembersPostRequestBody.setMembers(members);
var result = graphClient.me().distributionLists().byDistributionListId("{distributionList-id}").addMembers().post(addMembersPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const distributionList = {
members: [
{
displayName: 'Megan Bowen',
key: 'MeganB@contoso.com',
type: 'mailbox'
}
]
};
await client.api('/me/distributionLists/AAMkAGI2THVSAAA=/addMembers')
.version('beta')
.post(distributionList);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Users\Item\DistributionLists\Item\AddMembers\AddMembersPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\Member;
use Microsoft\Graph\Beta\Generated\Models\RecipientType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new AddMembersPostRequestBody();
$membersMember1 = new Member();
$membersMember1->setDisplayName('Megan Bowen');
$membersMember1->setKey('MeganB@contoso.com');
$membersMember1->setType(new RecipientType('mailbox'));
$membersArray []= $membersMember1;
$requestBody->setMembers($membersArray);
$result = $graphServiceClient->me()->distributionLists()->byDistributionListId('distributionList-id')->addMembers()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.users.item.distributionlists.item.add_members.add_members_post_request_body import AddMembersPostRequestBody
from msgraph_beta.generated.models.member import Member
from msgraph_beta.generated.models.recipient_type import RecipientType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = AddMembersPostRequestBody(
members = [
Member(
display_name = "Megan Bowen",
key = "MeganB@contoso.com",
type = RecipientType.Mailbox,
),
],
)
result = await graph_client.me.distribution_lists.by_distribution_list_id('distributionList-id').add_members.post(request_body)
応答
次の例は応答を示しています。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/distributionLists/$entity",
"id": "AAMkAGI2THVSAAA=",
"displayName": "Project Team",
"lastModifiedDateTime": "2024-03-17T11:00:00Z"
}