Microsoft.Sql servers/jobAgents/jobs/steps 2022-11-01-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso servers/jobAgents/jobs/steps pode ser implantado com operações direcionadas:

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Sql/servers/jobAgents/jobs/steps, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Sql/servers/jobAgents/jobs/steps@2022-11-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'
  }
}

Valores de propriedade

servers/jobAgents/jobs/steps

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.		 cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte Recurso filho fora do recurso pai.		 Nome simbólico para o recurso do tipo: trabalhos
properties Propriedades do recurso. JobStepProperties

JobStepProperties

Nome Descrição Valor
ação O conteúdo da ação da etapa de trabalho. JobStepAction (obrigatório)
credencial A ID do recurso da credencial de trabalho que será usada para se conectar aos destinos. cadeia de caracteres (obrigatório)
executionOptions Opções de execução para a etapa de trabalho. JobStepExecutionOptions
output Propriedades de destino de saída da etapa de trabalho. JobStepOutput
stepId O índice da etapa de trabalho dentro do trabalho. Se não for especificado ao criar a etapa de trabalho, ele será criado como a última etapa. Se não for especificado ao atualizar a etapa de trabalho, a ID da etapa não será modificada. INT
targetGroup A ID do recurso do grupo de destino no qual a etapa de trabalho será executada. cadeia de caracteres (obrigatório)

JobStepAction

Nome Descrição Valor
source A origem da ação a ser executada. 'Embutido'
tipo Tipo de ação que está sendo executada pela etapa de trabalho. 'TSql'
value O valor da ação, por exemplo, o texto do script T-SQL a ser executado. cadeia de caracteres (obrigatório)

JobStepExecutionOptions

Nome Descrição Valor
initialRetryIntervalSeconds Atraso inicial entre novas tentativas para execução da etapa de trabalho. INT
maximumRetryIntervalSeconds A quantidade máxima de tempo de espera entre as novas tentativas para a execução da etapa de trabalho. INT
retryAttempts Número máximo de vezes que a etapa de trabalho será reattempted se a primeira tentativa falhar. INT
retryIntervalBackoffMultiplier O multiplicador de retirada para o tempo entre as repetições. INT
timeoutSeconds Tempo limite de execução para a etapa de trabalho. INT

JobStepOutput

Nome Descrição Valor
credencial A ID do recurso da credencial a ser usada para se conectar ao destino de saída. cadeia de caracteres (obrigatório)
databaseName O banco de dados de destino de saída. cadeia de caracteres (obrigatório)
resourceGroupName O grupo de recursos de destino de saída. string
schemaName O esquema de destino de saída. string
serverName O nome do servidor de destino de saída. cadeia de caracteres (obrigatório)
subscriptionId A ID da assinatura de destino de saída. string

Restrições:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName A tabela de destino de saída. cadeia de caracteres (obrigatório)
tipo O tipo de destino de saída. 'SqlDatabase'

Definição de recurso de modelo do ARM

O tipo de recurso servers/jobAgents/jobs/steps pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Sql/servers/jobAgents/jobs/steps, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
  "apiVersion": "2022-11-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"
  }
}

Valores de propriedade

servers/jobAgents/jobs/steps

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.Sql/servers/jobAgents/jobs/steps'
apiVersion A versão da API de recursos '2022-11-01-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 cadeia de caracteres (obrigatório)
properties Propriedades do recurso. JobStepProperties

JobStepProperties

Nome Descrição Valor
ação O conteúdo da ação da etapa de trabalho. JobStepAction (obrigatório)
credencial A ID do recurso da credencial de trabalho que será usada para se conectar aos destinos. cadeia de caracteres (obrigatório)
executionOptions Opções de execução para a etapa de trabalho. JobStepExecutionOptions
output Propriedades de destino de saída da etapa de trabalho. JobStepOutput
stepId O índice da etapa de trabalho dentro do trabalho. Se não for especificado ao criar a etapa de trabalho, ela será criada como a última etapa. Se não for especificado ao atualizar a etapa de trabalho, a ID da etapa não será modificada. INT
targetGroup A ID do recurso do grupo de destino no qual a etapa de trabalho será executada. cadeia de caracteres (obrigatório)

JobStepAction

