你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Resource Groups - List

获取订阅的所有资源组。

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 订阅 ID。

api-version
query True

string

要用于此操作的 API 版本。

$filter
query

string

要应用于操作的筛选器。

可以按标记名称和值进行筛选。 例如,若要筛选标记名称和值,请使用 $filter=tagName eq 'tag1' 和 tagValue eq 'Value1'

$top
query

integer

int32

要返回的结果数。 如果传递 null,则返回所有资源组。

响应

名称 类型 说明
200 OK

ResourceGroupListResult

OK - 返回资源组的数组。

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称 说明
user_impersonation 模拟用户帐户

定义

名称 说明
CloudError

资源管理请求的错误响应。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorResponse

错误响应

ResourceGroup

资源组信息。

ResourceGroupListResult

资源组列表。

ResourceGroupProperties

资源组属性。

CloudError

资源管理请求的错误响应。

名称 类型 说明
error

ErrorResponse

错误响应
对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式。)

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorResponse

错误响应

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorResponse[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ResourceGroup

资源组信息。

名称 类型 说明
id

string

资源组的 ID。

location

string

资源组的位置。 创建资源组后无法更改。 它必须是受支持的 Azure 位置之一。

managedBy

string

管理此资源组的资源的 ID。

name

string

资源组的名称。

properties

ResourceGroupProperties

资源组属性。

tags

object

附加到资源组的标记。

type

string

资源组的类型。

ResourceGroupListResult

资源组列表。

名称 类型 说明
nextLink

string

用于获取下一组结果的 URL。

value

ResourceGroup[]

资源组的数组。

ResourceGroupProperties

资源组属性。

名称 类型 说明
provisioningState

string

预配状态。