Job Steps - Create Or Update

Создает или обновляет шаг задания. Это неявно создаст новую версию задания.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}?api-version=2021-11-01

Параметры URI

Имя В Обязательно Тип Описание
jobAgentName
path True

string

Имя агента задания.

jobName
path True

string

Имя задания.

resourceGroupName
path True

string

Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.

serverName
path True

string

Имя сервера.

stepName
path True

string

Имя шага задания.

subscriptionId
path True

string

Идентификатор подписки Azure.

api-version
query True

string

Версия API для использования в запросе.

Текст запроса

Имя Обязательно Тип Описание
properties.action True

JobStepAction

Полезные данные действия шага задания.

properties.credential True

string

Идентификатор ресурса учетных данных задания, которые будут использоваться для подключения к целевым объектам.

properties.targetGroup True

string

Идентификатор ресурса целевой группы, в которую будет выполняться шаг задания.

properties.executionOptions

JobStepExecutionOptions

Параметры выполнения для шага задания.

properties.output

JobStepOutput

Выходные свойства назначения шага задания.

properties.stepId

integer

Индекс шага задания в задании. Если при создании шага задания не указано, он будет создан как последний шаг. Если при обновлении шага задания не указано, идентификатор шага не изменяется.

Ответы

Имя Тип Описание
200 OK

JobStep

Шаг задания успешно обновлен.

201 Created

JobStep

Шаг задания успешно добавлен.

Other Status Codes

Ответы на ошибки: ***

  • 400 JobStepIdMismatch — идентификатор шага в указанном URI шага задания не соответствует идентификатору шага в предоставленном ресурсе шага задания.

  • 400 InvalidResourceRequestBody — свойства ресурса или ресурса в тексте запроса пусты или недопустимы.

  • 400 InvalidResourceId — недопустимый идентификатор ресурса.

  • 400 MismatchingSubscriptionWithUrl — указанная подписка не соответствует подписке в URL-адресе.

  • 400 MismatchingResourceGroupNameWithUrl — предоставленное имя группы ресурсов не совпадает с именем в URL-адресе.

  • 400 MismatchingServerNameWithUrl — предоставленное имя сервера не совпадает с именем в URL-адресе.

  • 400 MismatchingJobAccountNameWithUrl — имя предоставленной учетной записи задания не совпадает с именем в URL-адресе.

  • 400 ElasticJobsOperationFailed — сбой операции управления заданиями обработки эластичных баз данных.

  • 400 ElasticJobsOperationFailed — сбой операции управления заданиями обработки эластичных баз данных.

  • 404 JobAgentNotFound — указанный агент задания не существует на указанном логическом сервере.

  • 404 ResourceNotFound — запрошенный ресурс не найден.

  • 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден

  • 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.

Примеры

Create or update a job step with all properties specified.
Create or update a job step with minimal properties specified.

Create or update a job step with all properties specified.

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1?api-version=2021-11-01

{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "output": {
      "type": "SqlDatabase",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "resourceGroupName": "group3",
      "serverName": "server3",
      "databaseName": "database3",
      "schemaName": "myschema1234",
      "tableName": "mytable5678",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"
    },
    "executionOptions": {
      "timeoutSeconds": 1234,
      "retryAttempts": 42,
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryIntervalBackoffMultiplier": 3
    }
  }
}

Sample Response

{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "output": {
      "type": "SqlDatabase",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "resourceGroupName": "group3",
      "serverName": "server3",
      "databaseName": "database3",
      "schemaName": "myschema1234",
      "tableName": "mytable5678",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"
    },
    "executionOptions": {
      "timeoutSeconds": 1234,
      "retryAttempts": 42,
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryIntervalBackoffMultiplier": 3
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}
{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "output": {
      "type": "SqlDatabase",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "resourceGroupName": "group3",
      "serverName": "server3",
      "databaseName": "database3",
      "schemaName": "myschema1234",
      "tableName": "mytable5678",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"
    },
    "executionOptions": {
      "timeoutSeconds": 1234,
      "retryAttempts": 42,
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryIntervalBackoffMultiplier": 3
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}

Create or update a job step with minimal properties specified.

Sample Request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1?api-version=2021-11-01

{
  "properties": {
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "value": "select 1"
    }
  }
}

Sample Response

{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}
{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}

Определения

Имя Описание
JobStep

Шаг задания.

JobStepAction

Действие, выполняемое на шаге задания.

JobStepActionSource

Источник выполняемого действия.

JobStepActionType

Тип действия, выполняемого на шаге задания.

JobStepExecutionOptions

Параметры выполнения шага задания.

JobStepOutput

Конфигурация выходных данных шага задания.

JobStepOutputType

Тип назначения выходных данных.

JobStep

Шаг задания.

Имя Тип Описание
id

string

Идентификатор ресурса.

name

string

Имя ресурса.

properties.action

JobStepAction

Полезные данные действия шага задания.

properties.credential

string

Идентификатор ресурса учетных данных задания, которые будут использоваться для подключения к целевым объектам.

properties.executionOptions

JobStepExecutionOptions

Параметры выполнения для шага задания.

properties.output

JobStepOutput

Выходные свойства назначения шага задания.

properties.stepId

integer

Индекс шага задания в задании. Если при создании шага задания не указано, он будет создан как последний шаг. Если при обновлении шага задания не указано, идентификатор шага не изменяется.

properties.targetGroup

string

Идентификатор ресурса целевой группы, в которую будет выполняться шаг задания.

type

string

Тип ресурса.

JobStepAction

Действие, выполняемое на шаге задания.

Имя Тип Значение по умолчанию Описание
source

JobStepActionSource

Inline

Источник выполняемого действия.

type

JobStepActionType

TSql

Тип действия, выполняемого на шаге задания.

value

string

Значение действия, например текст выполняемого скрипта T-SQL.

JobStepActionSource

Источник выполняемого действия.

Имя Тип Описание
Inline

string

JobStepActionType

Тип действия, выполняемого на шаге задания.

Имя Тип Описание
TSql

string

JobStepExecutionOptions

Параметры выполнения шага задания.

Имя Тип Значение по умолчанию Описание
initialRetryIntervalSeconds

integer

1

Начальная задержка между повторными попытками для выполнения шага задания.

maximumRetryIntervalSeconds

integer

120

Максимальное время ожидания между повторными попытками выполнения шага задания.

retryAttempts

integer

10

Максимальное число повторных попыток выполнения шага задания в случае сбоя первой попытки.

retryIntervalBackoffMultiplier

number

2

Множитель задержки для времени между повторными попытками.

timeoutSeconds

integer

43200

Время ожидания выполнения для шага задания.

JobStepOutput

Конфигурация выходных данных шага задания.

Имя Тип Значение по умолчанию Описание
credential

string

Идентификатор ресурса учетных данных, используемых для подключения к назначению вывода.

databaseName

string

Выходная целевая база данных.

resourceGroupName

string

Выходная целевая группа ресурсов.

schemaName

string

dbo

Выходная схема назначения.

serverName

string

Имя выходного целевого сервера.

subscriptionId

string

Идентификатор конечной подписки выходных данных.

tableName

string

Выходная целевая таблица.

type

JobStepOutputType

SqlDatabase

Тип назначения выходных данных.

JobStepOutputType

Тип назначения выходных данных.

Имя Тип Описание
SqlDatabase

string