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

Products And Configurations - List Configurations

服务:: Edge Hardware Center

API 版本:: 2024-02-01

列出给定的产品系列、产品系列和给定订阅的产品的配置。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listConfigurations?api-version=2024-02-01

具有可选参数:

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/listConfigurations?api-version=2024-02-01&$skipToken={$skipToken}

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string (uuid)	目标订阅的 ID。该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。
$skipToken	query		string	配置列表支持$skipToken，该列表提供配置列表中的下一页。

请求正文

名称	类型	说明
configurationFilter	ConfigurationFilter	保存有关产品层次结构信息和可筛选属性的详细信息。
customerSubscriptionDetails	CustomerSubscriptionDetails	客户订阅属性。客户端可以通过显式传递订阅详细信息来向未注册的客户显示可用产品。

响应

名称	类型	说明
200 OK	Configurations	请求已成功。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ListConfigurations

示例请求

HTTP

POST https://management.azure.com/subscriptions/eb5dc900-6186-49d8-b7d7-febd866fdc1d/providers/Microsoft.EdgeOrder/listConfigurations?api-version=2024-02-01

{
  "configurationFilter": {
    "filterableProperty": [
      {
        "type": "ShipToCountries",
        "supportedValues": [
          "US"
        ]
      }
    ],
    "hierarchyInformation": {
      "productFamilyName": "azurestackedge",
      "productLineName": "azurestackedge",
      "productName": "azurestackedgegpu"
    }
  }
}

示例响应

状态代码:: 200

{
  "value": [
    {
      "properties": {
        "description": {
          "attributes": [],
          "descriptionType": "Base",
          "keywords": [
            "GPU"
          ],
          "links": [],
          "longDescription": "",
          "shortDescription": ""
        },
        "availabilityInformation": {
          "availabilityStage": "Available",
          "disabledReason": "None"
        },
        "costInformation": {
          "billingMeterDetails": []
        },
        "dimensions": {
          "depth": 2,
          "height": 15,
          "length": 50,
          "lengthHeightUnit": "IN",
          "weight": 50,
          "weightUnit": "LBS",
          "width": 5
        },
        "displayName": "Azure Stack Edge Pro - 1 GPU",
        "filterableProperties": [
          {
            "type": "ShipToCountries",
            "supportedValues": [
              "US"
            ]
          }
        ],
        "hierarchyInformation": {
          "configurationName": "edgep_base",
          "productFamilyName": "azurestackedge",
          "productLineName": "azurestackedge",
          "productName": "azurestackedgegpu"
        },
        "imageInformation": [],
        "specifications": [
          {
            "name": "Usable compute",
            "value": "40 vCPU"
          },
          {
            "name": "Usable memory",
            "value": "102 GB"
          },
          {
            "name": "Usable storage",
            "value": "4.2 TB"
          }
        ]
      }
    }
  ]
}

定义

名称	说明
AvailabilityInformation	产品系统的可用性信息。
AvailabilityStage	产品的当前可用性阶段。
BillingMeterDetails	保存每种计费类型的计费计量详细信息。
BillingType	表示计费类型。
CategoryInformation	子配置的类别相关属性。
ChargingType	Charging type.
ChildConfiguration	子配置对象。
ChildConfigurationFilter	子配置筛选器。
ChildConfigurationType
Configuration	Configuration object.
ConfigurationFilter	Configuration filters.
Configurations	配置列表。
ConfigurationsRequest	配置请求对象。
CostInformation	产品系统的成本信息。
CustomerSubscriptionDetails	保存客户订阅详细信息。客户端可以通过显式传递订阅详细信息来向未注册的客户显示可用产品。
CustomerSubscriptionRegisteredFeatures	表示订阅注册的功能。
Description	说明产品系统的相关属性。
DescriptionType	说明的类型。
Dimensions	配置的维度。
DisabledReason	禁用产品的原因。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	Error response
FilterableProperty	支持的不同类型的筛选器及其值。
FulfillmentType	负责在给定层次结构级别履行项的实体。
GroupedChildConfigurations	分组子配置对象。
HierarchyInformation	保存有关产品层次结构信息的详细信息。
ImageInformation	产品的图像。
ImageType	图像的类型。
LengthHeightUnit	长度、高度和宽度尺寸的单位。
Link	返回与产品相关的链接。
LinkType	链接的类型。
MeteringType	表示计量类型（例如一次性或重复）。
Pav2MeterDetails	计费类型 PAV2 计量详细信息。
ProvisioningSupport	确定配置支持的预配的性质。
PurchaseMeterDetails	计费类型购买计量详细信息。
Specification	配置规范。
SupportedFilterTypes	产品筛选器的类型。
TermCommitmentType	术语承诺类型
TermTypeDetails	保存有关术语类型和持续时间的详细信息。
WeightMeasurementUnit	权重维度的单位。

