名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
エージェント ID ブループリントは、Microsoft Entra ID エコシステム内でエージェント ID を作成するためのテンプレートとして機能します。
アプリケーションから継承します。
このリソースは、ここに記載されているプロパティを超える追加のプロパティを許可するオープン型です。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | agentIdentityBlueprint コレクション | agentIdentityBlueprint オブジェクトとそのプロパティの一覧を取得します。 |
| Create | agentIdentityBlueprint | 新しい agentIdentityBlueprint を作成 (登録) します。 |
| Get | agentIdentityBlueprint | agentIdentityBlueprint オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | agentIdentityBlueprint | agentIdentityBlueprint オブジェクトのプロパティを更新します。 |
| Upsert | agentIdentityBlueprint | 新しいエージェント ID ブループリントが存在しない場合は作成するか、既存のブループリントのプロパティを更新します。 |
| 削除 | なし | agentIdentityBlueprint オブジェクトを削除します。 |
| 資格情報 | ||
| パスワードを追加する | passwordCredential | エージェント ID ブループリントに強力なパスワードまたはシークレットを追加します。 |
| パスワードを削除する | passwordCredential | エージェント ID ブループリントからパスワードまたはシークレットを削除します。 |
| キーの追加 | keyCredential | キー資格情報をエージェント ID ブループリントに追加します。 |
| キーの削除 | なし | エージェント ID ブループリントからキー資格情報を削除します。 |
| List federatedIdentityCredential | federatedIdentityCredential のコレクション | federatedIdentityCredential オブジェクトとそのプロパティの一覧を取得します。 |
| Create federatedIdentityCredential | federatedIdentityCredential | 新しい federatedIdentityCredential オブジェクトを 作成します。 |
| Get federatedIdentityCredential | federatedIdentityCredential | federatedIdentityCredential オブジェクトのプロパティを取得します。 |
| Update federatedIdentityCredential | なし | federatedIdentityCredential オブジェクトのプロパティを更新します。 |
| Upsert federatedIdentityCredential | federatedIdentityCredential | 新しい federatedIdentityCredential が存在しない場合は作成するか、既存の federatedIdentityCredential オブジェクトのプロパティを更新します。 |
| Delete federatedIdentityCredential | なし | federatedIdentityCredential オブジェクトを削除します。 |
| 削除済みアイテム | ||
| List | directoryObject コレクション | 最近削除されたエージェント ID の一覧を取得します。 |
| Get | directoryObject | 最近削除されたエージェント ID のプロパティを取得します。 |
| 復元 | directoryObject | 最近削除したエージェント ID を復元します。 |
| 完全に削除 | なし | エージェント ID を完全に削除します。 |
| 所有者 | ||
| 所有者を一覧表示する | directoryObject コレクション | このエージェント ID ブループリント プリンシパルの所有者を取得します。 |
| 所有者の追加 | directoryObject | このエージェント ID ブループリント プリンシパルに所有者を割り当てます。 |
| 所有者を削除する | なし | このエージェント ID ブループリント プリンシパルから所有者を削除します。 |
| Sponsors | ||
| List sponsors | directoryObject コレクション | このエージェント ID ブループリントのスポンサーを取得します。 スポンサーは、エージェント ID インスタンスのライフサイクルを承認および管理できるユーザーまたはサービス プリンシパルです。 |
| スポンサーを追加する | directoryObject | スポンサー コレクションに投稿してスポンサーを追加します。 |
| Remove sponsors | なし | directoryObject オブジェクトを削除します。 |
| 認証済発行元 | ||
| Set | なし | アプリケーションの認証済みの発行元を設定する。 |
| 設定解除する | なし | アプリケーションの認証済み発行元を解除します。 |
プロパティ
重要
このリソースは アプリケーションから継承されますが、一部のプロパティは適用されず、 null または既定値が返されます。 これらのプロパティは、次の表から除外されます。
| プロパティ | 型 | 説明 |
|---|---|---|
| api | apiApplication | Web API を実装するエージェント ID ブループリントの設定を指定します。 アプリケーションから継承されます。 |
| appId | String | Microsoft Entra IDによって割り当てられるエージェント ID ブループリントの一意識別子。 null 許容ではありません。 読み取り専用です。 アプリケーションから継承されます。 |
| appRoles | appRole コレクション | エージェント ID ブループリントに対して定義されているロールのコレクション。 アプリ ロールの割り当てを使用して、ユーザー、グループ、または他のアプリケーションのサービス プリンシパルにロールを割り当てることができます。 null 許容ではありません。 アプリケーションから継承されます。 |
| 認定 | 認定 | エージェント ID ブループリントの認定状態を指定します。 アプリケーションから継承されます。 |
| createdByAppId | String | このエージェント ID ブループリントを作成したアプリケーションの一意識別子。 Microsoft Entra IDによって内部的に設定します。 読み取り専用です。 アプリケーションから継承されます。 |
| createdDateTime | DateTimeOffset | エージェント ID ブループリントが登録された日時。 DateTimeOffset 型は、ISO 8601 形式を使用して日付と時刻の情報を表し、常に UTC 時間です。 読み取り専用です。 アプリケーションから継承されます。 |
| createdByAppId | String | このエージェント ID ブループリントを作成したアプリケーションの appId (Microsoft Entra 管理センターのアプリケーション (クライアント) ID と呼ばれます)。 Microsoft Entra IDによって内部的に設定します。 読み取り専用です。 アプリケーションから継承されます。 |
| 説明 | String | エージェント ID ブループリントの説明をエンド ユーザーに提供するフリー テキスト フィールド。 許可される最大サイズは 1,024 文字です。 アプリケーションから継承されます。 |
| disabledByMicrosoftStatus | String | 登録済みのエージェント ID ブループリントが Microsoft によって無効にされているかどうかを指定します。 使用可能な値は、null (既定値)、NotDisabled、DisabledDueToViolationOfServicesAgreement です (疑わしいアクティビティ、悪用されたアクティビティ、悪意のあるアクティビティ、またはMicrosoft サービス規約の違反が理由になります)。
アプリケーションから継承されます。 |
| displayName | 文字列 | エージェント ID ブループリントの表示名。 最大文字数は 256 文字です。 アプリケーションから継承されます。 |
| groupMembershipClaims | 文字列 | エージェント ID ブループリントで想定されるユーザーまたは OAuth 2.0 アクセス トークンで発行された groups 要求を構成します。 この属性を設定するには、None、SecurityGroup (セキュリティ グループとMicrosoft Entra ロールの場合)、All (サインインしているユーザーがメンバーであるすべてのセキュリティ グループ、配布グループ、およびMicrosoft Entraディレクトリ ロールを取得します) のいずれかの文字列値を使用します。
アプリケーションから継承されます。 |
| id | 文字列 | エージェント ID ブループリント オブジェクトの一意識別子。 このプロパティは、Microsoft Entra 管理センターのオブジェクト ID と呼ばれます。 キー。 null 許容ではありません。 読み取り専用です。 directoryObject から継承されます。 |
| identifierUris | String collection | アプリ ID URI とも呼ばれるこの値は、エージェント ID ブループリントがリソース アプリとして使用されるときに設定されます。 identifierUris は API のコードで参照するスコープのプレフィックスとして機能し、Microsoft Entra ID全体でグローバルに一意である必要があります。 null 許容ではありません。 アプリケーションから継承されます。 |
| info | informationalUrl | エージェント ID ブループリントの基本的なプロファイル情報 (マーケティング、サポート、サービス条件、プライバシーに関する声明 URL など)。 サービス利用規約とプライバシーに関する声明は、ユーザーの同意エクスペリエンスからユーザーに提示されます。 アプリケーションから継承されます。 |
| keyCredentials | keyCredential コレクション | エージェント ID ブループリントに関連付けられているキー資格情報のコレクション。 null 許容ではありません。 アプリケーションから継承されます。 |
| optionalClaims | optionalClaims | アプリケーション開発者は、microsoft セキュリティ トークン サービスによってアプリケーションに送信される要求を指定するために、Microsoft Entra エージェント ID ブループリントでオプションの要求を構成できます。 アプリケーションから継承されます。 |
| passwordCredentials | passwordCredential コレクション | エージェント ID ブループリントに関連付けられているパスワード資格情報のコレクション。 null 許容ではありません。
アプリケーションから継承されます。 パスワードの追加 API を呼び出して、エージェント ID ブループリントの作成後に パスワードを追加 することもできます。 |
| publisherDomain | String | エージェント ID ブループリントの検証済み発行元ドメイン。 読み取り専用です。 アプリケーションから継承されます。 |
| serviceManagementReference | String | サービスまたは資産管理データベースからアプリケーションまたはサービスの連絡先情報を参照します。 Null 許容型。 アプリケーションから継承されます。 |
| signInAudience | 文字列 | 現在のエージェント ID ブループリントでサポートされている Microsoft アカウントを指定します。 使用可能な値は、 AzureADMyOrg (既定値)、 AzureADMultipleOrgs、 AzureADandPersonalMicrosoftAccount、 PersonalMicrosoftAccountです。
アプリケーションから継承されます。 |
| tags | String collection | エージェント ID ブループリントの分類と識別に使用できるカスタム文字列。 null 許容ではありません。 アプリケーションから継承されます。 |
| tokenEncryptionKeyId | Guid | keyCredentials コレクションにある公開キーの keyId を指定します。 構成すると、Microsoft Entra IDは、このプロパティが指すキーを使用して、出力されるすべてのトークンを暗号化します。 アプリケーションから継承されます。 |
| uniqueName | String | エージェント ID ブループリントに割り当て、代替キーとして使用できる一意識別子。 不変です。 読み取り専用です。 アプリケーションから継承されます。 |
| verifiedPublisher | verifiedPublisher | エージェント ID ブループリントの検証済み発行元を指定します。 アプリケーションから継承されます。 |
| Web | webApplication | Web アプリケーションの設定を指定します。 アプリケーションから継承されます。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| appManagementPolicies | appManagementPolicy コレクション | このエージェント ID ブループリントに適用された appManagementPolicy。 microsoft.graph.application から継承 |
| federatedIdentityCredentials | federatedIdentityCredential のコレクション | エージェント ID ブループリントのフェデレーション ID。 microsoft.graph.application から継承 |
| owners | directoryObject コレクション | このエージェント ID ブループリントの所有者であるディレクトリ オブジェクト。 所有者は、このオブジェクトの変更を許可される管理者以外のユーザーまたはサービス プリンシパルのセットです。 読み取り専用です。 Null 許容型。 microsoft.graph.application から継承 |
| スポンサー | directoryObject コレクション | このエージェント ID ブループリントのスポンサー。 スポンサーは、エージェント ID インスタンスのライフサイクルを承認および管理できるユーザーまたはグループです。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。 既定では、すべてのプロパティのサブセットのみが返されます。 その他のすべてのプロパティは、 $selectを使用してのみ取得できます。
{
"@odata.type": "#microsoft.graph.agentIdentityBlueprint",
"id": "String (identifier)",
"appId": "String",
"identifierUris": ["String"],
"createdByAppId": "String",
"createdDateTime": "String (timestamp)",
"description": "String",
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"groupMembershipClaims": "String",
"publisherDomain": "String",
"signInAudience": "String",
"tags": ["String"],
"tokenEncryptionKeyId": "Guid",
"uniqueName": "String",
"serviceManagementReference": "String",
"certification": {
"@odata.type": "microsoft.graph.certification"
},
"optionalClaims": {
"@odata.type": "microsoft.graph.optionalClaims"
},
"api": {
"@odata.type": "microsoft.graph.apiApplication"
},
"appRoles": [
{
"@odata.type": "microsoft.graph.appRole"
}
],
"info": {
"@odata.type": "microsoft.graph.informationalUrl"
},
"keyCredentials": [
{
"@odata.type": "microsoft.graph.keyCredential"
}
],
"passwordCredentials": [
{
"@odata.type": "microsoft.graph.passwordCredential"
}
],
"verifiedPublisher": {
"@odata.type": "microsoft.graph.verifiedPublisher"
},
"web": {
"@odata.type": "microsoft.graph.webApplication"
}
}