Jobs interface
ジョブを表すインターフェイス。
メソッド
メソッドの詳細
beginCreate(string, string, JobResource, JobsCreateOptionalParams)
指定したパラメーターを使用して新しいジョブを作成します。 この API では既存のジョブを更新できないため、代わりに Update ジョブ 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
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<JobResource>, JobResource>>
beginCreateAndWait(string, string, JobResource, JobsCreateOptionalParams)
指定したパラメーターを使用して新しいジョブを作成します。 この API では既存のジョブを更新できないため、代わりに Update ジョブ API で更新する必要があります。
function beginCreateAndWait(resourceGroupName: string, jobName: string, jobResource: JobResource, options?: JobsCreateOptionalParams): Promise<JobResource>パラメーター
- resourceGroupName
-
string
リソース グループ名
- jobName
-
string
指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用する必要があります
- jobResource
- JobResource
要求本文からのジョブの詳細。
- options
- JobsCreateOptionalParams
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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
出荷集荷依頼の詳細。
options パラメーター。
戻り値
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
options パラメーター。
戻り値
Promise<void>
get(string, string, JobsGetOptionalParams)
指定したジョブに関する情報を取得します。
function get(resourceGroupName: string, jobName: string, options?: JobsGetOptionalParams): Promise<JobResource>パラメーター
- resourceGroupName
-
string
リソース グループ名
- jobName
-
string
指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用する必要があります
- options
- JobsGetOptionalParams
options パラメーター。
戻り値
Promise<JobResource>
list(JobsListOptionalParams)
サブスクリプションで使用可能なすべてのジョブを一覧表示します。
function list(options?: JobsListOptionalParams): PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>パラメーター
- options
- JobsListOptionalParams
options パラメーター。
戻り値
listByResourceGroup(string, JobsListByResourceGroupOptionalParams)
指定されたリソース グループで使用可能なすべてのジョブを一覧表示します。
function listByResourceGroup(resourceGroupName: string, options?: JobsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<JobResource, JobResource[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループ名
options パラメーター。
戻り値
listCredentials(string, string, JobsListCredentialsOptionalParams)
このメソッドは、ジョブに関連する暗号化されていないシークレットを取得します。
function listCredentials(resourceGroupName: string, jobName: string, options?: JobsListCredentialsOptionalParams): PagedAsyncIterableIterator<UnencryptedCredentials, UnencryptedCredentials[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループ名
- jobName
-
string
指定したリソース グループ内のジョブ リソースの名前。 ジョブ名の長さは 3 ~ 24 文字で、英数字とアンダースコアのみを使用する必要があります
options パラメーター。
戻り値
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
デバイスに出荷済み要求のマークを付けます
options パラメーター。
戻り値
Promise<void>