AvailabilityInformation

Object

产品系统的可用性信息。

名称	类型	说明
availabilityStage	AvailabilityStage	产品的当前可用性阶段。
disabledReason	DisabledReason	禁用产品的原因。
disabledReasonMessage	string	有关产品被禁用的原因的消息。

AvailabilityStage

枚举

产品的当前可用性阶段。

值	说明
Available	产品可用。
Preview	产品处于预览状态。
Signup	产品仅在注册时可用。
Discoverable	产品在我们的服务中不可用，但可以从其他来源发现。
ComingSoon	产品即将推出。
Unavailable	产品不可用。
Deprecated	产品已弃用。

BillingMeterDetails

Object

保存每种计费类型的计费计量详细信息。

名称	类型	说明
frequency	string	重复周期的频率。
meterDetails	MeterDetails: Pav2MeterDetails PurchaseMeterDetails	Represents MeterDetails.
meteringType	MeteringType	表示计量类型（例如一次性或重复）。
name	string	表示计费类型名称。
termTypeDetails	TermTypeDetails	表示术语类型详细信息。

BillingType

枚举

表示计费类型。

值	说明
Pav2	PaV2 billing.
Purchase	Purchase billing.

CategoryInformation

Object

子配置的类别相关属性。

名称	类型	说明
categoryDisplayName	string	子配置的类别显示名称。
categoryName	string	子配置的类别名称。
description	string	类别的说明文本。
links	Link[]	类别的链接。

ChargingType

枚举

Charging type.

值	说明
PerOrder	按订单收费类型。
PerDevice	按设备充电类型。

ChildConfiguration

Object

子配置对象。

名称	类型	说明
properties.availabilityInformation	AvailabilityInformation	产品系统的可用性信息。
properties.childConfigurationType	ChildConfigurationType	子配置类型。
properties.childConfigurationTypes	ChildConfigurationType[]	存在此配置的不同类型的子配置，这些配置可用于填充子配置筛选器。
properties.costInformation	CostInformation	产品系统的成本信息。
properties.description	Description	与产品系统相关的说明。
properties.dimensions	Dimensions	配置的维度。
properties.displayName	string	产品系统的显示名称。
properties.filterableProperties	FilterableProperty[]	产品支持的筛选器列表。
properties.fulfilledBy	FulfillmentType	负责在给定层次结构级别履行项的实体。
properties.groupedChildConfigurations	GroupedChildConfigurations[]	应用子配置筛选器后为配置提供的子配置，按子配置的类别名称分组。
properties.hierarchyInformation	HierarchyInformation	产品的层次结构信息。
properties.imageInformation	ImageInformation[]	产品系统的图像信息。
properties.isPartOfBaseConfiguration	boolean	用于指示子配置是否是基本配置的一部分的标志，这意味着客户在下订单时不需要在 OptInAdditionalConfigurations 中传递此配置，默认情况下会寄送该配置。
properties.maximumQuantity	integer (int32)	客户在选择此配置时可以订购的最大数量。
properties.minimumQuantity	integer (int32)	客户在选择此配置时可以订购的最小数量。
properties.provisioningSupport	ProvisioningSupport	确定配置支持的预配的性质。
properties.specifications	Specification[]	配置的规范。
properties.supportedTermCommitmentDurations	string[] (duration)	配置支持的期限承诺期限。

ChildConfigurationFilter

Object

子配置筛选器。

名称	类型	说明
childConfigurationTypes	ChildConfigurationType[]	筛选以提取属于给定配置类型列表的所有子配置。
hierarchyInformations	HierarchyInformation[]	客户想要筛选给定配置的子配置层次结构列表。

