Partilhar via

Job Steps - Get By Version

  • Referência
Serviço:
SQL Database
Versão da API:
2021-11-01

Obtém a versão especificada de um passo de tarefa.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions/{jobVersion}/steps/{stepName}?api-version=2021-11-01

Parâmetros do URI

Name Em Necessário Tipo Description
jobAgentName
 path True

string

O nome do agente de tarefas.
jobName
 path True

string

O nome da tarefa.
jobVersion
 path True

integer

int32

A versão da tarefa a obter.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName
 path True

string

O nome do servidor.
stepName
 path True

string

O nome do passo da tarefa.
subscriptionId
 path True

string

O ID da subscrição que identifica uma subscrição do Azure.
api-version
 query True

string

A versão da API a utilizar para o pedido.

Respostas

Name Tipo Description
200 OK

JobStep

O passo da tarefa foi obtido com êxito.
Other Status Codes

Respostas de Erro: ***

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

  • 404 ResourceNotFound – o recurso pedido não foi encontrado.

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

  • 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na subscrição especificados.

Exemplos

Get the specified version of a job step.

Pedido de amostra

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/versions/1/steps/step1?api-version=2021-11-01

Resposta da amostra

Código de estado:
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/versions/1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/versions/steps"
}

Definições

Name Description
JobStep

Um passo de trabalho.
JobStepAction

A ação a ser executada por um passo de trabalho.
JobStepActionSource

A origem da ação a executar.
JobStepActionType

Tipo de ação a ser executada pelo passo da tarefa.
JobStepExecutionOptions

As opções de execução de um passo de tarefa.
JobStepOutput

A configuração de saída de um passo de tarefa.
JobStepOutputType

O tipo de destino de saída.

JobStep

Object

Um passo de trabalho.

Name Tipo Description
id

string

ID do Recurso.
name

string

Nome do recurso.
properties.action

JobStepAction

O payload de ação do passo da tarefa.
properties.credential

string

O ID de recurso da credencial da tarefa que será utilizada para ligar aos destinos.
properties.executionOptions

JobStepExecutionOptions

Opções de execução para o passo da tarefa.
properties.output

JobStepOutput

Propriedades de destino de saída do passo da tarefa.
properties.stepId

integer

O índice do passo da tarefa dentro da tarefa. Se não for especificado ao criar o passo da tarefa, será criado como o último passo. Se não for especificado ao atualizar o passo da tarefa, o ID do passo não é modificado.
properties.targetGroup

string

O ID de recurso do grupo de destino no qual o passo da tarefa será executado.
type

string

Tipo de recurso.

JobStepAction

Object

A ação a ser executada por um passo de trabalho.

Name Tipo Default value Description
source

JobStepActionSource

Inline

A origem da ação a executar.
type

JobStepActionType

TSql

Tipo de ação a ser executada pelo passo da tarefa.
value

string

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

JobStepActionSource

Enumeration

A origem da ação a executar.

Valor Description
Inline

JobStepActionType

Enumeration

Tipo de ação a ser executada pelo passo da tarefa.

Valor Description
TSql

JobStepExecutionOptions

Object

As opções de execução de um passo de tarefa.

Name Tipo Default value Description
initialRetryIntervalSeconds

integer

1

Atraso inicial entre as repetições para a execução do passo da tarefa.
maximumRetryIntervalSeconds

integer

120

A quantidade máxima de tempo a aguardar entre repetições para a execução do passo da tarefa.
retryAttempts

integer

10

Número máximo de vezes que o passo da tarefa será novamente tentado se a primeira tentativa falhar.
retryIntervalBackoffMultiplier

number

2

O multiplicador de trás para o tempo entre repetições.
timeoutSeconds

integer

43200

Tempo limite de execução para o passo da tarefa.

JobStepOutput

Object

A configuração de saída de um passo de tarefa.

Name Tipo Default value Description
credential

string

O ID de recurso da credencial a utilizar para ligar ao destino de saída.
databaseName

string

A base 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

O ID da subscrição 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

Enumeration

O tipo de destino de saída.

Valor Description
SqlDatabase