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

Resource Groups - List

Служба:
Resource Management
Версия API:
2021-04-01

Возвращает все группы ресурсов для подписки.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups?api-version=2021-04-01
С использованием необязательных параметров: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups?$filter={$filter}&$top={$top}&api-version=2021-04-01

Параметры URI

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

string

Идентификатор подписки Microsoft Azure.
api-version
 query True

string

Версия API, используемая для этой операции.
$filter
 query

string

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

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

integer (int32)

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

Ответы

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

ResourceGroupListResult

ОК. Возвращает массив групп ресурсов.
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

Ответ на ошибку
ResourceGroup

Сведения о группе ресурсов.
ResourceGroupListResult

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

Свойства группы ресурсов.

CloudError

Object

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

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

ErrorResponse

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

ErrorAdditionalInfo

Object

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

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

object

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

string

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

ErrorResponse

Object

Ответ на ошибку

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

ErrorAdditionalInfo[]

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

string

Код ошибки.
details

ErrorResponse[]

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

string

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

string

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

ResourceGroup

Object

Сведения о группе ресурсов.

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

string

Идентификатор группы ресурсов.
location

string

Расположение группы ресурсов. Его нельзя изменить после создания группы ресурсов. Это должно быть одно из поддерживаемых расположений Azure.
managedBy

string

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

string

Имя группы ресурсов.
properties

ResourceGroupProperties

Свойства группы ресурсов.
tags

object

Теги, присоединенные к группе ресурсов.
type

string

Тип группы ресурсов.

ResourceGroupListResult

Object

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

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

string

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

ResourceGroup[]

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

ResourceGroupProperties

Object

Свойства группы ресурсов.

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

string

Состояние подготовки.