@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 Resource Manager API 的常見錯誤回應,以傳回失敗作業的錯誤詳細數據。

FilterableProperty

支援的不同類型過濾器及其數值。

ForwardShippingDetails

轉寄運送細節。

GroupedChildConfigurations

分組子配置物件。

HierarchyInformation

儲存有關產品階層資訊的詳細資訊。

ImageInformation

產品圖片。

Link

退貨連結與產品相關。

ManagementResourcePreferences

管理資源偏好連結裝置。

MeterDetails

儲存帳單類型及其電表指引的詳細資訊。

NotificationPreference

作業階段的通知喜好設定。

Operation

從資源提供者作業 API 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

與 Provision Resource 相關的細節。

ProxyResource

Azure Resource Manager Proxy 資源的資源模型定義。 它不會有標記和位置

PurchaseMeterDetails

帳單類型 購買電錶詳情。

Resource

回應中針對所有 Azure Resource Manager 資源傳回的常見欄位

ResourceIdentity

資源的 Msi 身分識別詳細數據

ResourceProviderDetails

管理角色扮演細節。

RestorePollerOptions
ReturnOrderItemDetails

傳回訂單專案要求本文。

ReverseShippingDetails

反向運送細節。

ShippingAddress

客戶想要接收裝置的寄送位址。

SiteDetails

代表與網站相關的細節。

Specification

配置規格。

StageDetails

資源階段細節。

SystemData

與建立和上次修改資源相關的元數據。

TermCommitmentInformation

學期承諾資訊。

TermCommitmentPreferences

客戶給予的條款承諾優先權。

TermTypeDetails

包含期限類型及期限的詳細資訊。

TrackedResource

Azure Resource Manager 的資源模型定義已追蹤最上層資源,其具有「標記」和「位置」

TransportPreferences

與 SKU 的出貨物流相關的喜好設定。

UserAssignedIdentity

使用者指派的身分識別屬性

類型別名

ActionStatusEnum

說明訂單項目是否可刪除。
KnownActionStatusEnum 可與 ActionStatusEnum 互換使用,該列舉包含服務所支援的已知值。

服務支援的已知值

允許:允許標記。
不允許:禁止標記。

ActionType

可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。
KnownActionType 可以與 ActionType 交替使用,此列舉包含服務支援的已知值。

服務支援的已知值

內部:動作適用於僅限內部的 API。

AddressClassification

根據位址的使用內容類型。
KnownAddressClassification 可與 AddressClassification 互換使用,此列舉包含服務所支援的已知值。

服務支援的已知值

運送:訂單的運送地址。
地點:網站地址。

AddressType

位址的類型。
KnownAddressType 可與 AddressType 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

無:地址類型不明。
住宅:住宅地址。
商業:商業地址。

AddressValidationStatus

地址驗證的狀態。
KnownAddressValidationStatus 可與 AddressValidationState 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

有效:所提供的地址有效。
無效:提供的地址無效或不支援。
:所提供的地址不明確,請選擇回傳的備用地址之一。

AutoProvisioningStatus

自動布建詳細數據。
KnownAutoProvisioningStatus 可與 AutoProvisioningState 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

啟用:配置已啟用。 會依預先核准運作,且一旦裝置被驗證在正確的邊緣位置,弧擴展就會立即啟用。
停用:配置已停用。

AvailabilityStage

產品的目前可用性階段。
KnownAvailabilityStage 可與 AvailabilityStage 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

可取得:產品已上市。
預覽:產品目前處於預覽階段。
註冊:產品僅需註冊即可取得。
可發現性:產品不在我們的服務中,但可從其他來源找到。
即將推出:產品即將上市。
不可取得:產品無法取得。
棄用:產品已棄用。

AzureSupportedClouds

雲端設定為字串常值類型的支援值

BillingType

代表帳單類型。
KnownBillingType 可以與 BillingType 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

Pav2:PaV2 帳單。
購買:購買計費。

ChargingType

充電類型。
KnownChargingType 可與 ChargingType 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

按訂單收費:按訂單收費類型。
按裝置:按裝置充電類型。

ChildConfigurationType

類型 ChildConfigurationType

ContinuablePage

描述結果頁面的介面。

CreatedByType

建立資源的實體種類。
KnownCreatedByType 可以與 CreatedByType 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

使用者:實體是由使用者建立的。
應用程式:實體是由應用程式所建立。
ManagedIdentity:實體是由受控識別所建立。
金鑰:實體是由金鑰所建立。

DescriptionType

描述類型。
KnownDescriptionType 可與 DescriptionType 互換使用,此列舉包含服務所支援的已知值。

服務支援的已知值

基地:基地描述。

DevicePresenceVerificationStatus

持有證明狀態。
KnownDevicePresenceVerificationStatus 可與 DevicePresenceVerificationStatus 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

未啟動:該裝置尚未被驗證是否在正確的邊緣操作者或正確位置。
完成:確認裝置已驗證位於右側邊緣操作者或位置正確。

DisabledReason

產品被停用的原因。
KnownDisabledReason 可與 DisabledReason 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

:未被關閉。
國家:在所要求的國家無法提供。
Region:無法將資料推送至請求的Azure區域。
功能:未啟用必要的功能。
優惠類型:訂閱沒有必須的優惠類型。
NoSubscriptionInfo:訂閱尚未註冊至Microsoft。DataBox 和 Service 沒有訂閱通知。
不可取得:該產品尚未上市。
缺貨:產品缺貨。

DoubleEncryptionStatus

