你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Azure 配额 API
配额 API 是一种 REST API,可用于查看和管理 Azure 服务的配额。
重要
配额 API 正式发布
Azure 配额 API 现已正式发布。 它目前支持 azure 虚拟机 (核心/vCPU) 和 Azure 机器学习服务 (专用/vCPU) 。
注意:Azure 配额服务 Rest API 的新版本以公共预览版提供。 它使用 Microsoft.Quota 资源提供程序,并支持 Azure 虚拟机 (cores/vCPU) 、Azure 机器学习、Azure 网络、Azure HPC 缓存和 Azure Purview 服务。
配额是 Azure 订阅中资源、操作和项的最大值。 每个 Azure 服务定义其配额并确定其默认值。 根据业务需求,可能需要增加配额值。
有关最常见的 Microsoft Azure 限制的详细信息,请参阅 Azure 订阅和服务限制、配额和约束。
使用配额 API
使用配额 API 可以:
- 获取资源的当前配额和使用情况。
- 获取所有资源的当前配额和使用情况的列表。
- 创建或更新资源的配额。
- 获取资源配额请求的状态。
- 获取资源一年的所有配额请求的列表。
REST 操作
通过 Azure 配额 API,可使用以下 REST 操作轻松查找配额和请求增加:
- 有关配额管理 REST 操作的详细信息,请参阅 配额 API 参考。
- 有关配额请求状态 REST 操作的详细信息,请参阅 配额请求状态 API 参考。
先决条件
重要
在使用配额 API 之前,必须:
- 使用 PowerShell 为所有订阅注册 Microsoft Capacity (Microsoft.Capacity) 资源提供程序。
- 将配额请求操作员角色分配给 将执行配额操作的所有用户帐户和应用程序。
注册 Microsoft 容量资源提供程序
若要注册 Microsoft Capacity 资源提供程序,请使用以下 PowerShell 命令:
Register-AzResourceProvider -ProviderNamespace Microsoft.Capacity
它返回的结果类似于以下输出:
ProviderNamespace : Microsoft.Capacity
RegistrationState : Registering
ResourceTypes : {resources, reservationOrders, reservationOrders/reservations, listbenefits...}
Locations : {West Europe, East US, South Central US...}
注册 Microsoft.Capacity 资源提供程序后, RegistrationState
将设置为 Registered
。 有关管理 Azure 资源提供程序的详细信息,请参阅 Azure 资源提供程序。
配额请求操作员角色
配额请求操作员角色是为配额操作自定义的 Azure 内置角色。 它授予读取和创建配额请求、获取配额请求状态以及创建支持票证的权限。 将此角色分配给执行配额操作的用户、组、服务主体、托管标识和应用程序。 供参考,配额请求操作员角色 ID 为 0e5f05e5-9ab9-446b-b98d-1e2157c94125。
vCPU 配额
可以使用配额 API 管理这两种类型的 vCPU 配额的配额:
- 即用即付 VM 和预留 VM 实例的标准 vCPU 配额。
- 现成 VM 的 现成 vCPU 配额。
若要详细了解 Azure 限制和配额,请参阅 Azure 订阅和服务限制、配额和约束。
Azure 机器学习配额
可以使用配额 API 来管理 Azure 机器学习工作区和计算的配额。 阅读 使用 Azure 机器学习管理和增加资源的配额 一文,了解以下内容:
- 与 Azure 机器学习相关的 Azure 资源的默认限制。
- 创建工作区级别的配额。
- 查看你的配额和限制。
- 请求增大配额。
- 专用终结点和 DNS 配额。
区域
大多数配额特定于任何一个区域中的工作负荷。 为要在其中部署服务的每个区域请求单独的配额。 若要列出存在该服务的所有 Azure 区域,请使用 按服务区域列出 操作。
遏制
如果发送过多的 API 请求,可能会限制每个订阅级和租户级 API 调用。 如果 API 调用受到限制,则会收到一条错误消息,指出服务器拒绝了 API 请求。 可以在经过一段时间后重试 API 调用。
有关 API 限制、如何排查限制问题以及如何避免受限制的详细信息,请参阅 排查 Azure 中的限制错误。
排查配额 API 错误
使用下表对使用配额 API 时可能遇到的错误进行故障排除。
错误代码 | 如何解决该问题 |
---|---|
ContactSupport | 在Azure 门户中打开新的支持请求。 在 “选择问题类型”下,选择 “服务和订阅限制” (配额) 。 还可以使用 Azure 支持 REST API 以编程方式打开它。 |
InternalServerError | 内部服务器错误。 请稍后重试 API 调用。 |
MissingRegistration | 为每个订阅注册 Microsoft.Capacity 资源提供程序。 有关故障排除指南,请参阅 解决资源提供程序注册错误。 |
QuotaNotAvailableForResource | 配额当前在所请求资源的位置不可用。 在Azure 门户中打开新的支持请求。 在 “选择问题类型”下,选择 “服务和订阅限制” (配额) 。 还可以使用 Azure 支持 REST API 以编程方式打开它。 |
QuotaReductionNotSupported | 当前配额限制高于请求的配额或当前使用情况高于请求的配额。 不支持减少配额。 不能减少配额。 |
RequestThrottled | 每个订阅级和租户级 API 请求可能会受到限制,以帮助提高服务的整体性能。 请求数超出了允许的最大 API 请求速率。 请稍后重试。 |
ResourceNotAvailableForOffer | 资源当前在产品/服务类型的位置不可用。 有关当前和已停用产品/服务的列表,请参阅 Microsoft Azure 产品/服务详细信息 页。 若要更改产品/服务类型,请参阅 将 Azure 订阅更改为其他套餐 页。 还可以在Azure 门户中提出新的支持请求。 在 “选择问题类型”下,选择 “服务和订阅限制” (配额) 。 还可以使用 Azure 支持 REST API 以编程方式打开它。 |
ResourceNotAvailableForSubscription | 资源当前在请求的订阅的位置不可用。 在Azure 门户中打开新的支持请求。 在 “选择问题类型”下,选择 “服务和订阅限制” (配额) 。 还可以使用 Azure 支持 REST API 以编程方式打开它。 |
UnableToIncreaseQuota | 无法增加所请求订阅的配额。 在Azure 门户中提出新的支持请求。 在 “选择问题类型”下,选择 “服务和订阅限制 (配额) 。 |
其他语言和接口的支持
配额 REST API 在以下特定于语言的 Microsoft Azure SDK 中提供:
- 用于 .NET 的 Microsoft Azure SDK:NuGet 包
- Microsoft Azure SDK for Python: Py 包
- Microsoft Azure SDK for JavaScript (NodeJS & Browser) : js 包
- Microsoft Azure SDK for Go: Go 包
使用 Azure 门户 和支持 API 管理配额
通过 Azure,可创建和管理支持请求(也称为支持票证)。 方法: