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

Microsoft.Sql servers/jobAgents/jobs/steps 2023-02-01-preview

Bicep 资源定义

可以使用目标操作部署 servers/jobAgents/jobs/steps 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Sql/servers/jobAgents/jobs/steps 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Sql/servers/jobAgents/jobs/steps@2023-02-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    action: {
      source: 'string'
      type: 'string'
      value: 'string'
    }
    credential: 'string'
    executionOptions: {
      initialRetryIntervalSeconds: int
      maximumRetryIntervalSeconds: int
      retryAttempts: int
      retryIntervalBackoffMultiplier: int
      timeoutSeconds: int
    }
    output: {
      credential: 'string'
      databaseName: 'string'
      resourceGroupName: 'string'
      schemaName: 'string'
      serverName: 'string'
      subscriptionId: 'string'
      tableName: 'string'
      type: 'string'
    }
    stepId: int
    targetGroup: 'string'
  }
}

属性值

JobStepAction

名字 描述 价值
要执行的操作的源。 “内联”
类型 作业步骤正在执行的操作的类型。 “TSql”
价值 操作值,例如要执行的 T-SQL 脚本的文本。 string (必需)

JobStepExecutionOptions

名字 描述 价值
initialRetryIntervalSeconds 重试作业步骤执行之间的初始延迟。 int
maximumRetryIntervalSeconds 重试作业步骤执行之间的最长等待时间。 int
retryAttempts 如果第一次尝试失败,作业步骤将重新尝试的最大次数。 int
retryIntervalBackoffMultiplier 重试之间的时间回退乘数。 int
timeoutSeconds 作业步骤的执行超时。 int

JobStepOutput

名字 描述 价值
凭据 用于连接到输出目标的凭据的资源 ID。 string (必需)
databaseName 输出目标数据库。 string (必需)
resourceGroupName 输出目标资源组。 字符串
schemaName 输出目标架构。 字符串
serverName 输出目标服务器名称。 string (必需)
subscriptionId 输出目标订阅 ID。 字符串

约束:
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName 输出目标表。 string (必需)
类型 输出目标类型。 “SqlDatabase”

JobStepProperties

名字 描述 价值
行动 作业步骤的操作有效负载。 JobStepAction (必需)
凭据 将用于连接到目标的作业凭据的资源 ID。 string (必需)
executionOptions 作业步骤的执行选项。 JobStepExecutionOptions
输出 作业步骤的输出目标属性。 JobStepOutput
stepId 作业中的作业步骤的索引。 如果在创建作业步骤时未指定,则会将其创建为最后一步。 如果在更新作业步骤时未指定,则不会修改步骤 ID。 int
targetGroup 将执行作业步骤的目标组的资源 ID。 string (必需)

Microsoft.Sql/servers/jobAgents/jobs/steps

名字 描述 价值
名字 资源名称 string (必需)
父母 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:servers/jobAgents/jobs
性能 资源属性。 JobStepProperties

ARM 模板资源定义

可以使用目标操作部署 servers/jobAgents/jobs/steps 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Sql/servers/jobAgents/jobs/steps 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
  "apiVersion": "2023-02-01-preview",
  "name": "string",
  "properties": {
    "action": {
      "source": "string",
      "type": "string",
      "value": "string"
    },
    "credential": "string",
    "executionOptions": {
      "initialRetryIntervalSeconds": "int",
      "maximumRetryIntervalSeconds": "int",
      "retryAttempts": "int",
      "retryIntervalBackoffMultiplier": "int",
      "timeoutSeconds": "int"
    },
    "output": {
      "credential": "string",
      "databaseName": "string",
      "resourceGroupName": "string",
      "schemaName": "string",
      "serverName": "string",
      "subscriptionId": "string",
      "tableName": "string",
      "type": "string"
    },
    "stepId": "int",
    "targetGroup": "string"
  }
}

属性值

JobStepAction

名字 描述 价值
要执行的操作的源。 “内联”
类型 作业步骤正在执行的操作的类型。 “TSql”
价值 操作值,例如要执行的 T-SQL 脚本的文本。 string (必需)

JobStepExecutionOptions

名字 描述 价值
initialRetryIntervalSeconds 重试作业步骤执行之间的初始延迟。 int
maximumRetryIntervalSeconds 重试作业步骤执行之间的最长等待时间。 int
retryAttempts 如果第一次尝试失败,作业步骤将重新尝试的最大次数。 int
retryIntervalBackoffMultiplier 重试之间的时间回退乘数。 int
timeoutSeconds 作业步骤的执行超时。 int