客戶輸入的雙重加密狀態。 如果已設定 『Deny』 或 'Disabled' 原則,則強制提供此參數。
KnownDoubleEncryptionStatus 可與 DoubleEncryptionStatus 互換使用,此列舉包含服務所支援的已知值。

服務支援的已知值

停用:雙重加密已停用。
啟用:雙重加密已啟用。

FulfillmentType

負責在特定階層層級履行該項目的實體。
KnownFulfillmentType 可與 FulfillmentType 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

Microsoft:產品流程(整個流程)由 microsoft 負責。
外部:履約(整個產品旅程)由外部第三方實體負責。

IdentificationType

配置的識別類型。
KnownIdentificationType 可與 IdentificationType 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

不支援:產品沒有明確的識別碼。
序號:產品可透過序號識別。

ImageType

影像的類型。
KnownImageType 可以與 ImageType 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

主圖:主圖。
BulletImage:子彈影像。
GenericImage:通用影像。

LengthHeightUnit

長度、高度與寬度的單位。
KnownLengthHeightUnit 可與 LengthHeightUnit 互換使用,此列舉包含服務所支援的已知值。

服務支援的已知值

IN:英吋,適用於美國西部。
CM:公分。

LinkType

連結的類型。
KnownLinkType 可與 LinkType 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

通用:通用連結。
條款與條件:條款與條件連結。
規格:產品規格連結。
文件說明:產品文件連結。
KnowMore:連結以了解更多資訊。
註冊:註冊產品連結。
Discoverable:連結指向從其他來源訂購產品,而非從 Edge 硬體中心Azure。

MeterDetailsUnion

MeterDetailsUnion 的別名

MeteringType

代表計量類型(例如一次性或重複計量)。
KnownMeteringType 可與 MeteringType 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

一次性:一次性帳單。
常駐:重複出現。
臨時計費:臨時計費。

NotificationStageName

階段的名稱。
KnownNotificationStageName 可與 NotificationStageName 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

已出貨:訂單通知:商品由 Microsoft Data Center 出貨。
已送達:訂單商品送達客戶時收到通知。

OrderItemCancellationEnum

說明訂單項目是否可取消。
KnownOrderItemCancellationEnum 可與 OrderItemCancellationEnum 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

可接受:訂購商品可免手續費取消。
CancellableWithFee:訂購商品可支付手續費取消。
NotCancellable:訂單商品無法取消。

OrderItemReturnEnum

說明訂單是否可退貨。
KnownOrderItemReturnEnum 可與 OrderItemReturnEnum 互換使用,該 enum 包含服務所支援的已知值。

服務支援的已知值

可退貨:訂購商品可免費退貨。
可退貨附費:訂購商品可附費退貨。
不可退貨:訂單商品不可退貨。

OrderItemType

訂單項目類型。
KnownOrderItemType 可與 OrderItemType 互換使用,此列舉包含服務所支援的已知值。

服務支援的已知值

購買:購買訂單項目。
租借:租借訂單項目。
外部:在Azure之外下達的訂單。

OrderMode

定義 Order 專案的模式。
KnownOrderMode 可與 OrderMode 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

預設:預設順序模式。
DoNotFulfill:一種不會完成命令的模式。

Origin

作業的預期執行程式;如同資源型 存取控制 (RBAC) 和稽核記錄 UX。 預設值為「user,system」
KnownOrigin 可以與 Origin 互換使用,此列舉包含服務支援的已知值。

服務支援的已知值

user:表示作業是由使用者起始。
system:指出作業是由系統起始。
user,system:指出作業是由使用者或系統起始。

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 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

CustomerManaged:出貨物流由客戶負責。
MicrosoftManaged:運輸物流由Microsoft負責。

WeightMeasurementUnit

以重量的尺寸為單位。
已知的重量測量單元(KnownWeightMeasurementUnit )可與重量測量單位互換使用,此枚舉包含服務所支援的已知數值。

服務支援的已知值

LBS:磅數。
KGS:公斤。

列舉

AzureClouds

描述 Azure 雲端環境的列舉。

KnownActionStatusEnum

說明訂單項目是否可刪除。

KnownActionType

可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。

KnownAddressClassification

根據位址的使用內容類型。

KnownAddressType

位址的類型。

KnownAddressValidationStatus

地址驗證的狀態。

KnownAutoProvisioningStatus

自動布建詳細數據。

KnownAvailabilityStage

產品的目前可用性階段。

KnownBillingType

代表帳單類型。

KnownChargingType

充電類型。

KnownChildConfigurationType

服務接受的已知 ChildConfigurationType 值。

KnownCreatedByType

建立資源的實體種類。

KnownDescriptionType

描述類型。

KnownDevicePresenceVerificationStatus

持有證明狀態。

KnownDisabledReason

產品被停用的原因。

KnownDoubleEncryptionStatus

客戶輸入的雙重加密狀態。 如果已設定 『Deny』 或 'Disabled' 原則,則強制提供此參數。

KnownFulfillmentType

負責在特定階層層級履行該項目的實體。

KnownIdentificationType

配置的識別類型。

KnownImageType

影像的類型。

KnownLengthHeightUnit

長度、高度與寬度的單位。

KnownLinkType

連結的類型。

KnownMeteringType

代表計量類型(例如一次性或重複計量)。

KnownNotificationStageName

階段的名稱。

KnownOrderItemCancellationEnum

說明訂單項目是否可取消。

KnownOrderItemReturnEnum

說明訂單是否可退貨。

KnownOrderItemType

訂單項目類型。

KnownOrderMode

定義 Order 專案的模式。

KnownOrigin

作業的預期執行程式;如同資源型 存取控制 (RBAC) 和稽核記錄 UX。 默認值為 “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

類型