Resources - Resources
Запрашивает ресурсы, управляемые Azure Resource Manager, для областей, указанных в запросе.
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для этой операции. |
Текст запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| query | True |
string |
Запрос ресурсов. |
| facets |
Массив запросов аспектов, вычисляемых по результату запроса. |
||
| managementGroups |
string[] |
Группы управления Azure, для которых выполняется запрос. Пример: [ "mg1", "mg2" ] |
|
| options |
Параметры оценки запросов |
||
| subscriptions |
string[] |
Подписки Azure, для которых выполняется запрос. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Запрос выполнен успешно. |
|
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
azure_auth
Azure Active Directory OAuth2 Flow.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
Access a properties field
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"query": "Resources | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by tostring(properties.storageProfile.osDisk.osType)",
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
]
}
Пример ответа
{
"count": 2,
"data": [
{
"count": 7,
"properties_storageProfile_osDisk_osType": "Linux"
},
{
"count": 23,
"properties_storageProfile_osDisk_osType": "Windows"
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 2
}
Basic management group query
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"managementGroups": [
"e927f598-c1d4-4f72-8541-95d83a6a4ac8",
"ProductionMG"
],
"query": "Resources | project id, name, type, location, tags | limit 3"
}
Пример ответа
{
"count": 3,
"data": [
{
"name": "myNetworkInterface",
"type": "microsoft.network/networkinterfaces",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface",
"location": "centralus",
"tags": {
"tag1": "Value1"
}
},
{
"name": "myVnet",
"type": "microsoft.network/virtualnetworks",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet",
"location": "westus",
"tags": {}
},
{
"name": "myPublicIp",
"type": "microsoft.network/publicipaddresses",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp",
"location": "westus",
"tags": {}
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 3
}
Basic query
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"query": "Resources | project id, name, type, location, tags | limit 3",
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
]
}
Пример ответа
{
"count": 3,
"data": [
{
"name": "myNetworkInterface",
"type": "microsoft.network/networkinterfaces",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface",
"location": "centralus",
"tags": {
"tag1": "Value1"
}
},
{
"name": "myVnet",
"type": "microsoft.network/virtualnetworks",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet",
"location": "westus",
"tags": {}
},
{
"name": "myPublicIp",
"type": "microsoft.network/publicipaddresses",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp",
"location": "westus",
"tags": {}
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 3
}
Basic tenant query
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"query": "Resources | project id, name, type, location, tags | limit 3"
}
Пример ответа
{
"count": 3,
"data": [
{
"name": "myNetworkInterface",
"type": "microsoft.network/networkinterfaces",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Network/networkInterfaces/myNetworkInterface",
"location": "centralus",
"tags": {
"tag1": "Value1"
}
},
{
"name": "myVnet",
"type": "microsoft.network/virtualnetworks",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/virtualNetworks/myVnet",
"location": "westus",
"tags": {}
},
{
"name": "myPublicIp",
"type": "microsoft.network/publicipaddresses",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Network/publicIPAddresses/myPublicIp",
"location": "westus",
"tags": {}
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 3
}
Complex query
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"query": "Resources | project id, name, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | summarize count() by location | top 3 by count_",
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
]
}
Пример ответа
{
"count": 3,
"data": [
{
"count_": 11,
"location": "centralus"
},
{
"count_": 11,
"location": "eastus"
},
{
"count_": 3,
"location": "southcentralus"
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 3
}
Filter resources
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"query": "Resources | project id, name, type, location | where type =~ 'Microsoft.Compute/virtualMachines' | limit 3",
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
]
}
Пример ответа
{
"count": 3,
"data": [
{
"name": "myVm1",
"type": "microsoft.compute/virtualmachines",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/myVm1",
"location": "centralus"
},
{
"name": "myVirtualMachine",
"type": "microsoft.compute/virtualmachines",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Compute/virtualMachines/myVirtualMachine",
"location": "eastus"
},
{
"name": "testVm",
"type": "microsoft.compute/virtualmachines",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG3/providers/Microsoft.Compute/virtualMachines/testVm",
"location": "eastus"
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 3
}
First page query
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"options": {
"$skip": 0,
"$top": 3
},
"query": "Resources | where name contains 'test' | project id, name, type, location",
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
]
}
Пример ответа
{
"$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ==",
"count": 3,
"data": [
{
"name": "yetanothertest_OsDisk_1_f396cbcb625a457bb69fe2abf5975820",
"type": "microsoft.compute/disks",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/yetanothertest_OsDisk_1_f396cbcb625a457bb69fe2abf5975820",
"location": "eastus"
},
{
"name": "TestAA",
"type": "microsoft.automation/automationaccounts",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA",
"location": "westcentralus"
},
{
"name": "TestRB",
"type": "microsoft.automation/automationaccounts/runbooks",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA/runbooks/TestRB",
"location": "westcentralus"
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 386
}
Next page query
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"options": {
"$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ=="
},
"query": "Resources | where name contains 'test' | project id, name, type, location",
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
]
}
Пример ответа
{
"$skipToken": "eyAibm8yIjogImx1Y2syIiwgImJ1dDIiOiAibmljZTIiLCAidHJ5MiI6ICIhIiB9",
"count": 3,
"data": [
{
"name": "second_OsDisk_dddddbcb625a457bb69fe2abf5975820",
"type": "microsoft.compute/disks",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/second_OsDisk_dddddbcb625a457bb69fe2abf5975820",
"location": "eastus"
},
{
"name": "AATest",
"type": "microsoft.automation/automationaccounts",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/AATest",
"location": "westcentralus"
},
{
"name": "RBTest",
"type": "microsoft.automation/automationaccounts/runbooks",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/TestAA/runbooks/RBTest",
"location": "westcentralus"
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 386
}
Query with a facet request
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"facets": [
{
"expression": "location",
"options": {
"$top": 3,
"sortOrder": "desc"
}
},
{
"expression": "properties.storageProfile.osDisk.osType",
"options": {
"$top": 3,
"sortOrder": "desc"
}
},
{
"expression": "nonExistingColumn",
"options": {
"$top": 3,
"sortOrder": "desc"
}
},
{
"expression": "resourceGroup",
"options": {
"$top": 3,
"sortBy": "tolower(resourceGroup)",
"sortOrder": "asc"
}
},
{
"expression": "resourceGroup",
"options": {
"$top": 3,
"filter": "resourceGroup contains 'test'"
}
}
],
"query": "Resources | where type =~ 'Microsoft.Compute/virtualMachines' | project id, name, location, resourceGroup, properties.storageProfile.osDisk.osType | limit 5",
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
]
}
Пример ответа
{
"count": 5,
"data": [
{
"name": "myTestVm",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/B-TEST-RG/providers/Microsoft.Compute/virtualMachines/myTestVm",
"location": "eastus",
"properties_storageProfile_osDisk_osType": "Windows",
"resourceGroup": "B-TEST-RG"
},
{
"name": "myTestAccountVm",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/c-rg/providers/Microsoft.Compute/virtualMachines/myTestAccountVm",
"location": "westcentralus",
"properties_storageProfile_osDisk_osType": "Windows",
"resourceGroup": "c-rg"
},
{
"name": "yetanothertest",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/I-RG/providers/Microsoft.Compute/virtualMachines/yetanothertest",
"location": "eastus",
"properties_storageProfile_osDisk_osType": "Linux",
"resourceGroup": "I-RG"
},
{
"name": "drafttest1bux4cv7a7q3aw",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/x-test-rg/providers/Microsoft.Compute/virtualMachines/drafttest1bux4cv7a7q3aw",
"location": "southcentralus",
"properties_storageProfile_osDisk_osType": "Linux",
"resourceGroup": "x-test-rg"
},
{
"name": "testvmntp25370",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/y-rg/providers/Microsoft.Compute/virtualMachines/testvmntp25370",
"location": "eastus",
"properties_storageProfile_osDisk_osType": "Windows",
"resourceGroup": "y-rg"
}
],
"facets": [
{
"count": 3,
"data": [
{
"count": 3,
"location": "eastus"
},
{
"count": 1,
"location": "southcentralus"
},
{
"count": 1,
"location": "westcentralus"
}
],
"expression": "location",
"resultType": "FacetResult",
"totalRecords": 3
},
{
"count": 2,
"data": [
{
"count": 2,
"properties_storageProfile_osDisk_osType": "Linux"
},
{
"count": 3,
"properties_storageProfile_osDisk_osType": "Windows"
}
],
"expression": "properties.storageProfile.osDisk.osType",
"resultType": "FacetResult",
"totalRecords": 2
},
{
"errors": [
{
"code": "NoValidColumns",
"message": "No valid columns in facet expression."
},
{
"code": "InvalidColumnNames",
"message": "Invalid column names: [nonExistingColumn]."
}
],
"expression": "nonExistingColumn",
"resultType": "FacetError"
},
{
"count": 3,
"data": [
{
"count": 1,
"resourceGroup": "B-TEST-RG"
},
{
"count": 1,
"resourceGroup": "c-rg"
},
{
"count": 1,
"resourceGroup": "I-RG"
}
],
"expression": "resourceGroup",
"resultType": "FacetResult",
"totalRecords": 5
},
{
"count": 2,
"data": [
{
"count": 1,
"resourceGroup": "B-TEST-RG"
},
{
"count": 1,
"resourceGroup": "x-test-rg"
}
],
"expression": "resourceGroup",
"resultType": "FacetResult",
"totalRecords": 2
}
],
"resultTruncated": "false",
"totalRecords": 5
}
Random page query
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"options": {
"$skip": 10,
"$top": 2
},
"query": "Resources | where name contains 'test' | project id, name, type, location",
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
]
}
Пример ответа
{
"$skipToken": "eyAibm8iOiAibHVjayIsICJidXQiOiAibmljZSIsICJ0cnkiOiAiISIgfQ==",
"count": 2,
"data": [
{
"name": "third_OsDisk_dddddbcb625a457bb69fe2abf5975820",
"type": "microsoft.compute/disks",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/disks/third_OsDisk_dddddbcb625a457bb69fe2abf5975820",
"location": "eastus"
},
{
"name": "CCTest",
"type": "microsoft.automation/automationaccounts",
"id": "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Automation/automationAccounts/CCTest",
"location": "westcentralus"
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 386
}
Summarize resources by location
Образец запроса
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2024-04-01
{
"query": "Resources | project id, name, type, location | summarize by location",
"subscriptions": [
"cfbbd179-59d2-4052-aa06-9270a38aa9d6"
]
}
Пример ответа
{
"count": 3,
"data": [
{
"location": "centralus"
},
{
"location": "eastus"
},
{
"location": "westus"
}
],
"facets": [],
"resultTruncated": "false",
"totalRecords": 3
}
Определения
| Имя | Описание |
|---|---|
|
Authorization |
Определяет уровень ресурсов авторизации, основанный на том, какие подписки и группы управления передаются в качестве областей. |
|
Facet |
Аспект, выполнение которого привело к ошибке. |
|
Facet |
Запрос на вычисление дополнительных статистических данных (аспектов) по результатам запроса. |
|
Facet |
Параметры оценки аспектов |
|
Facet |
Успешно выполнен аспект, содержащий дополнительную статистику по ответу запроса. |
|
Facet |
Порядок сортировки по выбранному столбцу (число по умолчанию). |
|
Query |
Описывает выполнение запроса. |
|
Query |
Параметры оценки запросов |
|
Query |
Результат запроса. |
|
Resource |
Сведения об ошибке. |
|
Resource |
Сведения об ошибке. |
|
Resource |
Ответ на ошибку. |
|
Result |
Определяет, в каком результате запроса формата возвращается результат запроса. |
|
Result |
Указывает, усечены ли результаты запроса. |
AuthorizationScopeFilter
Определяет уровень ресурсов авторизации, основанный на том, какие подписки и группы управления передаются в качестве областей.
| Значение | Описание |
|---|---|
| AtScopeAndBelow |
AtScopeAndBelow |
| AtScopeAndAbove |
AtScopeAndAbove |
| AtScopeExact |
AtScopeExact |
| AtScopeAboveAndBelow |
AtScopeAboveandBelow |
FacetError
Аспект, выполнение которого привело к ошибке.
| Имя | Тип | Описание |
|---|---|---|
| errors |
Массив, содержащий обнаруженные ошибки аспектов с подробными сведениями. |
|
| expression |
string |
Выражение аспекта, аналогичное соответствующему запросу аспектов. |
| resultType | string: |
Тип результата |
FacetRequest
Запрос на вычисление дополнительных статистических данных (аспектов) по результатам запроса.
| Имя | Тип | Описание |
|---|---|---|
| expression |
string |
Столбец или список столбцов, которые нужно свести к сводке по |
| options |
Параметры оценки аспектов |
FacetRequestOptions
Параметры оценки аспектов
| Имя | Тип | Default value | Описание |
|---|---|---|---|
| $top |
integer (int32) minimum: 1maximum: 1000 |
Максимальное количество возвращаемых строк аспектов. |
|
| filter |
string |
Указывает условие фильтра для предложения where, которое будет выполняться в результатах основного запроса, непосредственно перед фактическим аспектом. |
|
| sortBy |
string |
Имя столбца или выражение запроса для сортировки. Значение по умолчанию для подсчета, если оно отсутствует. |
|
| sortOrder | desc |
Порядок сортировки по выбранному столбцу (число по умолчанию). |
FacetResult
Успешно выполнен аспект, содержащий дополнительную статистику по ответу запроса.
| Имя | Тип | Описание |
|---|---|---|
| count |
integer (int32) |
Количество записей, возвращаемых в ответе аспектов. |
| data |
Массив JObject или таблица, содержащая нужные аспекты. Присутствует только в том случае, если аспект действителен. |
|
| expression |
string |
Выражение аспекта, аналогичное соответствующему запросу аспектов. |
| resultType | string: |
Тип результата |
| totalRecords |
integer (int64) |
Количество общих записей в результатах аспектов. |
FacetSortOrder
Порядок сортировки по выбранному столбцу (число по умолчанию).
| Значение | Описание |
|---|---|
| asc |
Asc |
| desc |
описание |
QueryRequest
Описывает выполнение запроса.
| Имя | Тип | Описание |
|---|---|---|
| facets |
Массив запросов аспектов, вычисляемых по результату запроса. |
|
| managementGroups |
string[] |
Группы управления Azure, для которых выполняется запрос. Пример: [ "mg1", "mg2" ] |
| options |
Параметры оценки запросов |
|
| query |
string |
Запрос ресурсов. |
| subscriptions |
string[] |
Подписки Azure, для которых выполняется запрос. |
QueryRequestOptions
Параметры оценки запросов
| Имя | Тип | Default value | Описание |
|---|---|---|---|
| $skip |
integer (int32) minimum: 0 |
Количество строк, пропускаемых с начала результатов. Переопределяет смещение следующей страницы при наличии свойства |
|
| $skipToken |
string |
Маркер продолжения для разбиения на страницы, запись следующего размера и смещения страницы, а также контекст запроса. |
|
| $top |
integer (int32) minimum: 1maximum: 1000 |
Максимальное количество строк, возвращаемых запросом. Переопределяет размер страницы при наличии свойства |
|
| allowPartialScopes |
boolean |
False |
Применимо только для запросов уровня клиента и группы управления, чтобы решить, разрешать ли частичные области для результата в случае превышения допустимого количества подписок. |
| authorizationScopeFilter | AtScopeAndBelow |
Определяет уровень ресурсов авторизации, основанный на том, какие подписки и группы управления передаются в качестве областей. |
|
| resultFormat | objectArray |
Определяет, в каком результате запроса формата возвращается результат запроса. |
QueryResponse
Результат запроса.
| Имя | Тип | Описание |
|---|---|---|
| $skipToken |
string |
При наличии значение можно передать в последующий вызов запроса (вместе с теми же запросами и областями, которые используются в текущем запросе) для получения следующей страницы данных. |
| count |
integer (int64) |
Количество записей, возвращаемых в текущем ответе. В случае разбиения на страницы это число записей на текущей странице. |
| data |
Выходные данные запроса в массиве JObject или формате таблицы. |
|
| facets | Facet[]: |
Аспекты запроса. |
| resultTruncated |
Указывает, усечены ли результаты запроса. |
|
| totalRecords |
integer (int64) |
Количество общих записей, соответствующих запросу. |
ResourceGraphCommon.Error
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки, определяющий конкретную ошибку. |
| details |
Сведения об ошибке |
|
| message |
string |
Сообщение об ошибке, доступное для чтения. |
ResourceGraphCommon.ErrorDetails
Сведения об ошибке.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки, определяющий конкретную ошибку. |
| message |
string |
Сообщение об ошибке, доступное для чтения. |
ResourceGraphCommon.ErrorResponse
Ответ на ошибку.
| Имя | Тип | Описание |
|---|---|---|
| error |
Сведения об ошибке. |
ResultFormat
Определяет, в каком результате запроса формата возвращается результат запроса.
| Значение | Описание |
|---|---|
| table |
table |
| objectArray |
objectArray |
ResultTruncated
Указывает, усечены ли результаты запроса.
| Значение | Описание |
|---|---|
| true |
истина |
| false |
false |