JobStepOutput

名字 描述 价值
凭据 用于连接到输出目标的凭据的资源 ID。 string (必需)
databaseName 输出目标数据库。 string (必需)
resourceGroupName 输出目标资源组。 字符串
schemaName 输出目标架构。 字符串
serverName 输出目标服务器名称。 string (必需)
subscriptionId 输出目标订阅 ID。 字符串

约束:
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName 输出目标表。 string (必需)
类型 输出目标类型。 “SqlDatabase”

JobStepProperties

名字 描述 价值
行动 作业步骤的操作有效负载。 JobStepAction (必需)
凭据 将用于连接到目标的作业凭据的资源 ID。 string (必需)
executionOptions 作业步骤的执行选项。 JobStepExecutionOptions
输出 作业步骤的输出目标属性。 JobStepOutput
stepId 作业中的作业步骤的索引。 如果在创建作业步骤时未指定,则会将其创建为最后一步。 如果在更新作业步骤时未指定,则不会修改步骤 ID。 int
targetGroup 将执行作业步骤的目标组的资源 ID。 string (必需)

Microsoft.Sql/servers/jobAgents/jobs/steps

名字 描述 价值
apiVersion API 版本 '2023-02-01-preview'
名字 资源名称 string (必需)
性能 资源属性。 JobStepProperties
类型 资源类型 “Microsoft.Sql/servers/jobAgents/jobs/steps”

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署 servers/jobAgents/jobs/steps 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Sql/servers/jobAgents/jobs/steps 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/jobAgents/jobs/steps@2023-02-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      action = {
        source = "string"
        type = "string"
        value = "string"
      }
      credential = "string"
      executionOptions = {
        initialRetryIntervalSeconds = int
        maximumRetryIntervalSeconds = int
        retryAttempts = int
        retryIntervalBackoffMultiplier = int
        timeoutSeconds = int
      }
      output = {
        credential = "string"
        databaseName = "string"
        resourceGroupName = "string"
        schemaName = "string"
        serverName = "string"
        subscriptionId = "string"
        tableName = "string"
        type = "string"
      }
      stepId = int
      targetGroup = "string"
    }
  })
}

属性值

JobStepAction

名字 描述 价值
要执行的操作的源。 “内联”
类型 作业步骤正在执行的操作的类型。 “TSql”
价值 操作值,例如要执行的 T-SQL 脚本的文本。 string (必需)

JobStepExecutionOptions

名字 描述 价值
initialRetryIntervalSeconds 重试作业步骤执行之间的初始延迟。 int
maximumRetryIntervalSeconds 重试作业步骤执行之间的最长等待时间。 int
retryAttempts 如果第一次尝试失败,作业步骤将重新尝试的最大次数。 int
retryIntervalBackoffMultiplier 重试之间的时间回退乘数。 int
timeoutSeconds 作业步骤的执行超时。 int

JobStepOutput

名字 描述 价值
凭据 用于连接到输出目标的凭据的资源 ID。 string (必需)
databaseName 输出目标数据库。 string (必需)
resourceGroupName 输出目标资源组。 字符串
schemaName 输出目标架构。 字符串
serverName 输出目标服务器名称。 string (必需)
subscriptionId 输出目标订阅 ID。 字符串

约束:
最小长度 = 36
最大长度 = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName 输出目标表。 string (必需)
类型 输出目标类型。 “SqlDatabase”

JobStepProperties

名字 描述 价值
行动 作业步骤的操作有效负载。 JobStepAction (必需)
凭据 将用于连接到目标的作业凭据的资源 ID。 string (必需)
executionOptions 作业步骤的执行选项。 JobStepExecutionOptions
输出 作业步骤的输出目标属性。 JobStepOutput
stepId 作业中的作业步骤的索引。 如果在创建作业步骤时未指定,则会将其创建为最后一步。 如果在更新作业步骤时未指定,则不会修改步骤 ID。 int
targetGroup 将执行作业步骤的目标组的资源 ID。 string (必需)

Microsoft.Sql/servers/jobAgents/jobs/steps

名字 描述 价值
名字 资源名称 string (必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:servers/jobAgents/jobs
性能 资源属性。 JobStepProperties
类型 资源类型 “Microsoft.Sql/servers/jobAgents/jobs/steps@2023-02-01-preview”