Resources - Resources
Azure Resource Manager によって管理されるリソースに対して、要求で指定されたスコープを照会します。
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
URI パラメーター
Name | In | Required | Type | Description |
---|---|---|---|---|
api-version
|
query | True |
|
API のバージョン。 |
要求本文
Name | Required | Type | Description |
---|---|---|---|
query | True |
|
リソース クエリ。 |
facets |
クエリ結果に対して計算されるファセット要求の配列。 |
||
managementGroups |
|
クエリを実行する Azure 管理グループ。 例: [ 'mg1', 'mg2' ] |
|
options |
クエリ評価オプション |
||
subscriptions |
|
クエリを実行する Azure サブスクリプション。 |
応答
Name | Type | Description |
---|---|---|
200 OK |
クエリ操作の結果 |
|
Other Status Codes |
要求の処理中にエラーが発生しました。 特定のエラーを特定するには、error.code パラメーターを参照してください。 |
セキュリティ
azure_auth
OAuth2 FlowをAzure Active Directoryする
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | ユーザー アカウントを偽装する |
例
Access a properties field
Sample Request
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
{
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
],
"query": "Resources | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by tostring(properties.storageProfile.osDisk.osType)"
}
Sample Response
{
"totalRecords": 2,
"count": 2,
"resultTruncated": "false",
"facets": [],
"data": [
{
"properties_storageProfile_osDisk_osType": "Linux",
"count": 7
},
{
"properties_storageProfile_osDisk_osType": "Windows",
"count": 23
}
]
}
Basic management group query
Sample Request
Sample Response
{
"totalRecords": 3,
"count": 3,
"resultTruncated": "false",
"facets": [],
"data": [
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface",
"name": "myNetworkInterface",
"type": "microsoft.network/networkinterfaces",
"location": "centralus",
"tags": {
"tag1": "Value1"
}
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet",
"name": "myVnet",
"type": "microsoft.network/virtualnetworks",
"location": "westus",
"tags": {}
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp",
"name": "myPublicIp",
"type": "microsoft.network/publicipaddresses",
"location": "westus",
"tags": {}
}
]
}
Basic query
Sample Request
Sample Response
{
"totalRecords": 3,
"count": 3,
"resultTruncated": "false",
"facets": [],
"data": [
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface",
"name": "myNetworkInterface",
"type": "microsoft.network/networkinterfaces",
"location": "centralus",
"tags": {
"tag1": "Value1"
}
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet",
"name": "myVnet",
"type": "microsoft.network/virtualnetworks",
"location": "westus",
"tags": {}
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp",
"name": "myPublicIp",
"type": "microsoft.network/publicipaddresses",
"location": "westus",
"tags": {}
}
]
}
Basic tenant query
Sample Request
Sample Response
{
"totalRecords": 3,
"count": 3,
"resultTruncated": "false",
"facets": [],
"data": [
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface",
"name": "myNetworkInterface",
"type": "microsoft.network/networkinterfaces",
"location": "centralus",
"tags": {
"tag1": "Value1"
}
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet",
"name": "myVnet",
"type": "microsoft.network/virtualnetworks",
"location": "westus",
"tags": {}
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp",
"name": "myPublicIp",
"type": "microsoft.network/publicipaddresses",
"location": "westus",
"tags": {}
}
]
}
Complex query
Sample Request
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
{
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
],
"query": "Resources | project id, name, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by location | top 3 by count_"
}
Sample Response
{
"totalRecords": 3,
"count": 3,
"resultTruncated": "false",
"facets": [],
"data": [
{
"location": "centralus",
"count_": 11
},
{
"location": "eastus",
"count_": 11
},
{
"location": "southcentralus",
"count_": 3
}
]
}
Filter resources
Sample Request
Sample Response
{
"totalRecords": 3,
"count": 3,
"resultTruncated": "false",
"facets": [],
"data": [
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/myVm1",
"name": "myVm1",
"type": "microsoft.compute/virtualmachines",
"location": "centralus"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Compute/virtualMachines/myVirtualMachine",
"name": "myVirtualMachine",
"type": "microsoft.compute/virtualmachines",
"location": "eastus"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG3/providers/Microsoft.Compute/virtualMachines/testVm",
"name": "testVm",
"type": "microsoft.compute/virtualmachines",
"location": "eastus"
}
]
}
First page query
Sample Request
Sample Response
{
"totalRecords": 386,
"count": 3,
"resultTruncated": "false",
"facets": [],
"$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ==",
"data": [
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/yetanothertest_OsDisk_1_f396cbcb625a457bb69fe2abf5975820",
"name": "yetanothertest_OsDisk_1_f396cbcb625a457bb69fe2abf5975820",
"type": "microsoft.compute/disks",
"location": "eastus"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA",
"name": "TestAA",
"type": "microsoft.automation/automationaccounts",
"location": "westcentralus"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA/runbooks/TestRB",
"name": "TestRB",
"type": "microsoft.automation/automationaccounts/runbooks",
"location": "westcentralus"
}
]
}
Next page query
Sample Request
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
{
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
],
"query": "Resources | where name contains 'test' | project id, name, type, location",
"options": {
"$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ=="
}
}
Sample Response
{
"totalRecords": 386,
"count": 3,
"resultTruncated": "false",
"facets": [],
"$skipToken": "eyAibm8yIjogImx1Y2syIiwgImJ1dDIiOiAibmljZTIiLCAidHJ5MiI6ICIhIiB9",
"data": [
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/second_OsDisk_dddddbcb625a457bb69fe2abf5975820",
"name": "second_OsDisk_dddddbcb625a457bb69fe2abf5975820",
"type": "microsoft.compute/disks",
"location": "eastus"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/AATest",
"name": "AATest",
"type": "microsoft.automation/automationaccounts",
"location": "westcentralus"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA/runbooks/RBTest",
"name": "RBTest",
"type": "microsoft.automation/automationaccounts/runbooks",
"location": "westcentralus"
}
]
}
Query with a facet request
Sample Request
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
{
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
],
"query": "Resources | where type =~ 'Microsoft.Compute/virtualMachines' | project id, name, location, resourceGroup, properties.storageProfile.osDisk.osType | limit 5",
"facets": [
{
"expression": "location",
"options": {
"sortOrder": "desc",
"$top": 3
}
},
{
"expression": "properties.storageProfile.osDisk.osType",
"options": {
"sortOrder": "desc",
"$top": 3
}
},
{
"expression": "nonExistingColumn",
"options": {
"sortOrder": "desc",
"$top": 3
}
},
{
"expression": "resourceGroup",
"options": {
"sortBy": "tolower(resourceGroup)",
"sortOrder": "asc",
"$top": 3
}
},
{
"expression": "resourceGroup",
"options": {
"filter": "resourceGroup contains 'test'",
"$top": 3
}
}
]
}
Sample Response
{
"totalRecords": 5,
"count": 5,
"resultTruncated": "false",
"data": [
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/B-TEST-RG/providers/Microsoft.Compute/virtualMachines/myTestVm",
"name": "myTestVm",
"location": "eastus",
"resourceGroup": "B-TEST-RG",
"properties_storageProfile_osDisk_osType": "Windows"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/c-rg/providers/Microsoft.Compute/virtualMachines/myTestAccountVm",
"name": "myTestAccountVm",
"location": "westcentralus",
"resourceGroup": "c-rg",
"properties_storageProfile_osDisk_osType": "Windows"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/I-RG/providers/Microsoft.Compute/virtualMachines/yetanothertest",
"name": "yetanothertest",
"location": "eastus",
"resourceGroup": "I-RG",
"properties_storageProfile_osDisk_osType": "Linux"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/x-test-rg/providers/Microsoft.Compute/virtualMachines/drafttest1bux4cv7a7q3aw",
"name": "drafttest1bux4cv7a7q3aw",
"location": "southcentralus",
"resourceGroup": "x-test-rg",
"properties_storageProfile_osDisk_osType": "Linux"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/y-rg/providers/Microsoft.Compute/virtualMachines/testvmntp25370",
"name": "testvmntp25370",
"location": "eastus",
"resourceGroup": "y-rg",
"properties_storageProfile_osDisk_osType": "Windows"
}
],
"facets": [
{
"expression": "location",
"resultType": "FacetResult",
"totalRecords": 3,
"count": 3,
"data": [
{
"location": "eastus",
"count": 3
},
{
"location": "southcentralus",
"count": 1
},
{
"location": "westcentralus",
"count": 1
}
]
},
{
"expression": "properties.storageProfile.osDisk.osType",
"resultType": "FacetResult",
"totalRecords": 2,
"count": 2,
"data": [
{
"properties_storageProfile_osDisk_osType": "Linux",
"count": 2
},
{
"properties_storageProfile_osDisk_osType": "Windows",
"count": 3
}
]
},
{
"expression": "nonExistingColumn",
"resultType": "FacetError",
"errors": [
{
"code": "NoValidColumns",
"message": "No valid columns in facet expression."
},
{
"code": "InvalidColumnNames",
"message": "Invalid column names: [nonExistingColumn]."
}
]
},
{
"expression": "resourceGroup",
"resultType": "FacetResult",
"totalRecords": 5,
"count": 3,
"data": [
{
"resourceGroup": "B-TEST-RG",
"count": 1
},
{
"resourceGroup": "c-rg",
"count": 1
},
{
"resourceGroup": "I-RG",
"count": 1
}
]
},
{
"expression": "resourceGroup",
"resultType": "FacetResult",
"totalRecords": 2,
"count": 2,
"data": [
{
"resourceGroup": "B-TEST-RG",
"count": 1
},
{
"resourceGroup": "x-test-rg",
"count": 1
}
]
}
]
}
Random page query
Sample Request
Sample Response
{
"totalRecords": 386,
"count": 2,
"resultTruncated": "false",
"facets": [],
"$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ==",
"data": [
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/third_OsDisk_dddddbcb625a457bb69fe2abf5975820",
"name": "third_OsDisk_dddddbcb625a457bb69fe2abf5975820",
"type": "microsoft.compute/disks",
"location": "eastus"
},
{
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/CCTest",
"name": "CCTest",
"type": "microsoft.automation/automationaccounts",
"location": "westcentralus"
}
]
}
Summarize resources by location
Sample Request
Sample Response
{
"totalRecords": 3,
"count": 3,
"resultTruncated": "false",
"facets": [],
"data": [
{
"location": "centralus"
},
{
"location": "eastus"
},
{
"location": "westus"
}
]
}
定義
Error |
エラー情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答。 |
Facet |
実行でエラーが発生したファセット。 |
Facet |
クエリ結果に対する追加の統計 (ファセット) を計算する要求。 |
Facet |
ファセット評価のオプション |
Facet |
クエリの応答に関する追加の統計を含むファセットが正常に実行されました。 |
Facet |
選択した列による並べ替え順序 (既定ではカウント)。 |
Query |
実行するクエリについて説明します。 |
Query |
クエリ評価のオプション |
Query |
クエリ結果。 |
Result |
クエリ結果が返される形式を定義します。 |
Result |
クエリ結果が切り捨てられるかどうかを示します。 |
Error
エラー情報。
Name | Type | Description |
---|---|---|
code |
|
特定のエラーを識別するエラー コード。 |
details |
エラーの詳細 |
|
message |
|
人間が判読できるエラー メッセージ。 |
ErrorDetails
エラーの詳細。
Name | Type | Description |
---|---|---|
code |
|
特定のエラーを識別するエラー コード。 |
message |
|
人間が判読できるエラー メッセージ。 |
ErrorResponse
エラー応答。
Name | Type | Description |
---|---|---|
error |
エラー情報。 |
FacetError
実行でエラーが発生したファセット。
Name | Type | Description |
---|---|---|
errors |
検出されたファセット エラーと詳細を含む配列。 |
|
expression |
|
ファセット式。対応するファセット要求と同じです。 |
resultType | string: |
結果の種類 |
FacetRequest
クエリ結果に対する追加の統計 (ファセット) を計算する要求。
Name | Type | Description |
---|---|---|
expression |
|
集計する列または列の一覧 |
options |
ファセット評価のオプション |
FacetRequestOptions
ファセット評価のオプション
Name | Type | Default Value | Description |
---|---|---|---|
$top |
|
返されるファセット行の最大数。 |
|
filter |
|
実際のファセットの直前に、メイン クエリの結果で実行される 'where' 句のフィルター条件を指定します。 |
|
sortBy |
|
並べ替える列名またはクエリ式。 既定値は、存在しない場合はカウントされます。 |
|
sortOrder | desc |
選択した列による並べ替え順序 (既定ではカウント)。 |
FacetResult
クエリの応答に関する追加の統計を含むファセットが正常に実行されました。
Name | Type | Description |
---|---|---|
count |
|
ファセット応答で返されるレコードの数。 |
data |
|
目的のファセットを含む JObject 配列またはテーブル。 ファセットが有効な場合にのみ存在します。 |
expression |
|
ファセット式。対応するファセット要求と同じです。 |
resultType | string: |
結果の種類 |
totalRecords |
|
ファセット結果の合計レコード数。 |
FacetSortOrder
選択した列による並べ替え順序 (既定ではカウント)。
Name | Type | Description |
---|---|---|
asc |
|
|
desc |
|
QueryRequest
実行するクエリについて説明します。
Name | Type | Description |
---|---|---|
facets |
クエリ結果に対して計算されるファセット要求の配列。 |
|
managementGroups |
|
クエリを実行する Azure 管理グループ。 例: [ 'mg1', 'mg2' ] |
options |
クエリ評価オプション |
|
query |
|
リソース クエリ。 |
subscriptions |
|
クエリを実行する Azure サブスクリプション。 |
QueryRequestOptions
クエリ評価のオプション
Name | Type | Default Value | Description |
---|---|---|---|
$skip |
|
結果の先頭からスキップする行数。 プロパティが存在する場合に、次のページ オフセットを |
|
$skipToken |
|
改ページ処理の継続トークン。次のページ サイズとオフセット、およびクエリのコンテキストをキャプチャします。 |
|
$top |
|
クエリが返す必要がある行の最大数。 プロパティが存在する場合は、ページ サイズを |
|
allowPartialScopes |
|
False |
サブスクリプションの数が許可された制限を超えた場合に、結果の部分的なスコープを許可するかどうかを決定するテナントおよび管理グループ レベルのクエリにのみ適用されます。 |
resultFormat | objectArray |
クエリ結果が返される形式を定義します。 |
QueryResponse
クエリ結果。
Name | Type | Description |
---|---|---|
$skipToken |
|
存在する場合は、後続のクエリ呼び出し (現在の要求で使用されているのと同じクエリとスコープと共に) に値を渡して、データの次のページを取得できます。 |
count |
|
現在の応答で返されるレコードの数。 ページングの場合、これは現在のページ内のレコードの数です。 |
data |
|
JObject 配列またはテーブル形式のクエリ出力。 |
facets | Facet[]: |
クエリ ファセット。 |
resultTruncated |
クエリ結果が切り捨てられるかどうかを示します。 |
|
totalRecords |
|
クエリに一致するレコードの合計数。 |
ResultFormat
クエリ結果が返される形式を定義します。
Name | Type | Description |
---|---|---|
objectArray |
|
|
table |
|
ResultTruncated
クエリ結果が切り捨てられるかどうかを示します。
Name | Type | Description |
---|---|---|
false |
|
|
true |
|