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

Get Catalog - Get Catalog

  • 参考
Service:
Reserved VM Instances
API Version:
2022-11-01

获取可用于为指定的 Azure 订阅购买 RI 的区域和 SKU。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/catalogs?api-version=2022-11-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Capacity/catalogs?api-version=2022-11-01&reservedResourceType={reservedResourceType}&location={location}&publisherId={publisherId}&offerId={offerId}&planId={planId}&$filter={$filter}&$skip={$skip}&$take={$take}

URI 参数

名称 在 必需 类型 说明
subscriptionId
 path True

string

订阅的 ID
api-version
 query True

string

受支持的版本。
$filter
 query

string

可用于按目录属性进行筛选。 筛选器支持“eq”、“or”和“and”。
$skip
 query

number

返回结果之前要从列表中跳过的预留数
$take
 query

number

要返回的预留数
location
 query

string

根据此参数中指定的位置筛选 SKU。 这可以是 Azure 区域，也可以是全局
offerId
 query

string

用于获取第三方产品的套餐 ID
planId
 query

string

用于获取第三方产品的计划 ID
publisherId
 query

string

用于获取第三方产品的发布者 ID
reservedResourceType
 query

string

应为其提供 SKU 的资源的类型。

响应

名称 类型 说明
200 OK

CatalogsResult

没问题。 请求已成功。
Other Status Codes

Error

错误

示例

Catalog

Sample Request

GET https://management.azure.com/subscriptions/23bc208b-083f-4901-ae85-4f98c0c3b4b6/providers/Microsoft.Capacity/catalogs?api-version=2022-11-01&reservedResourceType=VirtualMachines&location=eastus

Sample Response

Status code:
200 
{
  "value": [
    {
      "resourceType": "VirtualMachines",
      "name": "Standard_DS5_v2",
      "terms": [
        "P1Y",
        "P3Y"
      ],
      "billingPlans": {
        "P1Y": [
          "Upfront",
          "Monthly"
        ],
        "P3Y": [
          "Upfront",
          "Monthly"
        ]
      },
      "locations": [
        "eastus"
      ],
      "skuProperties": [
        {
          "name": "Cores",
          "value": "16"
        },
        {
          "name": "ProductTitle",
          "value": "DSv2 Series, DS5"
        },
        {
          "name": "ProductShortName",
          "value": "DSv2 Series"
        },
        {
          "name": "SKUName",
          "value": "DS5 v2"
        },
        {
          "name": "MeterId",
          "value": "12bc208b-083f-4901-ae85-4f98c0c3b4b8"
        }
      ],
      "restrictions": []
    },
    {
      "resourceType": "VirtualMachines",
      "name": "Standard_D1",
      "terms": [
        "P1Y",
        "P3Y"
      ],
      "billingPlans": {
        "P1Y": [
          "Upfront",
          "Monthly"
        ],
        "P3Y": [
          "Upfront",
          "Monthly"
        ]
      },
      "locations": [
        "eastus"
      ],
      "skuProperties": [
        {
          "name": "Cores",
          "value": "1"
        },
        {
          "name": "ProductTitle",
          "value": "D Series, D1"
        },
        {
          "name": "ProductShortName",
          "value": "D Series"
        },
        {
          "name": "SKUName",
          "value": "D1"
        },
        {
          "name": "MeterId",
          "value": "12bc208b-083f-4901-ae85-4f98c0c3b4b8"
        }
      ],
      "restrictions": [
        {
          "type": "Term",
          "values": [
            "P1Y"
          ],
          "reasonCode": "NotAvailableForSubscription"
        },
        {
          "type": "Term",
          "values": [
            "P3Y"
          ],
          "reasonCode": "NotAvailableForSubscription"
        }
      ]
    },
    {
      "resourceType": "VirtualMachines",
      "name": "Standard_F2",
      "terms": [
        "P1Y",
        "P3Y"
      ],
      "billingPlans": {
        "P1Y": [
          "Upfront",
          "Monthly"
        ],
        "P3Y": [
          "Upfront",
          "Monthly"
        ]
      },
      "locations": [
        "eastus"
      ],
      "skuProperties": [
        {
          "name": "Cores",
          "value": "2"
        },
        {
          "name": "ProductTitle",
          "value": "F Series, F2"
        },
        {
          "name": "ProductShortName",
          "value": "F Series"
        },
        {
          "name": "SKUName",
          "value": "F2"
        },
        {
          "name": "MeterId",
          "value": "12bc208b-083f-4901-ae85-4f98c0c3b4b8"
        }
      ],
      "restrictions": [
        {
          "type": "Location",
          "values": [
            "eastus"
          ],
          "reasonCode": "NotAvailableForSubscription"
        }
      ]
    }
  ],
  "nextLink": "https://management.azure.com/providers/Microsoft.Capacity/reservationOrders?api-version=2022-11-01&$filter=(term eq 'P1Y')&$take=50&$skip=50",
  "totalItems": 1000
}

定义

名称 说明
Catalog

