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