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

List Configurations - List Configurations

参考

Service:: Edge Hardware Center

API Version:: 2021-12-01

此方法提供给定产品系列、产品系列和订阅下产品的配置列表。

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

With optional parameters:

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。
$skipToken	query		string	配置列表支持$skipToken，其中提供了配置列表中的下一页。

请求正文

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

响应

名称	类型	说明
200 OK	Configurations	给定产品系列、产品系列和订阅下产品的配置列表。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

ListConfigurations

Sample Request

POST https://management.azure.com/subscriptions/YourSubscriptionId/providers/Microsoft.EdgeOrder/listConfigurations?api-version=2021-12-01

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

import com.azure.core.util.Context;
import com.azure.resourcemanager.edgeorder.models.ConfigurationFilters;
import com.azure.resourcemanager.edgeorder.models.ConfigurationsRequest;
import com.azure.resourcemanager.edgeorder.models.FilterableProperty;
import com.azure.resourcemanager.edgeorder.models.HierarchyInformation;
import com.azure.resourcemanager.edgeorder.models.SupportedFilterTypes;
import java.util.Arrays;

/** Samples for ResourceProvider ListConfigurations. */
public final class Main {
    /*
     * x-ms-original-file: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/ListConfigurations.json
     */
    /**
     * Sample code: ListConfigurations.
     *
     * @param manager Entry point to EdgeOrderManager.
     */
    public static void listConfigurations(com.azure.resourcemanager.edgeorder.EdgeOrderManager manager) {
        manager
            .resourceProviders()
            .listConfigurations(
                new ConfigurationsRequest()
                    .withConfigurationFilters(
                        Arrays
                            .asList(
                                new ConfigurationFilters()
                                    .withHierarchyInformation(
                                        new HierarchyInformation()
                                            .withProductFamilyName("AzureStackEdge")
                                            .withProductLineName("AzureStackEdge")
                                            .withProductName("AzureStackEdgeGPU"))
                                    .withFilterableProperty(
                                        Arrays
                                            .asList(
                                                new FilterableProperty()
                                                    .withType(SupportedFilterTypes.SHIP_TO_COUNTRIES)
                                                    .withSupportedValues(Arrays.asList("US")))))),
                null,
                Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.edgeorder import EdgeOrderManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-edgeorder
# USAGE
    python list_configurations.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = EdgeOrderManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="YourSubscriptionId",
    )

    response = client.list_configurations(
        configurations_request={
            "configurationFilters": [
                {
                    "filterableProperty": [{"supportedValues": ["US"], "type": "ShipToCountries"}],
                    "hierarchyInformation": {
                        "productFamilyName": "azurestackedge",
                        "productLineName": "azurestackedge",
                        "productName": "azurestackedgegpu",
                    },
                }
            ]
        },
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/ListConfigurations.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armedgeorder_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/edgeorder/armedgeorder"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/ListConfigurations.json
func ExampleManagementClient_NewListConfigurationsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armedgeorder.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewManagementClient().NewListConfigurationsPager(armedgeorder.ConfigurationsRequest{
		ConfigurationFilters: []*armedgeorder.ConfigurationFilters{
			{
				FilterableProperty: []*armedgeorder.FilterableProperty{
					{
						Type: to.Ptr(armedgeorder.SupportedFilterTypesShipToCountries),
						SupportedValues: []*string{
							to.Ptr("US")},
					}},
				HierarchyInformation: &armedgeorder.HierarchyInformation{
					ProductFamilyName: to.Ptr("azurestackedge"),
					ProductLineName:   to.Ptr("azurestackedge"),
					ProductName:       to.Ptr("azurestackedgegpu"),
				},
			}},
	}, &armedgeorder.ManagementClientListConfigurationsOptions{SkipToken: nil})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.Configurations = armedgeorder.Configurations{
		// 	Value: []*armedgeorder.Configuration{
		// 		{
		// 			Properties: &armedgeorder.ConfigurationProperties{
		// 				Description: &armedgeorder.Description{
		// 					Attributes: []*string{
		// 					},
		// 					DescriptionType: to.Ptr(armedgeorder.DescriptionTypeBase),
		// 					Keywords: []*string{
		// 						to.Ptr("GPU")},
		// 						Links: []*armedgeorder.Link{
		// 						},
		// 						LongDescription: to.Ptr(""),
		// 						ShortDescription: to.Ptr(""),
		// 					},
		// 					AvailabilityInformation: &armedgeorder.AvailabilityInformation{
		// 						AvailabilityStage: to.Ptr(armedgeorder.AvailabilityStageAvailable),
		// 						DisabledReason: to.Ptr(armedgeorder.DisabledReasonNone),
		// 					},
		// 					CostInformation: &armedgeorder.CostInformation{
		// 						BillingMeterDetails: []*armedgeorder.BillingMeterDetails{
		// 						},
		// 					},
		// 					DisplayName: to.Ptr("Azure Stack Edge Pro - 1 GPU"),
		// 					HierarchyInformation: &armedgeorder.HierarchyInformation{
		// 						ConfigurationName: to.Ptr("edgep_base"),
		// 						ProductFamilyName: to.Ptr("azurestackedge"),
		// 						ProductLineName: to.Ptr("azurestackedge"),
		// 						ProductName: to.Ptr("azurestackedgegpu"),
		// 					},
		// 					ImageInformation: []*armedgeorder.ImageInformation{
		// 					},
		// 					FilterableProperties: []*armedgeorder.FilterableProperty{
		// 						{
		// 							Type: to.Ptr(armedgeorder.SupportedFilterTypesShipToCountries),
		// 							SupportedValues: []*string{
		// 								to.Ptr("US")},
		// 						}},
		// 						Dimensions: &armedgeorder.Dimensions{
		// 							Depth: to.Ptr[float64](2),
		// 							Height: to.Ptr[float64](15),
		// 							Length: to.Ptr[float64](50),
		// 							LengthHeightUnit: to.Ptr(armedgeorder.LengthHeightUnitIN),
		// 							Weight: to.Ptr[float64](50),
		// 							WeightUnit: to.Ptr(armedgeorder.WeightMeasurementUnitLBS),
		// 							Width: to.Ptr[float64](5),
		// 						},
		// 						Specifications: []*armedgeorder.Specification{
		// 							{
		// 								Name: to.Ptr("Usable compute"),
		// 								Value: to.Ptr("40 vCPU"),
		// 							},
		// 							{
		// 								Name: to.Ptr("Usable memory"),
		// 								Value: to.Ptr("102 GB"),
		// 							},
		// 							{
		// 								Name: to.Ptr("Usable storage"),
		// 								Value: to.Ptr("4.2 TB"),
		// 						}},
		// 					},
		// 			}},
		// 		}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.EdgeOrder;
using Azure.ResourceManager.EdgeOrder.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/edgeorder/resource-manager/Microsoft.EdgeOrder/stable/2021-12-01/examples/ListConfigurations.json
// this example is just showing the usage of "ListConfigurations" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "fa68082f-8ff7-4a25-95c7-ce9da541242f";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
ConfigurationsContent content = new ConfigurationsContent(new ConfigurationFilters[]
{
new ConfigurationFilters(new HierarchyInformation()
{
ProductFamilyName = "AzureStackEdge",
ProductLineName = "AzureStackEdge",
ProductName = "AzureStackEdgeGPU",
})
{
FilterableProperty =
{
new FilterableProperty(SupportedFilterType.ShipToCountries,new string[]
{
"US"
})
},
}
});
await foreach (ProductConfiguration item in subscriptionResource.GetConfigurationsAsync(content))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

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

定义

名称	说明
AvailabilityInformation	产品系统的可用性信息。
AvailabilityStage	产品的当前可用性阶段。可用性阶段
BillingMeterDetails	保存每种类型的计费的计费计量详细信息
ChargingType	充电类型。
Configuration	配置对象。
ConfigurationFilters	配置筛选器
Configurations	配置列表。
ConfigurationsRequest	配置请求对象。
CostInformation	产品系统的成本信息
CustomerSubscriptionDetails	保留客户订阅详细信息。客户端可以通过显式传递订阅详细信息向未注册的客户显示可用产品
CustomerSubscriptionRegisteredFeatures	表示订阅注册的功能
Description	产品系统的相关属性说明。
DescriptionType	说明的类型。
Dimensions	配置的维度。
DisabledReason	禁用产品的原因。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
FilterableProperty	支持的不同类型的筛选器及其值。
HierarchyInformation	保存有关产品层次结构信息的详细信息
ImageInformation	产品的图像
ImageType	图像的类型
LengthHeightUnit	长度、高度和宽度维度的单位。
Link	返回与产品相关的链接
LinkType	链接类型
MeteringType	表示计量类型 (，例如一次性或循环)
Pav2MeterDetails	计费类型 PAV2 计量详细信息
PurchaseMeterDetails	计费类型购买计量详细信息
Specification	配置规范
SupportedFilterTypes	产品筛选器的类型。
WeightMeasurementUnit	重量尺寸的单位。

AvailabilityInformation

产品系统的可用性信息。

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

AvailabilityStage

产品的当前可用性阶段。可用性阶段

名称	类型	说明
Available	string	产品可用。
ComingSoon	string	产品即将推出。
Deprecated	string	产品已弃用。
Preview	string	产品为预览版。
Signup	string	产品仅在注册时可用。
Unavailable	string	产品不可用。

BillingMeterDetails

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

名称	类型	说明
frequency	string	定期频率
meterDetails	MeterDetails: Pav2MeterDetails PurchaseMeterDetails	表示 MeterDetails
meteringType	MeteringType	表示计量类型 (例如一次性或重复)
name	string	表示计费类型名称

ChargingType

充电类型。

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

Configuration

配置对象。

名称	类型	说明
availabilityInformation	AvailabilityInformation	产品系统的可用性信息。
costInformation	CostInformation	产品系统的成本信息。
description	Description	与产品系统相关的说明。
displayName	string	产品系统的显示名称。
hierarchyInformation	HierarchyInformation	产品的层次结构信息。
imageInformation	ImageInformation[]	产品系统的图像信息。
properties.dimensions	Dimensions	配置维度
properties.filterableProperties	FilterableProperty[]	产品支持的筛选器列表
properties.specifications	Specification[]	配置规范

ConfigurationFilters

配置筛选器

名称	类型	说明
filterableProperty	FilterableProperty[]	特定于产品的筛选器
hierarchyInformation	HierarchyInformation	产品层次结构信息

Configurations

配置列表。

名称	类型	说明
nextLink	string	下一组配置的链接。
value	Configuration[]	配置列表。

ConfigurationsRequest

配置请求对象。

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

CostInformation

产品系统的成本信息

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

CustomerSubscriptionDetails

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

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

CustomerSubscriptionRegisteredFeatures

表示订阅注册的功能

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

Description

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

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

DescriptionType

说明的类型。

名称	类型	说明
Base	string	基本说明。

Dimensions

配置的维度。

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

DisabledReason

禁用产品的原因。

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

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

FilterableProperty

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

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

HierarchyInformation

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

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

ImageInformation

产品的图像

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

ImageType

图像的类型

名称	类型	说明
BulletImage	string	项目符号图像。
GenericImage	string	通用映像。
MainImage	string	主图像。

LengthHeightUnit

长度、高度和宽度维度的单位。

名称	类型	说明
CM	string	厘米。
IN	string	Inch，适用于美国西部。

Link

返回与产品相关的链接

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

LinkType

链接类型

名称	类型	说明
Documentation	string	指向产品文档的链接
Generic	string	通用链接。
KnowMore	string	了解详细信息的链接
SignUp	string	用于注册产品的链接
Specification	string	指向产品规范的链接。
TermsAndConditions	string	条款和条件链接。

MeteringType

表示计量类型 (，例如一次性或循环)

名称	类型	说明
Adhoc	string	临时计费。
OneTime	string	一次性计费。
Recurring	string	定期计费。

Pav2MeterDetails

计费类型 PAV2 计量详细信息

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

PurchaseMeterDetails

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

名称	类型	说明
billingType	string: Purchase	表示计费类型。
chargingType	ChargingType	充电类型。
multiplier	number	适用于 Pav2 计费的计费单位
productId	string	Product Id
skuId	string	Sku Id
termId	string	术语 ID

Specification

配置规范

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

SupportedFilterTypes

产品筛选器的类型。

名称	类型	说明
DoubleEncryptionStatus	string	双重加密状态
ShipToCountries	string	寄送到国家/地区

WeightMeasurementUnit

重量尺寸的单位。

名称	类型	说明
KGS	string	公斤。
LBS	string	磅。

List Configurations - List Configurations

URI 参数

请求正文

响应

安全性

azure_auth

Scopes

示例

ListConfigurations

Sample Request

Sample Response

定义

AvailabilityInformation

AvailabilityStage

BillingMeterDetails

ChargingType

Configuration

ConfigurationFilters

Configurations

ConfigurationsRequest

CostInformation

CustomerSubscriptionDetails

CustomerSubscriptionRegisteredFeatures

Description

DescriptionType

Dimensions

DisabledReason

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FilterableProperty

HierarchyInformation

ImageInformation

ImageType

LengthHeightUnit

Link

LinkType

MeteringType

Pav2MeterDetails

PurchaseMeterDetails

Specification

SupportedFilterTypes

WeightMeasurementUnit

其他资源