Job Steps - Create Or Update

  • Referência
Service:
SQL Database
API Version:
2021-11-01

Cria ou atualiza uma etapa de trabalho. Isso criará implicitamente uma nova versão do trabalho.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
jobAgentName
 path True

string

O nome do agente de trabalho.
jobName
 path True

string

O nome do trabalho.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName
 path True

string

O nome do servidor.
stepName
 path True

string

O nome da etapa de trabalho.
subscriptionId
 path True

string

A ID de assinatura que identifica uma assinatura do Azure.
api-version
 query True

string

A versão da API a ser usada para a solicitação.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.action True

JobStepAction

O conteúdo da ação da etapa de trabalho.
properties.credential True

string

A ID do recurso da credencial de trabalho que será usada para se conectar aos destinos.
properties.targetGroup True

string

A ID do recurso do grupo de destino no qual a etapa de trabalho será executada.
properties.executionOptions

JobStepExecutionOptions

Opções de execução para a etapa de trabalho.
properties.output

JobStepOutput

Propriedades de destino de saída da etapa de trabalho.
properties.stepId

integer

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.

Respostas

Nome Tipo Description
200 OK

JobStep

A etapa de trabalho foi atualizada com êxito.
201 Created

JobStep

A etapa de trabalho foi adicionada com êxito.
Other Status Codes

Respostas de erro: ***

  • 400 JobStepIdMismatch – A ID da etapa no URI da Etapa de Trabalho especificada não corresponde à ID da etapa no Recurso da Etapa de Trabalho fornecido.

  • 400 InvalidResourceRequestBody - O recurso ou as propriedades do recurso no corpo da solicitação são vazios ou inválidos.

  • 400 InvalidResourceId – Identificador de recurso inválido.

  • 400 MismatchingSubscriptionWithUrl – A assinatura fornecida não correspondeu à assinatura na URL.

  • 400 MismatchingResourceGroupNameWithUrl - O nome do grupo de recursos fornecido não correspondeu ao nome na URL.

  • 400 MismatchingServerNameWithUrl – O nome do servidor fornecido não correspondeu ao nome na URL.

  • 400 MismatchingJobAccountNameWithUrl – O nome da conta de trabalho fornecido não correspondeu ao nome na URL.

  • 400 ElasticJobsOperationFailed – Falha na operação de gerenciamento de trabalhos elásticos.

  • 400 ElasticJobsOperationFailed – Falha na operação de gerenciamento de trabalhos elásticos.

  • 404 JobAgentNotFound – O agente de trabalho especificado não existe no servidor lógico especificado.

  • 404 ResourceNotFound – O recurso solicitado não foi encontrado.

  • 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado

  • 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados.

Exemplos

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

Sample Response

Status code:
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"
}
Status code:
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.

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

Sample Response

Status code:
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"
}
Status code:
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"
}

Definições

Nome Description
JobStep

Uma etapa de trabalho.
JobStepAction

A ação a ser executada por uma etapa de trabalho.
JobStepActionSource

A origem da ação a ser executada.
JobStepActionType

Tipo de ação que está sendo executada pela etapa de trabalho.
JobStepExecutionOptions

As opções de execução de uma etapa de trabalho.
JobStepOutput

A configuração de saída de uma etapa de trabalho.
JobStepOutputType

O tipo de destino de saída.

JobStep

Uma etapa de trabalho.

Nome Tipo Description
id

string

ID do recurso.
name

string

Nome do recurso.
properties.action

JobStepAction

O conteúdo da ação da etapa de trabalho.
properties.credential

string

A ID do recurso da credencial de trabalho que será usada para se conectar aos destinos.
properties.executionOptions

JobStepExecutionOptions

Opções de execução para a etapa de trabalho.
properties.output

JobStepOutput

Propriedades de destino de saída da etapa de trabalho.
properties.stepId

integer

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.
properties.targetGroup

string

A ID do recurso do grupo de destino no qual a etapa de trabalho será executada.
type

string

Tipo de recurso.

JobStepAction

A ação a ser executada por uma etapa de trabalho.

Nome Tipo Valor padrão Description
source

JobStepActionSource

Inline

A origem da ação a ser executada.
type

JobStepActionType

TSql

Tipo de ação que está sendo executada pela etapa de trabalho.
value

string

O valor da ação, por exemplo, o texto do script T-SQL a ser executado.

JobStepActionSource

A origem da ação a ser executada.

Nome Tipo Description
Inline

string

JobStepActionType

Tipo de ação que está sendo executada pela etapa de trabalho.

Nome Tipo Description
TSql

string

JobStepExecutionOptions

As opções de execução de uma etapa de trabalho.

Nome Tipo Valor padrão Description
initialRetryIntervalSeconds

integer

1

Atraso inicial entre repetições para execução da etapa de trabalho.
maximumRetryIntervalSeconds

integer

120

A quantidade máxima de tempo para aguardar entre as tentativas para a execução da etapa de trabalho.
retryAttempts

integer

10

Número máximo de vezes que a etapa de trabalho será reattempted se a primeira tentativa falhar.
retryIntervalBackoffMultiplier

number

2

O multiplicador de retirada para o tempo entre repetições.
timeoutSeconds

integer

43200

Tempo limite de execução para a etapa de trabalho.

JobStepOutput

A configuração de saída de uma etapa de trabalho.

Nome Tipo Valor padrão Description
credential

string

A ID do recurso da credencial a ser usada para se conectar ao destino de saída.
databaseName

string

O banco de dados de destino de saída.
resourceGroupName

string

O grupo de recursos de destino de saída.
schemaName

string

dbo

O esquema de destino de saída.
serverName

string

O nome do servidor de destino de saída.
subscriptionId

string

A ID da assinatura de destino de saída.
tableName

string

A tabela de destino de saída.
type

JobStepOutputType

SqlDatabase

O tipo de destino de saída.

JobStepOutputType

O tipo de destino de saída.

Nome Tipo Description
SqlDatabase

string