Job Steps - List By Job

Referencia

Servicio:: SQL Database

Versión de la API:: 2021-11-01

Obtiene todos los pasos de trabajo de 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?api-version=2021-11-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 que se va a obtener.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	JobStepListResult	Recuperó correctamente la lista de pasos de trabajo.
Other Status Codes		Respuestas de error: *** 404 JobAgentNotFound: el agente de trabajo especificado no existe en el servidor lógico especificado. 404 ResourceNotFound: no se encontró el recurso solicitado. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

Nombre

Tipo

Description

200 OK

JobStepListResult

Recuperó correctamente la lista de pasos de trabajo.

Other Status Codes

Respuestas de error: ***

404 JobAgentNotFound: el agente de trabajo especificado no existe en el servidor lógico especificado.
404 ResourceNotFound: no se encontró el recurso solicitado.
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado
404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

Ejemplos

List job steps for the latest version of a job.

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


/**
 * Samples for JobSteps ListByJob.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobStepsByJob.json
     */
    /**
     * Sample code: List job steps for the latest version of a job.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobStepsForTheLatestVersionOfAJob(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobSteps().listByJob("group1", "server1", "agent1", "job1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "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"
    },
    {
      "properties": {
        "stepId": 2,
        "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/step2",
      "name": "step2",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
    }
  ]
}

Definiciones

Nombre	Description
JobStep	Un paso de trabajo.
JobStepAction	Acción que ejecutará 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	Opciones de ejecución de un paso de trabajo.
JobStepListResult	Lista de pasos de trabajo.
JobStepOutput	Configuración de salida de un paso de trabajo.
JobStepOutputType	Tipo de destino de salida.

JobStep

Un paso de trabajo.

Nombre	Tipo	Description
id	string	Identificador del 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	Índice del paso de trabajo dentro del trabajo. Si no se especifica al crear el paso de trabajo, se creará como el ú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

Acción que ejecutará 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 de T-SQL que se va a ejecutar.

JobStepActionSource

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

Nombre	Tipo	Description
Inline	string

JobStepActionType

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

Nombre	Tipo	Description
TSql	string

JobStepExecutionOptions

Opciones de ejecución de un paso de trabajo.

Nombre	Tipo	Valor predeterminado	Description
initialRetryIntervalSeconds	integer	1	Retraso inicial entre reintentos para la ejecución del paso de trabajo.
maximumRetryIntervalSeconds	integer	120	Cantidad máxima de tiempo que se esperará entre reintentos para la ejecución del paso de trabajo.
retryAttempts	integer	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	2	Multiplicador de retroceso para el tiempo entre reintentos.
timeoutSeconds	integer	43200	Tiempo de espera de ejecución para el paso de trabajo.

JobStepListResult

Lista de pasos de trabajo.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	JobStep[]	Matriz de resultados.

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		Identificador de la 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.

Nombre	Tipo	Description
SqlDatabase	string

Compartir a través de

Job Steps - List By Job

Parámetros de identificador URI

Respuestas

Ejemplos

List job steps for the latest version of a job.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

JobStep

JobStepAction

JobStepActionSource

JobStepActionType

JobStepExecutionOptions

JobStepListResult

JobStepOutput

JobStepOutputType

Recursos adicionales