你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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-02-01-preview

URI 参数

Name In Required Type Description
jobAgentName
path True
  • string

作业代理的名称。

jobName
path True
  • string

作业的名称。

resourceGroupName
path True
  • string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

serverName
path True
  • string

服务器的名称。

stepName
path True
  • string

作业步骤的名称。

subscriptionId
path True
  • string

用于标识 Azure 订阅的订阅 ID。

api-version
query True
  • string

要用于请求的 API 版本。

请求正文

Name Required Type Description
properties.action True

作业步骤的操作有效负载。

properties.credential True
  • string

用于连接到目标的作业凭据的资源 ID。

properties.targetGroup True
  • string

将执行作业步骤的目标组的资源 ID。

properties.executionOptions

作业步骤的执行选项。

properties.output

作业步骤的输出目标属性。

properties.stepId
  • integer

作业步骤中的索引。 如果在创建作业步骤时未指定,则会将其创建为最后一步。 如果在更新作业步骤时未指定,则不会修改步骤 ID。

响应

Name Type Description
200 OK

已成功更新作业步骤。

201 Created

已成功添加作业步骤。

Other Status Codes

错误响应: ***

  • 400 JobStepIdMismatch - 指定作业步骤 URI 中的步骤 ID 与提供的作业步骤资源中的步骤 ID 不匹配。

  • 400 InvalidResourceRequestBody - 请求正文中的资源或资源属性为空或无效。

  • 400 InvalidResourceId - 资源标识符无效。

  • 400 不匹配SubscriptionWithUrl - 提供的订阅与 URL 中的订阅不匹配。

  • 400 不匹配ResourceGroupNameWithUrl - 提供的资源组名称与 URL 中的名称不匹配。

  • 400 不匹配ServerNameWithUrl - 提供的服务器名称与 URL 中的名称不匹配。

  • 400 不匹配JobAccountNameWithUrl - 提供的作业帐户名称与 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-02-01-preview

{
  "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-02-01-preview

{
  "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

资源 ID。

name
  • string

资源名称。

properties.action

作业步骤的操作有效负载。

properties.credential
  • string

用于连接到目标的作业凭据的资源 ID。

properties.executionOptions

作业步骤的执行选项。

properties.output

作业步骤的输出目标属性。

properties.stepId
  • integer

作业步骤中的索引。 如果在创建作业步骤时未指定,则会将其创建为最后一步。 如果在更新作业步骤时未指定,则不会修改步骤 ID。

properties.targetGroup
  • string

将执行作业步骤的目标组的资源 ID。

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

用于连接到输出目标的凭据的资源 ID。

databaseName
  • string

输出目标数据库。

resourceGroupName
  • string

输出目标资源组。

schemaName
  • string
dbo

输出目标架构。

serverName
  • string

输出目标服务器名称。

subscriptionId
  • string

输出目标订阅 ID。

tableName
  • string

输出目标表。

type SqlDatabase

输出目标类型。

JobStepOutputType

输出目标类型。

Name Type Description
SqlDatabase
  • string