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

Name In Required Type Description
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 для использования в запросе.

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

Name Required Type Description
properties.action True

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

properties.credential True
  • string

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

properties.targetGroup True
  • string

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

properties.executionOptions

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

properties.output

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

properties.stepId
  • integer

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

Ответы

Name Type Description
200 OK

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

201 Created

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

Other Status Codes

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

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

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

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

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

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

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

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

  • 400 ElasticJobsOperationFailed — не удалось выполнить операцию управления заданиями elastic.

  • 400 ElasticJobsOperationFailed — не удалось выполнить операцию управления заданиями elastic.

  • 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

Шаг задания.

Name Type Description
id
  • string

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

name
  • string

Имя ресурса.

properties.action

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

properties.credential
  • string

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

properties.executionOptions

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

properties.output

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

properties.stepId
  • integer

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

properties.targetGroup
  • string

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

type
  • string

Тип ресурса.

JobStepAction

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

Name Type Default Value Description
source Inline

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

type TSql

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

value
  • string

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

JobStepActionSource

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

Name Type Description
Inline
  • string

JobStepActionType

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

Name Type Description
TSql
  • string

JobStepExecutionOptions

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

Name Type Default Value Description
initialRetryIntervalSeconds
  • integer
1

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

maximumRetryIntervalSeconds
  • integer
120

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

retryAttempts
  • integer
10

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

retryIntervalBackoffMultiplier
  • number
2

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

timeoutSeconds
  • integer
43200

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

JobStepOutput

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

Name Type Default Value Description
credential
  • string

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

databaseName
  • string

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

resourceGroupName
  • string

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

schemaName
  • string
dbo

Схема назначения выходных данных.

serverName
  • string

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

subscriptionId
  • string

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

tableName
  • string

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

type SqlDatabase

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

JobStepOutputType

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

Name Type Description
SqlDatabase
  • string