ChildConfigurationType

枚举

值	说明
DeviceConfiguration	子配置是设备配置。
AdditionalConfiguration	子配置是附加的配置。

Configuration

Object

Configuration object.

名称	类型	说明
availabilityInformation	AvailabilityInformation	产品系统的可用性信息。
costInformation	CostInformation	产品系统的成本信息。
description	Description	与产品系统相关的说明。
displayName	string	产品系统的显示名称。
fulfilledBy	FulfillmentType	负责在给定层次结构级别履行项的实体。
hierarchyInformation	HierarchyInformation	产品的层次结构信息。
imageInformation	ImageInformation[]	产品系统的图像信息。
properties.childConfigurationTypes	ChildConfigurationType[]	存在此配置的不同类型的子配置，这些配置可用于填充子配置筛选器。
properties.dimensions	Dimensions	配置的维度。
properties.filterableProperties	FilterableProperty[]	产品支持的筛选器列表。
properties.groupedChildConfigurations	GroupedChildConfigurations[]	应用子配置筛选器后为配置提供的子配置，按子配置的类别名称分组。
properties.provisioningSupport	ProvisioningSupport	确定配置支持的预配的性质。
properties.specifications	Specification[]	配置的规范。
properties.supportedTermCommitmentDurations	string[] (duration)	配置支持的期限承诺期限。

ConfigurationFilter

Object

Configuration filters.

名称	类型	说明
childConfigurationFilter	ChildConfigurationFilter	筛选以提取配置中存在的特定子配置。这必须传递到提取特定子配置的列表，或特定子配置类型的所有子配置。
filterableProperty	FilterableProperty[]	特定于产品的筛选器。
hierarchyInformation	HierarchyInformation	产品层次结构信息。

Configurations

Object

配置列表。

名称	类型	说明
nextLink	string (uri)	指向下一页项的链接
value	Configuration[]	本页的配置项

ConfigurationsRequest

Object

配置请求对象。

名称	类型	说明
configurationFilter	ConfigurationFilter	保存有关产品层次结构信息和可筛选属性的详细信息。
customerSubscriptionDetails	CustomerSubscriptionDetails	客户订阅属性。客户端可以通过显式传递订阅详细信息来向未注册的客户显示可用产品。

CostInformation

Object

产品系统的成本信息。

名称	类型	说明
billingInfoUrl	string	显示计费信息的默认 URL。
billingMeterDetails	BillingMeterDetails[]	有关产品系统的各种计费方面的详细信息。

CustomerSubscriptionDetails

Object

保存客户订阅详细信息。客户端可以通过显式传递订阅详细信息来向未注册的客户显示可用产品。

名称	类型	说明
locationPlacementId	string	订阅的位置放置 ID。
quotaId	string	订阅的配额 ID。
registeredFeatures	CustomerSubscriptionRegisteredFeatures[]	订阅的已注册功能标志列表。

CustomerSubscriptionRegisteredFeatures

Object

表示订阅注册的功能。

名称	类型	说明
name	string	订阅注册功能的名称。
state	string	订阅注册功能的状态。

Description

Object

说明产品系统的相关属性。

名称	类型	说明
attributes	string[]	产品系统的属性。
descriptionType	DescriptionType	说明的类型。
keywords	string[]	产品系统的关键字。
links	Link[]	产品系统的链接。
longDescription	string	产品系统的长说明。
shortDescription	string	产品系统的简短说明。

DescriptionType

枚举

说明的类型。

值	说明
Base	Base description.

Dimensions

Object

配置的维度。

名称	类型	说明
depth	number (double)	设备的深度。
height	number (double)	设备的高度。
length	number (double)	设备的长度。
lengthHeightUnit	LengthHeightUnit	长度、高度和宽度尺寸的单位。
weight	number (double)	设备的权重。
weightUnit	WeightMeasurementUnit	权重维度的单位。
width	number (double)	设备的宽度。

DisabledReason

枚举

禁用产品的原因。

