Share via


Microsoft.Sql servers/jobAgents/jobs/steps 2021-08-01-preview

Bicep 資源定義

servers/jobAgents/jobs/steps 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Sql/servers/jobAgents/jobs/steps 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Sql/servers/jobAgents/jobs/steps@2021-08-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    action: {
      source: 'Inline'
      type: 'TSql'
      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: 'SqlDatabase'
    }
    stepId: int
    targetGroup: 'string'
  }
}

屬性值

servers/jobAgents/jobs/steps

名稱 描述
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。
需要字串 ()
父系 (parent) 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增此屬性。

如需詳細資訊,請參閱 父資源外部的子資源
類型資源的符號名稱: 作業
properties 資源屬性。 JobStepProperties

JobStepProperties

名稱 描述
動作 作業步驟的動作承載。 JobStepAction (必要)
認證 (credential) 將用來連線到目標之作業認證的資源標識碼。 需要字串 ()
executionOptions 作業步驟的執行選項。 JobStepExecutionOptions
output 作業步驟的輸出目的地屬性。 JobStepOutput
stepId 作業步驟在作業內的索引。 如果未在建立作業步驟時指定,則會建立為最後一個步驟。 如果在更新作業步驟時未指定,則不會修改步驟標識符。 int
targetGroup 將執行作業步驟的目標組資源標識碼。 需要字串 ()

JobStepAction

名稱 描述
來源 要執行的動作來源。 'Inline'
類型 作業步驟所執行的動作類型。 'TSql'
動作值,例如要執行的 T-SQL 腳本文字。 需要字串 ()

JobStepExecutionOptions

名稱 描述
initialRetryIntervalSeconds 重試作業步驟執行之間的初始延遲。 int
maximumRetryIntervalSeconds 重試作業步驟執行之間等候的最大時間量。 int
retryAttempts 如果第一次嘗試失敗,將會重新嘗試作業步驟的次數上限。 int
retryIntervalBackoffMultiplier 重試之間時間的輪詢乘數。 int
timeoutSeconds 作業步驟的執行逾時。 int

JobStepOutput

名稱 描述
認證 (credential) 要用來連接到輸出目的地之認證的資源標識碼。 字串 (必要)
databaseName 輸出目的地資料庫。 字串 (必要)
resourceGroupName 輸出目的地資源群組。 字串
schemaName 輸出目的地架構。 字串
serverName 輸出目的地伺服器名稱。 字串 (必要)
subscriptionId 輸出目的地訂用帳戶標識碼。 字串

約束:
最小長度 = 36
最大長度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName 輸出目的地數據表。 字串 (必要)
類型 輸出目的地類型。 'SqlDatabase'

ARM 範本資源定義

伺服器/jobAgents/jobs/steps 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.Sql/servers/jobAgents/jobs/steps 資源,請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
  "apiVersion": "2021-08-01-preview",
  "name": "string",
  "properties": {
    "action": {
      "source": "Inline",
      "type": "TSql",
      "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": "SqlDatabase"
    },
    "stepId": "int",
    "targetGroup": "string"
  }
}

屬性值

servers/jobAgents/jobs/steps

名稱 描述
類型 資源類型 'Microsoft.Sql/servers/jobAgents/jobs/steps'
apiVersion 資源 API 版本 '2021-08-01-preview'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。
字串 (必要)
properties 資源屬性。 JobStepProperties

JobStepProperties

名稱 描述
動作 作業步驟的動作承載。 JobStepAction (必要)
認證 (credential) 將用來連線到目標之作業認證的資源標識碼。 字串 (必要)
executionOptions 作業步驟的執行選項。 JobStepExecutionOptions
output 作業步驟的輸出目的地屬性。 JobStepOutput
stepId 作業步驟在作業內的索引。 如果未在建立作業步驟時指定,則會建立為最後一個步驟。 如果未在更新作業步驟時指定,則不會修改步驟標識符。 int
targetGroup 將執行作業步驟的目標群組資源標識碼。 字串 (必要)

JobStepAction

