宣言型エージェント マニフェストの機能 ID の取得
- [アーティクル]
-
-
この記事では、開発者が、宣言型エージェント マニフェストの capabilities
セクション内に Graph コネクタと SharePoint/OneDrive ファイルを含めるために必要な ID を取得するためのメソッドについて説明します。 開発者は、Microsoft Graph エクスプローラーまたは Microsoft Graph PowerShell を使用できます。
Microsoft Graph コネクタの概要
このセクションでは、開発者がマニフェストの Microsoft Graph コネクタオブジェクトの Connection オブジェクトの connection_id
プロパティで設定する値を取得する方法について説明します。
重要
Microsoft Graph コネクタのクエリには、管理者アカウントが必要です。
Microsoft Graph エクスプローラーに移動し、管理者アカウントでサインインします。
右上隅にあるユーザー アバターを選択し、[ アクセス許可に同意する] を選択します。
ExternalConnection.Read.All
を検索し、そのアクセス許可の [同意] を選択します。 プロンプトに従って同意を付与します。
要求フィールドに「 https://graph.microsoft.com/v1.0/external/connections?$select=id,name
」と入力し、[ クエリの実行] を選択します。
目的のコネクタを見つけて、その id
プロパティをコピーします。 たとえば、次の応答で GitHub Repos コネクタを使用するには、 githubrepos
値をコピーします。
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#connections(id,name)",
"value": [
{
"id": "applianceparts",
"name": "Appliance Parts Inventory"
},
{
"id": "githubrepos",
"name": "GitHub Repos"
}
]
}
次のコードをGetGraphConnectorIds.ps1という名前の新しいファイル に コピーします。
param(
[Parameter(Mandatory = $false)]
[Switch]
$StayConnected = $false
)
# Requires an admin
Connect-MgGraph -Scopes "ExternalConnection.Read.All" `
-UseDeviceCode -ErrorAction Stop -NoWelcome
Get-MgExternalConnection -Property "Name", "Id" | Format-Table "Name", "Id"
if ($StayConnected -eq $false) {
Disconnect-MgGraph | Out-Null
Write-Host "Disconnected from Microsoft Graph"
}
else {
Write-Host
Write-Host -ForegroundColor Yellow `
"The connection to Microsoft Graph is still active. To disconnect, use Disconnect-MgGraph"
}
GetGraphConnectorIds.ps1 が配置されているディレクトリで PowerShell 7 を開き、次のコマンドを使用してスクリプトを実行します。
.\GetGraphConnectorIds.ps1
ブラウザーを開き、 https://microsoft.com/devicelogin
を参照します。 プロンプトによって提供されるコードを入力し、サインインと同意フローを完了します。
To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code BQGGRREGN to authenticate.
目的のコネクタを見つけて、その Id
プロパティをコピーします。 たとえば、次の応答で GitHub Repos コネクタを使用するには、 githubrepos
値をコピーします。
Name Id
---- --
Appliance Parts Inventory applianceparts
GitHub Repos githubrepos
SharePoint ID の取得
このセクションでは、開発者が、OneDriveAndSharePoint
オブジェクトの items_by_sharepoint_ids
プロパティ内の次のプロパティで設定する値を取得する方法について説明します。
site_id
list_id
web_id
unique_id
Microsoft Graph エクスプローラーに移動し、管理者アカウントでサインインします。
右上隅にあるユーザー アバターを選択し、[ アクセス許可に同意する] を選択します。
Sites.Read.All
を検索し、そのアクセス許可の [同意] を選択します。 プロンプトに従って同意を付与します。
Files.Read.All
に対してこのプロセスを繰り返します。
[メソッド] ドロップダウンを [POST] に変更し、要求フィールドに「 https://graph.microsoft.com/v1.0/search/query
」と入力します。
要求本文に次を追加し、https://yoursharepointsite.com/sites/YourSite/Shared%20Documents/YourFile.docx
を ID を取得するファイルまたはフォルダーの URL に置き換えます。
{
"requests": [
{
"entityTypes": [
"driveItem"
],
"query": {
"queryString": "Path:\"https://yoursharepointsite.com/sites/YourSite/Shared%20Documents/YourFile.docx\""
},
"fields": [
"fileName",
"listId",
"webId",
"siteId",
"uniqueId"
]
}
]
}
[クエリの実行] を選択します。
目的のファイルを見つけて、その listId
、 webId
、 siteId
、 uniqueId
の各プロパティをコピーします。
{
"value": [
{
"searchTerms": [],
"hitsContainers": [
{
"hits": [
{
"hitId": "01AJOINAHZHINTBHPESZBISPIPSJG3D5EO",
"rank": 1,
"summary": "Reorder policy Our reorder policy for suppliers is straightforward and designed to maintain cost-efficiency and inventory control. We kindly request that no order exceeds a total",
"resource": {
"@odata.type": "#microsoft.graph.driveItem",
"listItem": {
"@odata.type": "#microsoft.graph.listItem",
"id": "301b3af9-e49d-4296-893d-0f924db1f48e",
"fields": {
"fileName": "YourFile.docx",
"listId": "12fde922-4fab-4238-8227-521829cd1099",
"webId": "a25fab47-f3b9-4fa3-8ed9-1acb83c12a4f",
"siteId": "5863dfa5-b39d-4cd1-92a6-5cf539e04971",
"uniqueId": "{301b3af9-e49d-4296-893d-0f924db1f48e}"
}
}
}
}
],
"total": 1,
"moreResultsAvailable": false
}
]
}
]
}
次のコードをGetSharePointIds.ps1という名前の新しいファイル に コピーします。
param(
[Parameter(Mandatory = $true,
HelpMessage = "The URL path to the file or folder to search for")]
[String]
$FilePath,
[Parameter(Mandatory = $false)]
[Switch]
$StayConnected = $false
)
Connect-MgGraph -Scopes "Sites.Read.All Files.Read.All" `
-UseDeviceCode -ErrorAction Stop -NoWelcome
$searchQuery = @{
requests = @(
@{
entityTypes = @("driveItem")
query = @{
queryString = "Path:""" + $FilePath + """"
}
fields = @(
"fileName"
"listId"
"webId"
"siteId"
"uniqueId"
)
}
)
}
$results = Invoke-MgQuerySearch -Body $searchQuery
foreach($hitContainer in $results.HitsContainers)
{
foreach($hit in $hitContainer.Hits)
{
Write-Output $hit.Resource.AdditionalProperties["listItem"]["fields"] | Format-Table
}
}
if ($StayConnected -eq $false) {
Disconnect-MgGraph | Out-Null
Write-Host "Disconnected from Microsoft Graph"
}
else {
Write-Host
Write-Host -ForegroundColor Yellow `
"The connection to Microsoft Graph is still active. To disconnect, use Disconnect-MgGraph"
}
GetSharePointIds.ps1 が配置されているディレクトリで PowerShell 7 を開き、次のコマンドでスクリプトを実行し、https://yoursharepointsite.com/sites/YourSite/Shared%20Documents/YourFile.docx
を ID を取得するファイルまたはフォルダーの URL に置き換えます。
.\GetSharePointIds.ps1 -FilePath "https://yoursharepointsite.com/sites/YourSite/Shared%20Documents/YourFile.docx"
ブラウザーを開き、 https://microsoft.com/devicelogin
を参照します。 プロンプトによって提供されるコードを入力し、サインインと同意フローを完了します。
To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code BQGGRREGN to authenticate.
目的のファイルを見つけて、その値をコピーします。
Key Value
--- -----
fileName YourFile.docx
listId 12fde922-4fab-4238-8227-521829cd1099
webId a25fab47-f3b9-4fa3-8ed9-1acb83c12a4f
siteId 5863dfa5-b39d-4cd1-92a6-5cf539e04971
uniqueId {301b3af9-e49d-4296-893d-0f924db1f48e}