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

@azure/arm-edgeorder package

接口

AdditionalConfiguration

附加配置细节。

AddressDetails

订单物品的地址详情。

AddressProperties

地址属性。

AddressResource

地址资源。

AddressUpdateParameter

地址更新参数。

AddressUpdateProperties

地址更新属性。

AddressesCreateOptionalParams

可选参数。

AddressesDeleteOptionalParams

可选参数。

AddressesGetOptionalParams

可选参数。

AddressesListByResourceGroupOptionalParams

可选参数。

AddressesListBySubscriptionOptionalParams

可选参数。

AddressesOperations

表示 地址操作的接口。

AddressesUpdateOptionalParams

可选参数。

AvailabilityInformation

产品系统的可用性信息。

BasicInformation

任何产品系统的基础信息。

BillingMeterDetails

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

CancellationReason

取消的原因。

CategoryInformation

子配置的范畴相关属性。

ChildConfiguration

子配置对象。

ChildConfigurationFilter

子配置过滤器。

ChildConfigurationProperties

子配置的属性。

CommonProperties

代表产品层级中的共同属性。

Configuration

配置对象。

ConfigurationDeviceDetails

设备配置详情。

ConfigurationFilter

配置过滤器。

ConfigurationProperties

构型性质。

ConfigurationsRequest

配置请求对象。

ContactDetails

联系人详细信息。

CostInformation

产品系统的成本信息。

CustomerSubscriptionDetails

保存客户订阅详情。 客户端可以通过明确传递订阅信息向未注册客户展示可用产品。

CustomerSubscriptionRegisteredFeatures

代表订阅注册的功能。

Description

产品系统与属性相关的描述。

DeviceDetails

设备详细信息。

DevicePresenceVerificationDetails

所有权证明详细信息。

Dimensions

构型的尺寸。

DisplayInfo

描述产品显示信息。

EdgeOrderClientOptionalParams

客户端的可选参数。

EncryptionPreferences

与双重加密相关的偏好。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详情

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败操作的错误详细信息。

FilterableProperty

支持的不同类型过滤器及其数值。

ForwardShippingDetails

转发货物详情。

GroupedChildConfigurations

分组子配置对象。

HierarchyInformation

包含产品层级信息的详细信息。

ImageInformation

产品图片。

Link

退货链接与产品相关。

ManagementResourcePreferences

管理资源优先选择连接设备。

MeterDetails

包含计费类型及其计费指南的详细信息。

NotificationPreference

作业阶段的通知首选项。

Operation

从资源提供程序操作 API 返回的 REST API 操作的详细信息

OperationDisplay

作的局部显示信息。

OperationsListOptionalParams

可选参数。

OperationsOperations

表示作作的接口。

OrderItemDetails

订单项详细信息。

OrderItemDetailsUpdateParameter

订单 物品详情 可修补属性。

OrderItemProperties

表示订单物品属性。

OrderItemResource

代表订单物品资源。

OrderItemUpdateParameter

更新订单项参数。

OrderItemUpdateProperties

订购物品更新属性。

OrderItemsCancelOptionalParams

可选参数。

OrderItemsCreateOptionalParams

可选参数。

OrderItemsDeleteOptionalParams

可选参数。

OrderItemsGetOptionalParams

可选参数。

OrderItemsListByResourceGroupOptionalParams

可选参数。

OrderItemsListBySubscriptionOptionalParams

可选参数。

OrderItemsOperations

表示 OrderItems 操作的接口。

OrderItemsReturnOptionalParams

可选参数。

OrderItemsUpdateOptionalParams

可选参数。

OrderProperties

代表订单详情。

OrderResource

指定顺序的性质或参数。 订单是一组由一个或多个订单项目组成的组合。

OrdersGetOptionalParams

可选参数。

OrdersListByResourceGroupOptionalParams

可选参数。

OrdersListBySubscriptionOptionalParams

可选参数。

OrdersOperations

表示命令操作的接口。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

一个允许异步可迭代的接口,以完成和按页面进行迭代。

Pav2MeterDetails

计费类型 PAV2 电表详情。

Preferences

与订单相关的偏好。

Product

表示一个产品。

ProductDetails

表示产品详细信息。

