名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
agentCollection オブジェクトのプロパティを更新します。
この API は、次の国内クラウド展開で使用できます。
| グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
| ✅ |
❌ |
❌ |
❌ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
| アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
| 委任 (職場または学校のアカウント) |
AgentCollection.ReadWrite.All |
AgentCollection.ReadWrite.Global, AgentCollection.ReadWrite.Quarantined |
| 委任 (個人用 Microsoft アカウント) |
サポートされていません。 |
サポートされていません。 |
| アプリケーション |
AgentCollection.ReadWrite.All |
AgentCollection.ReadWrite.ManagedBy |
重要
前の表に示したアクセス許可に加えて、この API では、特別なコレクションをスコープとする、以下の特権の低い委任されたアクセス許可がサポートされています。
-
AgentCollection.ReadWrite.Global for Global コレクション
-
AgentCollection.ReadWrite.Quarantined for Quarantined コレクション
重要
委任されたアクセス許可を使用する場合、認証されたユーザーには、サポートされているMicrosoft Entra ロールまたはサポートされているロールのアクセス許可を持つカスタム ロールを割り当てる必要があります。
エージェント レジストリ管理者 は、この操作でサポートされる最小限の特権ロールです。
HTTP 要求
PATCH /agentRegistry/agentCollections/{agentCollectionId}
| 名前 |
説明 |
| Authorization |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
| Content-Type |
application/json. 必須です。 |
要求本文
要求本文で、更新するプロパティの値 のみを 指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。
次の表に、更新できるプロパティを示します。
| プロパティ |
型 |
説明 |
| ownerIds |
String collection |
エージェント コレクションの所有者識別子の一覧は、ユーザーまたはサービス プリンシパルにすることができます。 必須です。 |
| managedBy |
文字列 |
コレクションを管理するアプリケーション (サービス プリンシパル) ID。 省略可能。 |
| originatingStore |
文字列 |
コレクションが発生したソース システム/ストア。 省略可能。 |
| createdBy |
String |
コレクションを作成したユーザー。 省略可能。 |
| displayName |
文字列 |
コレクションのフレンドリ名。 必須です。 |
| 説明 |
String |
コレクションの説明/目的。 省略可能。 |
| createdDateTime |
DateTimeOffset |
作成時のタイムスタンプ。 省略可能。 |
| lastModifiedDateTime |
DateTimeOffset |
前回の更新のタイムスタンプ。 省略可能。 |
応答
成功した場合、このメソッドは 204 No Content 応答コードを返します。
例
要求
次の例は要求を示しています。
PATCH https://graph.microsoft.com/beta/agentRegistry/agentCollections/{agentCollectionId}
Content-Type: application/json
{
"displayName": "New Display Name"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new AgentCollection
{
DisplayName = "New Display Name",
};
// 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["{agentCollection-id}"].PatchAsync(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()
displayName := "New Display Name"
requestBody.SetDisplayName(&displayName)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
agentCollections, err := graphClient.AgentRegistry().AgentCollections().ByAgentCollectionId("agentCollection-id").Patch(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.setDisplayName("New Display Name");
AgentCollection result = graphClient.agentRegistry().agentCollections().byAgentCollectionId("{agentCollection-id}").patch(agentCollection);
const options = {
authProvider,
};
const client = Client.init(options);
const agentCollection = {
displayName: 'New Display Name'
};
await client.api('/agentRegistry/agentCollections/{agentCollectionId}')
.version('beta')
.update(agentCollection);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\AgentCollection;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new AgentCollection();
$requestBody->setDisplayName('New Display Name');
$result = $graphServiceClient->agentRegistry()->agentCollections()->byAgentCollectionId('agentCollection-id')->patch($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(
display_name = "New Display Name",
)
result = await graph_client.agent_registry.agent_collections.by_agent_collection_id('agentCollection-id').patch(request_body)
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content