Nome Descrição Valor
source A origem da ação a ser executada. 'Embutido'
tipo Tipo de ação que está sendo executada pela etapa de trabalho. 'TSql'
value O valor da ação, por exemplo, o texto do script T-SQL a ser executado. cadeia de caracteres (obrigatório)

JobStepExecutionOptions

Nome Descrição Valor
initialRetryIntervalSeconds Atraso inicial entre repetições para execução da etapa de trabalho. INT
maximumRetryIntervalSeconds A quantidade máxima de tempo para aguardar entre as tentativas para a execução da etapa de trabalho. INT
retryAttempts Número máximo de vezes que a etapa de trabalho será reattempted se a primeira tentativa falhar. INT
retryIntervalBackoffMultiplier O multiplicador de retirada para o tempo entre repetições. INT
timeoutSeconds Tempo limite de execução para a etapa de trabalho. INT

JobStepOutput

Nome Descrição Valor
credencial A ID do recurso da credencial a ser usada para se conectar ao destino de saída. cadeia de caracteres (obrigatório)
databaseName O banco de dados de destino de saída. cadeia de caracteres (obrigatório)
resourceGroupName O grupo de recursos de destino de saída. string
schemaName O esquema de destino de saída. string
serverName O nome do servidor de destino de saída. cadeia de caracteres (obrigatório)
subscriptionId A ID da assinatura de destino de saída. string

Restrições:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName A tabela de destino de saída. cadeia de caracteres (obrigatório)
tipo O tipo de destino de saída. 'SqlDatabase'

Definição de recurso do Terraform (provedor AzAPI)

O tipo de recurso servers/jobAgents/jobs/steps pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Sql/servers/jobAgents/jobs/steps, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/jobAgents/jobs/steps@2022-11-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"
    }
  })
}

Valores de propriedade

servers/jobAgents/jobs/steps

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Sql/servers/jobAgents/jobs/steps@2022-11-01-preview"
name O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: trabalhos
properties Propriedades do recurso. JobStepProperties

JobStepProperties

Nome Descrição Valor
ação O conteúdo da ação da etapa de trabalho. JobStepAction (obrigatório)
credencial A ID do recurso da credencial de trabalho que será usada para se conectar aos destinos. cadeia de caracteres (obrigatório)
executionOptions Opções de execução para a etapa de trabalho. JobStepExecutionOptions
output Propriedades de destino de saída da etapa de trabalho. JobStepOutput
stepId O índice da etapa de trabalho dentro do trabalho. Se não for especificado ao criar a etapa de trabalho, ela será criada como a última etapa. Se não for especificado ao atualizar a etapa de trabalho, a ID da etapa não será modificada. INT
targetGroup A ID do recurso do grupo de destino no qual a etapa de trabalho será executada. cadeia de caracteres (obrigatório)

JobStepAction

Nome Descrição Valor
source A origem da ação a ser executada. "Embutido"
tipo Tipo de ação que está sendo executada pela etapa de trabalho. "TSql"
value O valor da ação, por exemplo, o texto do script T-SQL a ser executado. cadeia de caracteres (obrigatório)

JobStepExecutionOptions

Nome Descrição Valor
initialRetryIntervalSeconds Atraso inicial entre repetições para execução da etapa de trabalho. INT
maximumRetryIntervalSeconds A quantidade máxima de tempo para aguardar entre as tentativas para a execução da etapa de trabalho. INT
retryAttempts Número máximo de vezes que a etapa de trabalho será reattempted se a primeira tentativa falhar. INT
retryIntervalBackoffMultiplier O multiplicador de retirada para o tempo entre repetições. INT
timeoutSeconds Tempo limite de execução para a etapa de trabalho. INT

JobStepOutput

Nome Descrição Valor
credencial A ID do recurso da credencial a ser usada para se conectar ao destino de saída. cadeia de caracteres (obrigatório)
databaseName O banco de dados de destino de saída. cadeia de caracteres (obrigatório)
resourceGroupName O grupo de recursos de destino de saída. string
schemaName O esquema de destino de saída. string
serverName O nome do servidor de destino de saída. cadeia de caracteres (obrigatório)
subscriptionId A ID da assinatura de destino de saída. string

Restrições:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
tableName A tabela de destino de saída. cadeia de caracteres (obrigatório)
tipo O tipo de destino de saída. "SqlDatabase"