Jobs interface
表示作業的介面。
方法
方法詳細資料
beginCreate(string, string, JobResource, JobsCreateOptionalParams)
使用指定的參數建立新的作業。 現有的作業無法透過此 API 更新，應該改為使用更新作業 API 進行更新。
function beginCreate(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- jobResource
- JobResource
來自要求本文的作業詳細資料。
- options
- JobsCreateOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<JobResource>, JobResource>>
beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)
使用指定的參數建立新的作業。 現有的作業無法透過此 API 更新，應該改為使用更新作業 API 進行更新。
function beginCreateAndWait(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<JobResource>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- jobResource
- JobResource
來自要求本文的作業詳細資料。
- options
- JobsCreateOptionalParams
選項參數。
傳回
Promise<JobResource>
beginDelete(string, string, JobsDeleteOptionalParams)
刪除作業。
function beginDelete(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- options
- JobsDeleteOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, JobsDeleteOptionalParams)
刪除作業。
function beginDeleteAndWait(resourceGroupName: string, jobName: string, options?: JobsDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- options
- JobsDeleteOptionalParams
選項參數。
傳回
Promise<void>
beginUpdate(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)
更新現有作業的屬性。
function beginUpdate(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<JobResource>, JobResource>>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- jobResourceUpdateParameter
- JobResourceUpdateParameter
來自要求本文的作業更新參數。
- options
- JobsUpdateOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<JobResource>, JobResource>>
beginUpdateAndWait(string, string, JobResourceUpdateParameter, JobsUpdateOptionalParams)
更新現有作業的屬性。
function beginUpdateAndWait(resourceGroupName: string, jobName: string, jobResourceUpdateParameter: JobResourceUpdateParameter, options?: JobsUpdateOptionalParams): Promise<JobResource>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- jobResourceUpdateParameter
- JobResourceUpdateParameter
來自要求本文的作業更新參數。
- options
- JobsUpdateOptionalParams
選項參數。
傳回
Promise<JobResource>
bookShipmentPickUp(string, string, ShipmentPickUpRequest, JobsBookShipmentPickUpOptionalParams)
預約出貨取貨。
function bookShipmentPickUp(resourceGroupName: string, jobName: string, shipmentPickUpRequest: ShipmentPickUpRequest, options?: JobsBookShipmentPickUpOptionalParams): Promise<ShipmentPickUpResponse>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- shipmentPickUpRequest
- ShipmentPickUpRequest
出貨要求的詳細資料。
選項參數。
傳回
Promise<ShipmentPickUpResponse>
cancel(string, string, CancellationReason, JobsCancelOptionalParams)
CancelJob。
function cancel(resourceGroupName: string, jobName: string, cancellationReason: CancellationReason, options?: JobsCancelOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- cancellationReason
- CancellationReason
取消的原因。
- options
- JobsCancelOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, JobsGetOptionalParams)
取得指定之作業的相關資訊。
function get(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams): Promise<JobResource>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- options
- JobsGetOptionalParams
選項參數。
傳回
Promise<JobResource>
list(JobsListOptionalParams)
列出訂用帳戶下可用的所有作業。
function list(options?: JobsListOptionalParams): PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>參數
- options
- JobsListOptionalParams
選項參數。
傳回
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)
列出指定資源群組下可用的所有作業。
function listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>參數
- resourceGroupName
-
string
資源組名
選項參數。
傳回
listCredentials(string, string, JobsListCredentialsOptionalParams)
這個方法會取得與作業相關的未加密秘密。
function listCredentials(resourceGroupName: string, jobName: string, options?: JobsListCredentialsOptionalParams): PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>參數
- resourceGroupName
-
string
資源組名
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
選項參數。
傳回
markDevicesShipped(string, string, MarkDevicesShippedRequest, JobsMarkDevicesShippedOptionalParams)
要求將指定作業的裝置標示為已出貨
function markDevicesShipped(jobName: string, resourceGroupName: string, markDevicesShippedRequest: MarkDevicesShippedRequest, options?: JobsMarkDevicesShippedOptionalParams): Promise<void>參數
- jobName
-
string
指定資源群組內的作業資源名稱。 作業名稱長度必須介於 3 到 24 個字元之間，且只使用任何英數位元和底線
- resourceGroupName
-
string
資源組名
- markDevicesShippedRequest
- MarkDevicesShippedRequest
標示裝置出貨要求
選項參數。
傳回
Promise<void>