Job - List By Automation Account

Ссылка

Служба:: Automation

Версия API:: 2023-11-01

Получение списка заданий.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs?api-version=2023-11-01

С использованием необязательных параметров:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs?$filter={$filter}&api-version=2023-11-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
automationAccountName	path	True	string	Имя учетной записи службы автоматизации.
resourceGroupName	path	True	string	Имя группы ресурсов Azure. Шаблон регулярного выражения: `^[-\w\._]+$`
subscriptionId	path	True	string	Возвращает учетные данные подписки, которые уникально идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента.
$filter	query		string	Фильтр, применяемый к операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
clientRequestId		string	Определяет этот конкретный клиентский запрос.

Ответы

Имя	Тип	Описание
200 OK	JobListResultV2	ОК
Other Status Codes	ErrorResponse	Ответ об ошибке автоматизации, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List jobs by automation account

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs?api-version=2023-11-01

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/job1",
      "name": "job1",
      "type": "Microsoft.Automation/AutomationAccounts/Jobs",
      "properties": {
        "jobId": "45203a94-a8cb-47c3-8ce4-4dcc3a5f7d23",
        "runbook": {
          "name": "TestRunbook"
        },
        "provisioningState": "Succeeded",
        "status": "New",
        "creationTime": "2017-03-30T05:53:30.243+00:00",
        "startTime": null,
        "lastModifiedTime": "2017-03-30T05:53:30.243+00:00",
        "endTime": null
      }
    },
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/job2",
      "name": "job2",
      "type": "Microsoft.Automation/AutomationAccounts/Jobs",
      "properties": {
        "jobId": "7584055f-5118-460a-a2dd-5176c9c8efe9",
        "runbook": {
          "name": "TestRunbook"
        },
        "provisioningState": "Succeeded",
        "status": "Completed",
        "creationTime": "2017-03-30T05:46:49.37+00:00",
        "startTime": "2017-03-30T05:47:35.2+00:00",
        "lastModifiedTime": "2017-03-30T05:48:38.857+00:00",
        "endTime": "2017-03-30T05:48:38.857+00:00"
      }
    }
  ],
  "nextLink": null
}

Определения

Имя	Описание
ErrorResponse	Ответ на ошибку при сбое операции
JobCollectionItem	Свойства элементов коллекции заданий.
JobListResultV2	Модель ответа для операции задания перечисления.
JobStatus	Возвращает или задает состояние задания.
RunbookAssociationProperty	Свойство runbook, связанное с сущностью.

ErrorResponse

Ответ на ошибку при сбое операции

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

JobCollectionItem

Свойства элементов коллекции заданий.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса
name	string	Имя ресурса.
properties.creationTime	string	Время создания задания.
properties.endTime	string	Время окончания задания.
properties.jobId	string	Идентификатор задания.
properties.lastModifiedTime	string	Время последнего изменения задания.
properties.provisioningState	string	Состояние подготовки ресурса.
properties.runOn	string	Указывает имя группы runOn, в которой выполнялось задание.
properties.runbook	RunbookAssociationProperty	Связь runbook.
properties.startTime	string	Время начала задания.
properties.status	JobStatus	Состояние задания.
type	string	Тип ресурса.

JobListResultV2

Модель ответа для операции задания перечисления.

Имя	Тип	Описание
nextLink	string	Ссылка на следующую страницу.
value	JobCollectionItem[]	Список заданий.

JobStatus

Возвращает или задает состояние задания.

Имя	Тип	Описание
Activating	string
Blocked	string
Completed	string
Disconnected	string
Failed	string
New	string
Removing	string
Resuming	string
Running	string
Stopped	string
Stopping	string
Suspended	string
Suspending	string

RunbookAssociationProperty

Свойство runbook, связанное с сущностью.

Имя	Тип	Описание
name	string	Возвращает или задает имя модуля Runbook.

Поделиться через