Reservation interface
表示预留的接口。
方法
方法详细信息
archive(string, string, ReservationArchiveOptionalParams)
存档 Reservation 将其移动到 Archived 状态。
function archive(reservationOrderId: string, reservationId: string, options?: ReservationArchiveOptionalParams): Promise<void>参数
- reservationOrderId
-
string
预留的订单 ID
- reservationId
-
string
预留项的 ID
- options
- ReservationArchiveOptionalParams
选项参数。
返回
Promise<void>
beginAvailableScopes(string, string, AvailableScopeRequest, ReservationAvailableScopesOptionalParams)
检查请求中的范围是否对 Reservation有效。
function beginAvailableScopes(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<SimplePollerLike<OperationState<AvailableScopeProperties>, AvailableScopeProperties>>参数
- reservationOrderId
-
string
预留的订单 ID
- reservationId
-
string
预留项的 ID
要检查资格的范围。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<AvailableScopeProperties>, AvailableScopeProperties>>
beginAvailableScopesAndWait(string, string, AvailableScopeRequest, ReservationAvailableScopesOptionalParams)
检查请求中的范围是否对 Reservation有效。
function beginAvailableScopesAndWait(reservationOrderId: string, reservationId: string, body: AvailableScopeRequest, options?: ReservationAvailableScopesOptionalParams): Promise<AvailableScopeProperties>参数
- reservationOrderId
-
string
预留的订单 ID
- reservationId
-
string
预留项的 ID
要检查资格的范围。
选项参数。
返回
Promise<AvailableScopeProperties>
beginMerge(string, MergeRequest, ReservationMergeOptionalParams)
将指定的 Reservation合并为新的 Reservation。 要合并的两个 Reservation必须具有相同的属性。
function beginMerge(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams): Promise<SimplePollerLike<OperationState<ReservationMergeResponse>, ReservationMergeResponse>>参数
- reservationOrderId
-
string
预留的订单 ID
- body
- MergeRequest
预留的商业请求所需的信息
- options
- ReservationMergeOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ReservationMergeResponse>, ReservationMergeResponse>>
beginMergeAndWait(string, MergeRequest, ReservationMergeOptionalParams)
将指定的 Reservation合并为新的 Reservation。 要合并的两个 Reservation必须具有相同的属性。
function beginMergeAndWait(reservationOrderId: string, body: MergeRequest, options?: ReservationMergeOptionalParams): Promise<ReservationMergeResponse>参数
- reservationOrderId
-
string
预留的订单 ID
- body
- MergeRequest
预留的商业请求所需的信息
- options
- ReservationMergeOptionalParams
选项参数。
返回
Promise<ReservationMergeResponse>
beginSplit(string, SplitRequest, ReservationSplitOptionalParams)
将 Reservation 拆分为具有指定数量分布的两个 Reservation。
function beginSplit(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams): Promise<SimplePollerLike<OperationState<ReservationSplitResponse>, ReservationSplitResponse>>参数
- reservationOrderId
-
string
预留的订单 ID
- body
- SplitRequest
拆分预留项所需的信息
- options
- ReservationSplitOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ReservationSplitResponse>, ReservationSplitResponse>>
beginSplitAndWait(string, SplitRequest, ReservationSplitOptionalParams)
将 Reservation 拆分为具有指定数量分布的两个 Reservation。
function beginSplitAndWait(reservationOrderId: string, body: SplitRequest, options?: ReservationSplitOptionalParams): Promise<ReservationSplitResponse>参数
- reservationOrderId
-
string
预留的订单 ID
- body
- SplitRequest
拆分预留项所需的信息
- options
- ReservationSplitOptionalParams
选项参数。
返回
Promise<ReservationSplitResponse>
beginUpdate(string, string, Patch, ReservationUpdateOptionalParams)
更新 Reservation的应用范围。
function beginUpdate(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ReservationResponse>, ReservationResponse>>参数
- reservationOrderId
-
string
预留的订单 ID
- reservationId
-
string
预留项的 ID
- parameters
- Patch
修补预留项所需的信息
- options
- ReservationUpdateOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ReservationResponse>, ReservationResponse>>
beginUpdateAndWait(string, string, Patch, ReservationUpdateOptionalParams)
更新 Reservation的应用范围。
function beginUpdateAndWait(reservationOrderId: string, reservationId: string, parameters: Patch, options?: ReservationUpdateOptionalParams): Promise<ReservationResponse>参数
- reservationOrderId
-
string
预留的订单 ID
- reservationId
-
string
预留项的 ID
- parameters
- Patch
修补预留项所需的信息
- options
- ReservationUpdateOptionalParams
选项参数。
返回
Promise<ReservationResponse>
get(string, string, ReservationGetOptionalParams)
获取特定 Reservation 详细信息。
function get(reservationOrderId: string, reservationId: string, options?: ReservationGetOptionalParams): Promise<ReservationResponse>参数
- reservationOrderId
-
string
预留的订单 ID
- reservationId
-
string
预留项的 ID
- options
- ReservationGetOptionalParams
选项参数。
返回
Promise<ReservationResponse>
list(string, ReservationListOptionalParams)
在单个 Reservation内列出 ReservationOrder。
function list(reservationOrderId: string, options?: ReservationListOptionalParams): PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>参数
- reservationOrderId
-
string
预留的订单 ID
- options
- ReservationListOptionalParams
选项参数。
返回
listAll(ReservationListAllOptionalParams)
通过预配用户有权访问当前租户的状态列出预留和预留组汇总计数。
function listAll(options?: ReservationListAllOptionalParams): PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>参数
- options
- ReservationListAllOptionalParams
选项参数。
返回
listRevisions(string, string, ReservationListRevisionsOptionalParams)
Reservation的所有修订列表。
function listRevisions(reservationOrderId: string, reservationId: string, options?: ReservationListRevisionsOptionalParams): PagedAsyncIterableIterator<ReservationResponse, ReservationResponse[], PageSettings>参数
- reservationOrderId
-
string
预留的订单 ID
- reservationId
-
string
预留项的 ID
选项参数。
返回
unarchive(string, string, ReservationUnarchiveOptionalParams)
将 Reservation 还原到存档之前的状态。
function unarchive(reservationOrderId: string, reservationId: string, options?: ReservationUnarchiveOptionalParams): Promise<void>参数
- reservationOrderId
-
string
预留的订单 ID
- reservationId
-
string
预留项的 ID
选项参数。
返回
Promise<void>