名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
新しい agentCollection オブジェクトを 作成します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
❌ |
❌ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
AgentCollection.ReadWrite.All |
注意事項なし。 |
| 委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
| アプリケーション |
AgentCollection.ReadWrite.All |
AgentCollection.ReadWrite.ManagedBy |
重要
前の表に示したアクセス許可に加えて、この API では、次の特権の低い委任されたアクセス許可と、特殊なコレクションをスコープとするアプリケーションのアクセス許可がサポートされています。
-
AgentCollection.ReadWrite.Global for Global コレクション
-
AgentCollection.ReadWrite.Quarantined for Quarantined コレクション
重要
委任されたアクセス許可を使用する場合、認証されたユーザーには、サポートされているMicrosoft Entraロールまたはこの操作に必要なアクセス許可を付与するカスタム ロールを割り当てる必要があります。
エージェント レジストリ管理者 は、この操作でサポートされる最小限の特権ロールです。
HTTP 要求
POST /agentRegistry/agentCollections
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
| Content-Type |
application/json. 必須です。 |
要求本文
要求本文で、 agentCollection オブジェクトの JSON 表現を指定します。
agentCollection の作成時に、次のプロパティを指定できます。
| プロパティ |
型 |
説明 |
| ownerIds |
String collection |
コレクションの管理を許可された所有者の ID。 必須です。 |
| managedBy |
文字列 |
コレクションを管理するアプリケーション (サービス プリンシパル) ID。 省略可能。 |
| originatingStore |
文字列 |
コレクションが発生したソース システム/ストア。 省略可能。 |
| createdBy |
String |
コレクションを作成したユーザー。 省略可能。 |
| displayName |
文字列 |
コレクションのフレンドリ名。 必須です。 |
| 説明 |
String |
コレクションの説明/目的。 省略可能。 |
応答
成功した場合、このメソッドは応答コード 201 Created 、応答本文に agentCollection オブジェクトを返します。
例
要求
次の例は要求を示しています。
POST https://graph.microsoft.com/beta/agentRegistry/agentCollections
Content-Type: application/json
{
"id": "Security Copilot Platform Workspace: 001",
"ownerIds": [
"daf58b0e-44e1-433c-b6b0-ca70cae320b8",
"b9108c41-d2d2-4e78-b073-92f57b752bd0"
],
"managedBy": "719cc904-9700-4e08-9941-fd826cc84c60",
"originatingStore": "Microsoft Security Copilot",
"createdBy": "d47bffae-411a-4de9-8548-05e79bc01f0d",
"displayName": "Conditional Access Agents",
"description": "A collection of agents to manage your organizations conditional access policies"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new AgentCollection
{
Id = "Security Copilot Platform Workspace: 001",
OwnerIds = new List<string>
{
"daf58b0e-44e1-433c-b6b0-ca70cae320b8",
"b9108c41-d2d2-4e78-b073-92f57b752bd0",
},
ManagedBy = "719cc904-9700-4e08-9941-fd826cc84c60",
OriginatingStore = "Microsoft Security Copilot",
CreatedBy = "d47bffae-411a-4de9-8548-05e79bc01f0d",
DisplayName = "Conditional Access Agents",
Description = "A collection of agents to manage your organizations conditional access policies",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.AgentRegistry.AgentCollections.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"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewAgentCollection()
id := "Security Copilot Platform Workspace: 001"
requestBody.SetId(&id)
ownerIds := []string {
"daf58b0e-44e1-433c-b6b0-ca70cae320b8",
"b9108c41-d2d2-4e78-b073-92f57b752bd0",
}
requestBody.SetOwnerIds(ownerIds)
managedBy := "719cc904-9700-4e08-9941-fd826cc84c60"
requestBody.SetManagedBy(&managedBy)
originatingStore := "Microsoft Security Copilot"
requestBody.SetOriginatingStore(&originatingStore)
createdBy := "d47bffae-411a-4de9-8548-05e79bc01f0d"
requestBody.SetCreatedBy(&createdBy)
displayName := "Conditional Access Agents"
requestBody.SetDisplayName(&displayName)
description := "A collection of agents to manage your organizations conditional access policies"
requestBody.SetDescription(&description)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
agentCollections, err := graphClient.AgentRegistry().AgentCollections().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
AgentCollection agentCollection = new AgentCollection();
agentCollection.setId("Security Copilot Platform Workspace: 001");
LinkedList<String> ownerIds = new LinkedList<String>();
ownerIds.add("daf58b0e-44e1-433c-b6b0-ca70cae320b8");
ownerIds.add("b9108c41-d2d2-4e78-b073-92f57b752bd0");
agentCollection.setOwnerIds(ownerIds);
agentCollection.setManagedBy("719cc904-9700-4e08-9941-fd826cc84c60");
agentCollection.setOriginatingStore("Microsoft Security Copilot");
agentCollection.setCreatedBy("d47bffae-411a-4de9-8548-05e79bc01f0d");
agentCollection.setDisplayName("Conditional Access Agents");
agentCollection.setDescription("A collection of agents to manage your organizations conditional access policies");
AgentCollection result = graphClient.agentRegistry().agentCollections().post(agentCollection);
const options = {
authProvider,
};
const client = Client.init(options);
const agentCollection = {
id: 'Security Copilot Platform Workspace: 001',
ownerIds: [
'daf58b0e-44e1-433c-b6b0-ca70cae320b8',
'b9108c41-d2d2-4e78-b073-92f57b752bd0'
],
managedBy: '719cc904-9700-4e08-9941-fd826cc84c60',
originatingStore: 'Microsoft Security Copilot',
createdBy: 'd47bffae-411a-4de9-8548-05e79bc01f0d',
displayName: 'Conditional Access Agents',
description: 'A collection of agents to manage your organizations conditional access policies'
};
await client.api('/agentRegistry/agentCollections')
.version('beta')
.post(agentCollection);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\AgentCollection;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new AgentCollection();
$requestBody->setId('Security Copilot Platform Workspace: 001');
$requestBody->setOwnerIds(['daf58b0e-44e1-433c-b6b0-ca70cae320b8', 'b9108c41-d2d2-4e78-b073-92f57b752bd0', ]);
$requestBody->setManagedBy('719cc904-9700-4e08-9941-fd826cc84c60');
$requestBody->setOriginatingStore('Microsoft Security Copilot');
$requestBody->setCreatedBy('d47bffae-411a-4de9-8548-05e79bc01f0d');
$requestBody->setDisplayName('Conditional Access Agents');
$requestBody->setDescription('A collection of agents to manage your organizations conditional access policies');
$result = $graphServiceClient->agentRegistry()->agentCollections()->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.models.agent_collection import AgentCollection
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = AgentCollection(
id = "Security Copilot Platform Workspace: 001",
owner_ids = [
"daf58b0e-44e1-433c-b6b0-ca70cae320b8",
"b9108c41-d2d2-4e78-b073-92f57b752bd0",
],
managed_by = "719cc904-9700-4e08-9941-fd826cc84c60",
originating_store = "Microsoft Security Copilot",
created_by = "d47bffae-411a-4de9-8548-05e79bc01f0d",
display_name = "Conditional Access Agents",
description = "A collection of agents to manage your organizations conditional access policies",
)
result = await graph_client.agent_registry.agent_collections.post(request_body)
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.agentCollection",
"id": "c2d9e3ff-01a4-890c-f2bc-8edd3bc2eb24",
"ownerIds": [
"String"
],
"managedBy": "String",
"originatingStore": "String",
"createdBy": "String",
"displayName": "String",
"description": "String",
"createdDateTime": "String (timestamp)",
"lastModifiedDateTime": "String (timestamp)"
}