ProductDetailsUpdateParameter

表示产品细节可修补属性。

ProductFamiliesMetadataDetails

产品系列元数据细节。

ProductFamiliesRequest

用于展示产品系列的筛选器。

ProductFamily

产品家族。

ProductFamilyProperties

产品家族的属性。

ProductLine

产品线。

ProductLineProperties

产品线的特性。

ProductProperties

产品的性质。

ProductsAndConfigurationsListConfigurationsOptionalParams

可选参数。

ProductsAndConfigurationsListProductFamiliesMetadataOptionalParams

可选参数。

ProductsAndConfigurationsListProductFamiliesOptionalParams

可选参数。

ProductsAndConfigurationsOperations

表示 ProductsAndConfigurations 操作的接口。

ProvisioningDetails

与供应资源相关的详细信息。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

PurchaseMeterDetails

计费类型 购买计量表详情。

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

ResourceIdentity

资源的 Msi 标识详细信息

ResourceProviderDetails

管理层角色扮演细节。

RestorePollerOptions
ReturnOrderItemDetails

返回订单项请求正文。

ReverseShippingDetails

反向发货详情。

ShippingAddress

客户希望接收设备的寄送地址。

SiteDetails

代表与网站相关的细节。

Specification

配置规格说明。

StageDetails

资源阶段细节。

SystemData

与创建和上次修改资源相关的元数据。

TermCommitmentInformation

学期承诺信息。

TermCommitmentPreferences

客户给予的条款承诺优先权。

TermTypeDetails

包含期限类型和期限的详细信息。

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

TransportPreferences

与 SKU 的发货物流相关的首选项。

UserAssignedIdentity

用户分配的标识属性

类型别名

ActionStatusEnum

说明订单项是否可删除。
KnownActionStatusEnum 可以与 ActionStatusEnum 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

允许:允许标记。
不允许:不允许标记。

ActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。
KnownActionType 可与 ActionType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

内部:操作适用于仅限内部的 API。

AddressClassification

基于地址的使用上下文的类型。
KnownAddressClassification 可以与 AddressClassification 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

运输:订单的收货地址。
网站:网站地址。

AddressType

地址类型。
KnownAddressType 可以与 AddressType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

无:地址类型未知。
住宅:住宅地址。
商业地址:商业地址。

AddressValidationStatus

地址验证的状态。
KnownAddressValidationStatus 可以与 AddressValidationStatus 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

有效:提供的地址有效。
无效:提供的地址无效或不支持。
歧义:所提供的地址不确定,请选择返回的备用地址之一。

AutoProvisioningStatus

自动预配详细信息。
KnownAutoProvisioningStatus 可以与 AutoProvisioningState 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

启用:配置已启用。 将按预批准运行,一旦设备被验证为右边位置,弧扩展将立即启用。
禁用:配置已禁用。

AvailabilityStage

产品的当前可用阶段。
KnownAvailabilityStage 可以与 AvailabilityStage 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

可获得:产品已供应。
预览:产品处于预览阶段。
注册:产品仅需注册即可获得。
可发现性:产品不在我们的服务中,但可从其他渠道发现。
即将推出:产品即将上线。
不可用:产品不可用。
弃用:产品被弃用。

AzureSupportedClouds

云设置为字符串文字类型的支持值

BillingType

代表账单类型。
KnownBillingType 可与 BillingType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

Pav2:PaV2账单。
购买:购买计费。

ChargingType

充电类型。
KnownChargingType 可以与 ChargingType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

按订单计费:按订单计费类型。
按设备计费:按设备计费类型。

ChildConfigurationType

Child ConfigurationType 类型

ContinuablePage

描述结果页面的接口。

CreatedByType

创建资源的实体类型。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体由用户创建。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体由托管标识创建。
:实体是由键创建的。

DescriptionType

描述类型。
KnownDescriptionType 可以与 DescriptionType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

基地:基地描述。

DevicePresenceVerificationStatus

持有权证明。
KnownDevicePresenceVerificationStatus 可以与 DevicePresenceVerificationStatus 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

未发起:设备尚未被验证是否在正确的边缘操作员或正确位置。
已完成:确认设备已验证位于右侧边缘操作员或位于正确位置。

