Job Steps - Get

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=2025-01-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

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.

serverName
path True

string

El nombre del servidor.

stepName
path True

string

Nombre del paso de trabajo.

subscriptionId
path True

string (uuid)

Identificador de la suscripción de destino. El valor debe ser un UUID.

api-version
query True

string

minLength: 1

Versión de API que se usará para esta operación.

Respuestas

Nombre Tipo Description
200 OK

JobStep

Operación de Azure completada con éxito.

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

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=2025-01-01

Respuesta de muestra

{
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "properties": {
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "executionOptions": {
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryAttempts": 42,
      "retryIntervalBackoffMultiplier": 3,
      "timeoutSeconds": 1234
    },
    "output": {
      "type": "SqlDatabase",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
      "databaseName": "database3",
      "resourceGroupName": "group3",
      "schemaName": "myschema1234",
      "serverName": "server3",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "tableName": "mytable5678"
    },
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1"
  }
}

Definiciones

Nombre Description
createdByType

Tipo de identidad que creó el recurso.

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.

systemData

Metadatos relativos a la creación y última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Valor Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

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

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

El mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

JobStep

Un paso de trabajo.

Nombre Tipo Description
id

string (arm-id)

Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

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.

systemData

systemData

Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.

type

string

Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

JobStepAction

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

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

Valor Description
Inline

Insertado

JobStepActionType

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

Valor Description
TSql

TSql

JobStepExecutionOptions

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

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

Tipo de destino de salida.

Valor Description
SqlDatabase

SqlDatabase

systemData

Metadatos relativos a la creación y última modificación del recurso.

Nombre Tipo Description
createdAt

string (date-time)

Marca de tiempo de creación de recursos (UTC).

createdBy

string

Identidad que creó el recurso.

createdByType

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt

string (date-time)

La marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy

string

Identidad que modificó por última vez el recurso.

lastModifiedByType

createdByType

Tipo de identidad que modificó por última vez el recurso.