名前空間: 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"
}
応答
次の例は応答を示しています。
HTTP/1.1 204 No Content