Поделиться через


Resources - List By Resource Group

Получение всех ресурсов для группы ресурсов.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?$filter={$filter}&$expand={$expand}&$top={$top}&api-version=2021-04-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Группа ресурсов с ресурсами для получения.

Шаблон регулярного выражения: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Идентификатор подписки Microsoft Azure.

api-version
query True

string

Версия API, используемая для данной операции.

$expand
query

string

Разделенный запятыми список дополнительных свойств, которые будут включены в ответ. Допустимые значения: createdTime, changedTime и provisioningState. Например, $expand=createdTime,changedTime.

$filter
query

string

Фильтр, применяемый к операции.

Для eq (equals) или ne (не равно) можно использовать следующие свойства: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version и plan/promotionCode.

Например, для фильтрации по типу ресурса используйте: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

В фильтре можно использовать substringof(value, property). Для подстроки можно использовать следующие свойства: name и resourceGroup.

Например, чтобы получить все ресурсы с "demo" в любом месте имени, используйте: $filter=substringof('demo', name)

Можно связать несколько подстрок, добавив операторы и (или) .

Вы можете выполнять фильтрацию по именам и значениям тегов. Например, чтобы отфильтровать имя и значение тега, используйте $filter=tagName eq 'tag1' и tagValue eq 'Value1'. При фильтрации по имени и значению тега теги для каждого ресурса не возвращаются в результатах.

Некоторые свойства можно использовать вместе при фильтрации. Вы можете использовать следующие сочетания: substringof и(или) resourceType, plan и plan/publisher и plan/name, identity и identity/principalId.

$top
query

integer

int32

Количество возвращаемых результатов. Если передано значение NULL, возвращает все ресурсы.

Ответы

Имя Тип Описание
200 OK

ResourceListResult

ОК — возвращает массив ресурсов.

Other Status Codes

CloudError

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Определения

Имя Описание
CloudError

Ответ об ошибке для запроса на управление ресурсами.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorResponse

Сообщение об ошибке

ExtendedLocation

Расширенное расположение ресурса.

ExtendedLocationType

Тип расширенного расположения.

GenericResourceExpanded

Информация о ресурсе.

Identity

Удостоверение ресурса.

Plan

План для ресурса.

ResourceIdentityType

Тип удостоверения.

ResourceListResult

Список групп ресурсов.

Sku

Номер SKU для ресурса.

UserAssignedIdentities

Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

CloudError

Ответ об ошибке для запроса на управление ресурсами.

Имя Тип Описание
error

ErrorResponse

Сообщение об ошибке
Общие ответы об ошибках для всех API Azure Resource Manager, возвращающие сведения об ошибке для неудачных операций. (Он также соответствует формату ответа об ошибке OData.)

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorResponse[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ExtendedLocation

Расширенное расположение ресурса.

Имя Тип Описание
name

string

Расширенное имя расположения.

type

ExtendedLocationType

Тип расширенного расположения.

ExtendedLocationType

Тип расширенного расположения.

Имя Тип Описание
EdgeZone

string

GenericResourceExpanded

Информация о ресурсе.

Имя Тип Описание
changedTime

string

Время изменения ресурса. Он присутствует только при запросе с помощью параметра запроса $expand.

createdTime

string

Время создания ресурса. Он присутствует только при запросе с помощью параметра запроса $expand.

extendedLocation

ExtendedLocation

Расширенное расположение ресурса.

id

string

Идентификатор ресурса

identity

Identity

Удостоверение ресурса.

kind

string

Тип ресурса.

location

string

Расположение ресурса

managedBy

string

Идентификатор ресурса, который управляет этим ресурсом.

name

string

Имя ресурса

plan

Plan

План ресурса.

properties

object

Свойства ресурса.

provisioningState

string

Состояние подготовки ресурса. Он присутствует только при запросе с помощью параметра запроса $expand.

sku

Sku

Номер SKU ресурса.

tags

object

Теги ресурсов

type

string

Тип ресурса

Identity

Удостоверение ресурса.

Имя Тип Описание
principalId

string

Идентификатор субъекта удостоверения ресурса.

tenantId

string

Идентификатор клиента ресурса.

type

ResourceIdentityType

Тип удостоверения.

userAssignedIdentities

UserAssignedIdentities

Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Plan

План для ресурса.

Имя Тип Описание
name

string

Идентификатор плана.

product

string

Идентификатор предложения.

promotionCode

string

Промокод.

publisher

string

Идентификатор издателя.

version

string

Версия плана.

ResourceIdentityType

Тип удостоверения.

Имя Тип Описание
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ResourceListResult

Список групп ресурсов.

Имя Тип Описание
nextLink

string

URL-адрес, используемый для получения следующего набора результатов.

value

GenericResourceExpanded[]

Массив ресурсов.

Sku

Номер SKU для ресурса.

Имя Тип Описание
capacity

integer

Емкость номера SKU.

family

string

Семейство номеров SKU.

model

string

Модель SKU.

name

string

Имя номера SKU.

size

string

Размер номера SKU.

tier

string

Уровень SKU.

UserAssignedIdentities

Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в формате "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

Имя Тип Описание