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

Subscriptions - List

获取租户的所有订阅。

GET https://management.azure.com/subscriptions?api-version=2022-12-01

URI 参数

名称 必需 类型 说明
api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

SubscriptionListResult

正常 - 返回订阅数组。

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

GetAllSubscriptions

示例请求

GET https://management.azure.com/subscriptions?api-version=2022-12-01

示例响应

{
  "value": [
    {
      "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
      "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
      "tenantId": "31c75423-32d6-4322-88b7-c478bdde4858",
      "displayName": "Example Subscription",
      "state": "Enabled",
      "subscriptionPolicies": {
        "locationPlacementId": "Internal_2014-09-01",
        "quotaId": "Internal_2014-09-01",
        "spendingLimit": "Off"
      },
      "authorizationSource": "RoleBased",
      "managedByTenants": [
        {
          "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
        }
      ],
      "tags": {
        "tagKey1": "tagValue1",
        "tagKey2": "tagValue2"
      }
    },
    {
      "id": "/subscriptions/72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
      "subscriptionId": "72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
      "tenantId": "2a0ff0de-96b2-4859-bb7c-a430d07a3e0c",
      "displayName": "Example Subscription2",
      "state": "Enabled",
      "subscriptionPolicies": {
        "locationPlacementId": "Internal_2014-09-01",
        "quotaId": "Internal_2014-09-01",
        "spendingLimit": "Off"
      },
      "authorizationSource": "RoleBased",
      "managedByTenants": [
        {
          "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
        },
        {
          "tenantId": "f7fb6af2-321d-47c8-9c0f-b0239eaad39a"
        }
      ],
      "tags": {
        "tagKey1": "tagValue1",
        "tagKey2": "tagValue2"
      }
    }
  ],
  "nextLink": "..."
}

定义

名称 说明
CloudError

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

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ManagedByTenant

有关管理订阅的租户的信息。

spendingLimit

订阅支出限制。

Subscription

订阅信息。

SubscriptionListResult

订阅列出操作响应。

SubscriptionPolicies

订阅策略。

SubscriptionState

订阅状态。 可能的值为 Enabled、Warned、PastDue、Disabled 和 Deleted。

CloudError

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

名称 类型 说明
error

ErrorResponse

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

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ManagedByTenant

有关管理订阅的租户的信息。

名称 类型 说明
tenantId

string

管理租户的租户 ID。 这是一个 GUID。

spendingLimit

订阅支出限制。

名称 类型 说明
CurrentPeriodOff

string

Off

string

On

string

Subscription

订阅信息。

名称 类型 说明
authorizationSource

string

请求的授权源。 有效值是旧版、RoleBased、Bypassed、Direct 和 Management 的一个或多个组合。 例如,“旧版,RoleBased”。

displayName

string

订阅显示名称。

id

string

订阅的完全限定 ID。 例如,/subscriptions/8d65815f-a5b6-402f-9298-045155da7d74

managedByTenants

ManagedByTenant[]

包含管理订阅的租户的数组。

state

SubscriptionState

订阅状态。 可能的值为 Enabled、Warned、PastDue、Disabled 和 Deleted。

subscriptionId

string

订阅的 ID。

subscriptionPolicies

SubscriptionPolicies

订阅策略。

tags

object

附加到订阅的标记。

tenantId

string

订阅租户 ID。

SubscriptionListResult

订阅列出操作响应。

名称 类型 说明
nextLink

string

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

value

Subscription[]

订阅数组。

SubscriptionPolicies

订阅策略。

名称 类型 说明
locationPlacementId

string

订阅位置放置 ID。 ID 指示订阅可见的区域。 例如,位置放置 ID 为 Public_2014-09-01 的订阅可以访问 Azure 公共区域。

quotaId

string

订阅配额 ID。

spendingLimit

spendingLimit

订阅支出限制。

SubscriptionState

订阅状态。 可能的值为 Enabled、Warned、PastDue、Disabled 和 Deleted。

名称 类型 说明
Deleted

string

Disabled

string

Enabled

string

PastDue

string

Warned

string