Compartir a través de

Job Steps - Get

  • Referencia
Servicio:
SQL Database
Versión de la API:
2023-08-01

Obtiene un paso de trabajo en la versión actual de un trabajo.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
jobAgentName
 path True

string

Nombre del agente de trabajo.
jobName
 path True

string

Nombre del trabajo.
resourceGroupName
 path True

string

Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serverName
 path True

string

Nombre del servidor.
stepName
 path True

string

Nombre del paso de trabajo.
subscriptionId
 path True

string

Identificador de suscripción que identifica una suscripción de Azure.
api-version
 query True

string

Versión de la API que se va a usar para la solicitud.

Respuestas

Nombre Tipo Description
200 OK

JobStep

Recuperó correctamente el paso de trabajo.
Other Status Codes

ErrorResponse

Respuestas de error: ***

  • 400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención

  • 400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio

  • 404 JobAgentNotFound: el agente de trabajo especificado no existe en el servidor lógico especificado.

  • 404 ResourceNotFound: no se encontró el recurso solicitado.

  • 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

  • 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.

Ejemplos

Get the latest version of a job step.

Solicitud de ejemplo

GET 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=2023-08-01

Respuesta de muestra

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

Definiciones

Nombre Description
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
JobStep

Un paso de trabajo.
JobStepAction

Acción que se va a ejecutar mediante un paso de trabajo.
JobStepActionSource

Origen de la acción que se va a ejecutar.
JobStepActionType

Tipo de acción que ejecuta el paso de trabajo.
JobStepExecutionOptions

Las opciones de ejecución de un paso de trabajo.
JobStepOutput

Configuración de salida de un paso de trabajo.
JobStepOutputType

Tipo de destino de salida.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

JobStep

Object

Un paso de trabajo.

Nombre Tipo Description
id

string

Identificador de recurso.
name

string

Nombre del recurso.
properties.action

JobStepAction

Carga de acción del paso de trabajo.
properties.credential

string

Identificador de recurso de la credencial de trabajo que se usará para conectarse a los destinos.
properties.executionOptions

JobStepExecutionOptions

Opciones de ejecución para el paso de trabajo.
properties.output

JobStepOutput

Propiedades de destino de salida del paso de trabajo.
properties.stepId

integer (int32)

Índice del paso de trabajo dentro del trabajo. Si no se especifica al crear el paso de trabajo, se creará como último paso. Si no se especifica al actualizar el paso de trabajo, el identificador del paso no se modifica.
properties.targetGroup

string

Identificador de recurso del grupo de destino en el que se ejecutará el paso de trabajo.
type

string

Tipo de recurso.

JobStepAction

Object

Acción que se va a ejecutar mediante un paso de trabajo.

Nombre Tipo Valor predeterminado Description
source

JobStepActionSource

Inline

Origen de la acción que se va a ejecutar.
type

JobStepActionType

TSql

Tipo de acción que ejecuta el paso de trabajo.
value

string

Valor de acción, por ejemplo, el texto del script T-SQL que se va a ejecutar.

JobStepActionSource

Enumeración

Origen de la acción que se va a ejecutar.

Valor Description
Inline

JobStepActionType

Enumeración

Tipo de acción que ejecuta el paso de trabajo.

Valor Description
TSql

JobStepExecutionOptions

Object

Las opciones de ejecución de un paso de trabajo.

Nombre Tipo Valor predeterminado Description
initialRetryIntervalSeconds

integer (int32)

1

Retraso inicial entre reintentos para la ejecución del paso de trabajo.
maximumRetryIntervalSeconds

integer (int32)

120

Cantidad máxima de tiempo que se espera entre reintentos para la ejecución del paso de trabajo.
retryAttempts

integer (int32)

10

Número máximo de veces que se volverá a intentar el paso de trabajo si se produce un error en el primer intento.
retryIntervalBackoffMultiplier

number (float)

2

Multiplicador de retroceso para el tiempo entre reintentos.
timeoutSeconds

integer (int32)

43200

Tiempo de espera de ejecución para el paso de trabajo.

JobStepOutput

Object

Configuración de salida de un paso de trabajo.

Nombre Tipo Valor predeterminado Description
credential

string

Identificador de recurso de la credencial que se va a usar para conectarse al destino de salida.
databaseName

string

Base de datos de destino de salida.
resourceGroupName

string

Grupo de recursos de destino de salida.
schemaName

string

dbo

Esquema de destino de salida.
serverName

string

Nombre del servidor de destino de salida.
subscriptionId

string (uuid)

Identificador de suscripción de destino de salida.
tableName

string

Tabla de destino de salida.
type

JobStepOutputType

SqlDatabase

Tipo de destino de salida.

JobStepOutputType

Enumeración

Tipo de destino de salida.

Valor Description
SqlDatabase