Jobs interface
Интерфейс, представляющий задания.
Методы
Сведения о методе
beginCreate(string, string, JobResource, JobsCreateOptionalParams)
Создает новое задание с указанными параметрами. Существующее задание не может быть обновлено с помощью этого API и должно быть обновлено с помощью API задания update.
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 задания update.
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>