通过

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

Job Steps - Create Or Update

  • 参考
服务:
SQL Database
API 版本:
2021-11-01

创建或更新作业步骤。 这将隐式创建新的作业版本。

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

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

string

服务器的名称。
stepName
 path True

string

作业步骤的名称。
subscriptionId
 path True

string

用于标识 Azure 订阅的订阅 ID。
api-version
 query True

string

要用于请求的 API 版本。

请求正文

名称 必需 类型 说明
properties.action True

JobStepAction

作业步骤的操作有效负载。
properties.credential True

string

将用于连接到目标的作业凭据的资源 ID。
properties.targetGroup True

string

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

JobStepExecutionOptions

作业步骤的执行选项。
properties.output

JobStepOutput

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

integer

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

响应

名称 类型 说明
200 OK

JobStep

已成功更新作业步骤。
201 Created

JobStep

已成功添加作业步骤。
Other Status Codes

错误响应： ***

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

  • 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.

示例请求

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
    }
  }
}

示例响应

状态代码:
200 
{
  "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"
}
状态代码:
201 
{
  "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.

示例请求

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

示例响应

状态代码:
200 
{
  "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"
}
状态代码:
201 
{
  "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

资源 ID。
name

string

资源名称。
properties.action

JobStepAction

作业步骤的操作有效负载。
properties.credential

string

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

JobStepExecutionOptions

作业步骤的执行选项。
properties.output

JobStepOutput

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

integer

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

string

将执行作业步骤的目标组的资源 ID。
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

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

string

输出目标数据库。
resourceGroupName

string

输出目标资源组。
schemaName

string

dbo

输出目标架构。
serverName

string

输出目标服务器名称。
subscriptionId

string

输出目标订阅 ID。
tableName

string

输出目标表。
type

JobStepOutputType

SqlDatabase

输出目标类型。

JobStepOutputType

输出目标类型。

名称 类型 说明
SqlDatabase

string