值	说明
None	Not disabled.
Country	在请求的国家/地区不可用。
Region	无法将数据推送到请求的 Azure 区域。
Feature	未启用必需的功能。
OfferType	订阅没有所需的产品/服务类型。
NoSubscriptionInfo	订阅尚未注册到 Microsoft.DataBox 和服务没有订阅通知。
NotAvailable	该产品尚不可用。
OutOfStock	该产品缺货。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

Error response

名称	类型	说明
error	ErrorDetail	错误对象。

FilterableProperty

Object

支持的不同类型的筛选器及其值。

名称	类型	说明
supportedValues	string[]	要筛选的值。
type	SupportedFilterTypes	产品筛选器的类型。

FulfillmentType

枚举

负责在给定层次结构级别履行项的实体。

值	说明
Microsoft	履行（产品产品/服务的完整旅程）由 Microsoft 处理。
External	履行（产品/服务的完整旅程）由外部第三方实体处理。

GroupedChildConfigurations

Object

分组子配置对象。

名称	类型	说明
categoryInformation	CategoryInformation	Category information.
childConfigurations	ChildConfiguration[]	子配置列表。

HierarchyInformation

Object

保存有关产品层次结构信息的详细信息。

名称	类型	说明
configurationIdDisplayName	string	表示模型显示名称。
configurationName	string	表示唯一标识配置的配置名称。
productFamilyName	string	表示唯一标识产品系列的产品名称。
productLineName	string	表示唯一标识生产线的产品名称。
productName	string	表示唯一标识产品的产品名称。

ImageInformation

Object

产品的图像。

名称	类型	说明
imageType	ImageType	图像的类型。
imageUrl	string	图像的 URL。

ImageType

枚举

图像的类型。

值	说明
MainImage	Main image.
BulletImage	Bullet image.
GenericImage	Generic image.

LengthHeightUnit

枚举

长度、高度和宽度尺寸的单位。

值	说明
IN	英寸，适用于美国西部。
CM	Centimeter.

Link

Object

返回与产品相关的链接。

名称	类型	说明
linkType	LinkType	链接的类型。
linkUrl	string	链接的 URL。

LinkType

枚举

链接的类型。

值	说明
Generic	Generic link.
TermsAndConditions	条款和条件链接。
Specification	指向产品规范的链接。
Documentation	指向产品文档的链接。
KnowMore	要了解详细信息的链接。
SignUp	用于注册产品的链接。
Discoverable	链接到从另一个源订购产品，而不是从 Azure Edge 硬件中心订购产品。

MeteringType

枚举

表示计量类型（例如一次性或重复）。

值	说明
OneTime	一次性计费。
Recurring	Recurring billing.
Adhoc	Adhoc billing.

Pav2MeterDetails

Object

计费类型 PAV2 计量详细信息。

名称	类型	说明
billingType	string: Pav2	表示计费类型。
chargingType	ChargingType	Charging type.
meterGuid	string	请求的数据中心和传输的验证状态。
multiplier	number (double)	适用于 Pav2 计费的计费单位。

ProvisioningSupport

枚举

确定配置支持的预配的性质。

值	说明
CloudBased	可以从云预配配置。
Manual	最终用户需要手动预配配置。

PurchaseMeterDetails

Object

计费类型购买计量详细信息。

名称	类型	说明
billingType	string: Purchase	表示计费类型。
chargingType	ChargingType	Charging type.
multiplier	number (double)	适用于 Pav2 计费的计费单位。
productId	string	Product Id.
skuId	string	Sku Id.
termId	string	Term Id.

Specification

Object

配置规范。

名称	类型	说明
name	string	规范的名称。
value	string	规范的值。

SupportedFilterTypes

枚举

产品筛选器的类型。

值	说明
ShipToCountries	寄送到国家/地区。
DoubleEncryptionStatus	双重加密状态。

TermCommitmentType

枚举

术语承诺类型

值	说明
None	即用即付期限承诺模型。
Trial	试用期限承诺模型。
Timed	基于时间的术语承诺模型。

TermTypeDetails

Object

保存有关术语类型和持续时间的详细信息。

名称	类型	说明
termType	TermCommitmentType	术语承诺类型
termTypeDuration	string (duration)	术语类型的持续时间。

WeightMeasurementUnit

枚举

权重维度的单位。

值	说明
LBS	Pounds.
KGS	Kilograms.