DisabledReason

产品被禁用的原因。
KnownDisabledReason 可以与 DisabledReason 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

无:未被禁用。
国家:在请求的国家不可用。
Region:无法向请求的Azure区域推送数据。
功能:未启用必需功能。
OfferType:订阅没有必需的Offer类型。
NoSubscriptionInfo:订阅尚未注册到Microsoft。DataBox 和 Service 没有订阅通知。
不可得:该产品尚未上市。
缺货:产品缺货。

DoubleEncryptionStatus

客户输入的双重加密状态。 如果配置了“拒绝”或“禁用”策略,则强制为此参数提供此参数。
KnownDoubleEncryptionStatus 可以与 DoubleEncryptionStatus 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

禁用:双重加密已禁用。
启用:双重加密已启用。

FulfillmentType

负责在给定层级完成该项目的实体。
KnownFulfillmentType 可以与 FulfillmentType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

Microsoft:履约(整个产品流程)由microsoft负责。
外部:履约(产品提供的完整过程)由外部第三方实体负责。

IdentificationType

配置的识别类型。
KnownIdentificationType 可以与 IdentificationType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

不支持:产品没有任何明确标识符。
序列号:产品可通过序列号识别。

ImageType

图像的类型。
KnownImageType 可与 ImageType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

主图:主图。
子弹图像:子弹图像。
GenericImage:通用图像。

LengthHeightUnit

长度、高度和宽度的尺寸单位。
KnownLengthHeightUnit 可以与 LengthHeightUnit 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

IN:英寸,适用于美国西部。
CM:厘米。

LinkType

链接的类型。
KnownLinkType 可以与 LinkType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

通用:通用链接。
条款与条件:条款与条件链接。
规格:产品规格链接。
文档:产品文档链接。
KnowMore:了解更多信息链接。
注册:注册产品链接。
Discoverable:链接指向从其他渠道订购产品,而非从Azure Edge Hardware Center。

MeterDetailsUnion

MeterDetailsUnion 的别名

MeteringType

表示计量类型(例如一次性或循环)。
KnownMeteringType 可以与 MeteringType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

一次性计费:一次性计费。
常驻:常驻演员。
临时计费:临时计费。

NotificationStageName

阶段的名称。
KnownNotificationStageName 可以与 NotificationStageName 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

已发货:订单通知,商品由微软数据中心发货。
已送达:订单商品送达客户时收到通知。

OrderItemCancellationEnum

说明订单是否可取消。
KnownOrderItemCancellationEnum 可以与 OrderItemCancellationEnum 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

可取消:订单商品可免手续费取消。
CancellableWithFee:订单可按手续费取消。
NotCancellable:订单商品不可取消。

OrderItemReturnEnum

说明订单是否可退货。
KnownOrderItemReturnEnum 可以与 OrderItemReturnEnum 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

可退货:订单商品可免费退货。
可退货附费:订单可按费用退货。
不可退货:订单商品不可退货。

OrderItemType

订单项类型。
KnownOrderItemType 可以与 OrderItemType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

购买:购买订单。
租赁:租赁订单项。
外部:下令时不在青色。

OrderMode

定义 Order 项的模式。
KnownOrderMode 可以与 OrderMode 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

默认:默认顺序模式。
DoNotFulfill:命令不会被执行的模式。

Origin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”
KnownOrigin 可与 Origin 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:指示操作是由用户启动的。
系统:指示操作是由系统启动的。
用户,系统:指示操作是由用户或系统启动的。

ProvisioningState

预配状态
KnownProvisioningState 可与 ProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

创造:创造状态。
成功:成功了国家。
失败:失败状态。
取消:取消状态。

ProvisioningSupport

确定配置支持的配置性质。
KnownProvisioningSupport 可以与 ProvisioningSupport 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

云端配置:配置可以从云端进行配置。
手动:配置需要由终端用户手动配置。

StageName

艺名。
KnownStageName 可以与 StageName 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