某种资源类型的产品详细信息。
CatalogsResult

目录和分页信息的列表。
Error

错误信息
ErrorResponseCode

描述服务无法处理传入请求的原因的错误代码
ExtendedErrorInfo

扩展的错误信息，包括错误代码和错误消息
Msrp

有关 SKU 的定价信息
Price

包含金额和货币代码的定价信息
ReservationTerm

表示预留期限。
SkuCapability

SKU 的功能。
SkuProperty

SKU 的属性。
SkuRestriction

SKU 的限制。

Catalog

某种资源类型的产品详细信息。

名称 类型 说明
billingPlans

object

可用于此 SKU 的计费计划选项。
capabilities

SkuCapability[]

SKU 的功能。
locations

string[]

SKU 可用的位置集。 如果未指定，则 SKU 在所有位置都可用。
msrp

Msrp

有关 SKU 的定价信息
name

string

SKU 的名称
resourceType

string

SKU 适用的资源类型。
restrictions

SkuRestriction[]

SKU 的限制。
size

string

此 SKU 的大小
skuProperties

SkuProperty[]

SKU 的属性。
terms

ReservationTerm[]

此资源的可用预留条款
tier

string

此 SKU 的层

CatalogsResult

目录和分页信息的列表。

名称 类型 说明
nextLink

string

链接 (url) 到结果的下一页。
totalItems

integer

目录项的总量。
value

Catalog[]

目录列表。

Error

错误信息

名称 类型 说明
error

ExtendedErrorInfo

扩展的错误信息，包括错误代码和错误消息

ErrorResponseCode

描述服务无法处理传入请求的原因的错误代码

名称 类型 说明
ActivateQuoteFailed

string

AppliedScopesNotAssociatedWithCommerceAccount

string

AppliedScopesSameAsExisting

string

AuthorizationFailed

string

BadRequest

string

BillingCustomerInputError

string

BillingError

string

BillingPaymentInstrumentHardError

string

BillingPaymentInstrumentSoftError

string

BillingScopeIdCannotBeChanged

string

BillingTransientError

string

CalculatePriceFailed

string

CapacityUpdateScopesFailed

string

ClientCertificateThumbprintNotSet

string

CreateQuoteFailed

string

Forbidden

string

FulfillmentConfigurationError

string

FulfillmentError

string

FulfillmentOutOfStockError

string

FulfillmentTransientError

string

HttpMethodNotSupported

string

InternalServerError

string

InvalidAccessToken

string

InvalidFulfillmentRequestParameters

string

InvalidHealthCheckType

string

InvalidLocationId

string

InvalidRefundQuantity

string

InvalidRequestContent

string

InvalidRequestUri

string

InvalidReservationId

string

InvalidReservationOrderId

string

InvalidSingleAppliedScopesCount

string

InvalidSubscriptionId

string

InvalidTenantId

string

MissingAppliedScopesForSingle

string

MissingTenantId

string

NoValidReservationsToReRate

string

NonsupportedAccountId

string

NotSpecified

string

NotSupportedCountry

string

OperationCannotBePerformedInCurrentState

string

OperationFailed

string

PatchValuesSameAsExisting

string

PaymentInstrumentNotFound

string

PurchaseError

string

ReRateOnlyAllowedForEA

string

RefundLimitExceeded

string

ReservationIdNotInReservationOrder

string

ReservationOrderCreationFailed

string

ReservationOrderIdAlreadyExists

string

ReservationOrderNotEnabled

string

ReservationOrderNotFound

string

RiskCheckFailed

string

RoleAssignmentCreationFailed

string

SelfServiceRefundNotSupported

string

ServerTimeout

string

UnauthenticatedRequestsThrottled

string

UnsupportedReservationTerm

string

ExtendedErrorInfo

扩展的错误信息，包括错误代码和错误消息

名称 类型 说明
code

ErrorResponseCode

描述服务无法处理传入请求的原因的错误代码
message

string

Msrp

有关 SKU 的定价信息

名称 类型 说明
p1Y

Price

定价货币金额。 不包括税款。
p3Y

Price

定价货币金额。 不包括税款。
p5Y

Price

定价货币金额。 不包括税款。

Price

包含金额和货币代码的定价信息

名称 类型 说明
amount

number

currencyCode

string

此购买记录使用的货币的 ISO 4217 3 字母货币代码。

ReservationTerm

表示预留期限。

名称 类型 说明
P1Y

string

P3Y

string

P5Y

string

SkuCapability

SKU 的功能。

名称 类型 说明
name

string

用于描述功能的固定项。
value

string

如果特征按数量度量，则为固定值。

SkuProperty

SKU 的属性。

名称 类型 说明
name

string

用于描述功能的固定项。
value

string

如果特征按数量度量，则为固定值。

SkuRestriction

SKU 的限制。

名称 类型 说明
reasonCode

string

限制的原因。
type

string

限制的类型。
values

string[]

限制的值。 如果限制类型设置为 location。 这将是 SKU 受限的不同位置。