名稱 描述
來源 要執行的動作來源。 'Inline'
類型 作業步驟所執行的動作類型。 'TSql'
動作值,例如要執行的 T-SQL 腳本文字。 字串 (必要)

JobStepExecutionOptions

名稱 描述
initialRetryIntervalSeconds 作業步驟執行重試之間的初始延遲。 int
maximumRetryIntervalSeconds 在重試作業步驟執行之間等候的時間上限。 int
retryAttempts 如果第一次嘗試失敗,將會重新嘗試作業步驟的次數上限。 int
retryIntervalBackoffMultiplier 重試時間的輪詢乘數。 int
timeoutSeconds 作業步驟的執行逾時。 int

JobStepOutput

名稱 描述
認證 (credential) 要用來連接到輸出目的地之認證的資源標識碼。 字串 (必要)
databaseName 輸出目的地資料庫。 字串 (必要)
resourceGroupName 輸出目的地資源群組。 字串
schemaName 輸出目的地架構。 字串
serverName 輸出目的地伺服器名稱。 字串 (必要)
subscriptionId 輸出目的地訂用帳戶標識碼。 字串

約束:
最小長度 = 36
最大長度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName 輸出目的地數據表。 字串 (必要)
類型 輸出目的地類型。 'SqlDatabase'

Terraform (AzAPI 提供者) 資源定義

伺服器/jobAgents/jobs/steps 資源類型可以使用目標作業來部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄

資源格式

若要建立 Microsoft.Sql/servers/jobAgents/jobs/steps 資源,請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/jobAgents/jobs/steps@2021-08-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      action = {
        source = "Inline"
        type = "TSql"
        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 = "SqlDatabase"
      }
      stepId = int
      targetGroup = "string"
    }
  })
}

屬性值

servers/jobAgents/jobs/steps

名稱 描述
類型 資源類型 “Microsoft.Sql/servers/jobAgents/jobs/steps@2021-08-01-preview”
NAME 資源名稱 字串 (必要)
parent_id 此資源之父系的資源標識碼。 類型資源的標識碼: 作業
properties 資源屬性。 JobStepProperties

JobStepProperties

名稱 描述
動作 作業步驟的動作承載。 JobStepAction (必要)
認證 (credential) 將用來連線到目標之作業認證的資源標識碼。 字串 (必要)
executionOptions 作業步驟的執行選項。 JobStepExecutionOptions
output 作業步驟的輸出目的地屬性。 JobStepOutput
stepId 作業步驟在作業內的索引。 如果未在建立作業步驟時指定,則會建立為最後一個步驟。 如果未在更新作業步驟時指定,則不會修改步驟標識符。 int
targetGroup 將執行作業步驟的目標群組資源標識碼。 字串 (必要)

JobStepAction

名稱 描述
來源 要執行的動作來源。 “內嵌”
類型 作業步驟所執行的動作類型。 “TSql”
動作值,例如要執行的 T-SQL 腳本文字。 需要字串 ()

JobStepExecutionOptions

名稱 描述
initialRetryIntervalSeconds 重試作業步驟執行之間的初始延遲。 int
maximumRetryIntervalSeconds 重試作業步驟執行之間等候的最大時間量。 int
retryAttempts 如果第一次嘗試失敗,將會重新嘗試作業步驟的次數上限。 int
retryIntervalBackoffMultiplier 重試之間時間的輪詢乘數。 int
timeoutSeconds 作業步驟的執行逾時。 int

JobStepOutput

名稱 描述
認證 (credential) 要用來連線至輸出目的地之認證的資源標識碼。 需要字串 ()
databaseName 輸出目的地資料庫。 需要字串 ()
resourceGroupName 輸出目的地資源群組。 字串
schemaName 輸出目的地架構。 字串
serverName 輸出目的地伺服器名稱。 需要字串 ()
subscriptionId 輸出目的地訂用帳戶標識碼。 字串

約束:
最小長度 = 36
最大長度 = 36
模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName 輸出目的地數據表。 需要字串 ()
類型 輸出目的地類型。 “SqlDatabase”