已入选:目前处于选秀模式,仍可取消。
审核中:订单目前处于草稿阶段,仍可取消。
确认:订单已确认。
ReadyToShip:订单已准备好发货。
已发货:订单正在交付给客户。
已交付:订单已交付给客户。
ReadyToSetup:订单已准备好,可以云连接。
未使用:订单在客户现场使用中。
退货已发起:客户已发起退货。
ReturnPickedUp:订单正在从客户到Microsoft运输中。
ReturnedToMicrosoft:订单已收到回Microsoft。
返回完成:返回现已完成。
取消:订单已被取消。

StageStatus

舞台状态。
KnownStageStatus 可以与 Stagestatus 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

无:目前尚无状态。
进行中:阶段正在进行中。
成功:Stage成功了。
失败:舞台失败。
取消:舞台已取消。
取消:舞台正在取消。

SupportedFilterTypes

产品筛选器的类型。
KnownSupportedFilterTypes 可以与 SupportedFilterTypes 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

ShipToCountries:从国家寄货。
双加密状态:双加密状态。

TermCommitmentType

期限承诺类型
KnownTermCommitmentType 可以与 TermCommitmentType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

无:按需付费的定期承诺模式。
试验:试验期限承诺模型。
定时:基于时间的期限承诺模型。

TransportShipmentTypes

指示客户首选的发货物流类型。
KnownTransportShipmentTypes 可以与 TransportShipmentTypes 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

客户管理:货物物流由客户负责。
MicrosoftManaged:运输物流由Microsoft负责。

WeightMeasurementUnit

重量的尺寸单位。
已知权重测量单元(KnownWeightMeasurementUnit )可与权重测量单位互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

LBS:磅。
KGS:公斤。

枚举

AzureClouds

一个用来描述Azure云环境的enum。

KnownActionStatusEnum

说明订单项是否可删除。

KnownActionType

可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。

KnownAddressClassification

基于地址的使用上下文的类型。

KnownAddressType

地址类型。

KnownAddressValidationStatus

地址验证的状态。

KnownAutoProvisioningStatus

自动预配详细信息。

KnownAvailabilityStage

产品的当前可用阶段。

KnownBillingType

代表账单类型。

KnownChargingType

充电类型。

KnownChildConfigurationType

服务接受的已知 ChildConfigurationType 值。

KnownCreatedByType

创建资源的实体类型。

KnownDescriptionType

描述类型。

KnownDevicePresenceVerificationStatus

持有权证明。

KnownDisabledReason

产品被禁用的原因。

KnownDoubleEncryptionStatus

客户输入的双重加密状态。 如果配置了“拒绝”或“禁用”策略,则强制为此参数提供此参数。

KnownFulfillmentType

负责在给定层级完成该项目的实体。

KnownIdentificationType

配置的识别类型。

KnownImageType

图像的类型。

KnownLengthHeightUnit

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

KnownLinkType

链接的类型。

KnownMeteringType

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

KnownNotificationStageName

阶段的名称。

KnownOrderItemCancellationEnum

说明订单是否可取消。

KnownOrderItemReturnEnum

说明订单是否可退货。

KnownOrderItemType

订单项类型。

KnownOrderMode

定义 Order 项的模式。

KnownOrigin

操作的预期执行者;例如在基于资源的访问控制(RBAC)和审核日志的用户体验中。 默认值为“user,system”

KnownProvisioningState

预配状态

KnownProvisioningSupport

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

KnownStageName

艺名。

KnownStageStatus

舞台状态。

KnownSupportedFilterTypes

产品筛选器的类型。

KnownTermCommitmentType

术语承诺类型

KnownTransportShipmentTypes

指示客户首选的发货物流类型。

KnownVersions

可用的 API 版本。

KnownWeightMeasurementUnit

重量的尺寸单位。

函数

isRestError(unknown)

RestError 的 Typeguard

restorePoller<TResponse, TResult>(EdgeOrderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

变量

RestError

失败管道请求的自定义错误类型。

函数详细信息

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e

参数

e

unknown

catch 子句捕获的内容。

返回

e

restorePoller<TResponse, TResult>(EdgeOrderClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

function restorePoller<TResponse, TResult>(client: EdgeOrderClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

参数

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

返回

PollerLike<OperationState<TResult>, TResult>

变量详细信息

RestError

失败管道请求的自定义错误类型。

RestError: RestErrorConstructor

类型