Job Target Executions - List By Step

Referencia

Servicio:: SQL Database

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

Listas las ejecuciones de destino de una ejecución de pasos de trabajo.

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

Con parámetros opcionales:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets?createTimeMin={createTimeMin}&createTimeMax={createTimeMax}&endTimeMin={endTimeMin}&endTimeMax={endTimeMax}&isActive={isActive}&$skip={$skip}&$top={$top}&api-version=2021-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
jobAgentName	path	True	string	Nombre del agente de trabajo.
jobExecutionId	path	True	string uuid	Identificador de la ejecución del 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.
stepName	path	True	string	Nombre del paso.
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.
$skip	query		integer int64	Número de elementos de la colección que se omitirán.
$top	query		integer int64	Número de elementos que se van a devolver de la colección.
createTimeMax	query		string date-time	Si se especifica, solo se incluyen las ejecuciones de trabajos creadas antes de la hora especificada.
createTimeMin	query		string date-time	Si se especifica, solo se incluyen las ejecuciones de trabajo creadas en o después de la hora especificada.
endTimeMax	query		string date-time	Si se especifica, solo se incluyen las ejecuciones de trabajo completadas antes de la hora especificada.
endTimeMin	query		string date-time	Si se especifica, solo se incluyen las ejecuciones de trabajo completadas en o después de la hora especificada.
isActive	query		boolean	Si se especifica, solo se incluyen las ejecuciones de trabajos activas o completadas.

Respuestas

Nombre	Tipo	Description
200 OK	JobExecutionListResult	Recuperó correctamente las ejecuciones de destino.
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

JobExecutionListResult

Recuperó correctamente las ejecuciones de destino.

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 step target executions

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5A86BF65-43AC-F258-2524-9E92992F97CA/steps/step1/targets?api-version=2021-11-01


import java.util.UUID;

/**
 * Samples for JobTargetExecutions ListByStep.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionTargetsByStep.json
     */
    /**
     * Sample code: List job step target executions.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobStepTargetExecutions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobTargetExecutions().listByStep("group1", "server1", "agent1",
            "job1", UUID.fromString("5A86BF65-43AC-F258-2524-9E92992F97CA"), "step1", null, null, null, null, null,
            null, null, 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": {
        "jobVersion": 1,
        "stepName": "step1",
        "stepId": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-07-01T04:33:17.5133333Z",
        "startTime": "2017-07-01T04:33:18.1230403Z",
        "endTime": "2017-07-01T04:33:18.7031029Z",
        "currentAttempts": 1,
        "currentAttemptStartTime": "2017-07-01T04:33:18.2391013Z",
        "lastMessage": "Step 1 succeeded execution on target (server 'server1', database 'database1').",
        "target": {
          "type": "SqlDatabase",
          "serverName": "server1",
          "databaseName": "database1"
        }
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1/targets/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets"
    }
  ]
}

Definiciones

Nombre	Description
JobExecution	Ejecución de un trabajo
JobExecutionLifecycle	Estado detallado de la ejecución del trabajo.
JobExecutionListResult	Lista de ejecuciones de trabajos.
JobExecutionTarget	Destino en el que se ejecuta una ejecución de trabajo.
JobTargetType	Tipo del destino.
ProvisioningState	Estado de aprovisionamiento de ARM de la ejecución del trabajo.

JobExecution

Object

Ejecución de un trabajo

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.createTime	string	Hora a la que se creó la ejecución del trabajo.
properties.currentAttemptStartTime	string	Hora de inicio del intento actual.
properties.currentAttempts	integer	Número de veces que se ha intentado la ejecución del trabajo.
properties.endTime	string	Hora a la que se completó la ejecución del trabajo.
properties.jobExecutionId	string	Identificador único de la ejecución del trabajo.
properties.jobVersion	integer	Número de versión del trabajo.
properties.lastMessage	string	Último estado o mensaje de error.
properties.lifecycle	JobExecutionLifecycle	Estado detallado de la ejecución del trabajo.
properties.provisioningState	ProvisioningState	Estado de aprovisionamiento de ARM de la ejecución del trabajo.
properties.startTime	string	Hora a la que se inició la ejecución del trabajo.
properties.stepId	integer	Identificador del paso de trabajo.
properties.stepName	string	Nombre del paso de trabajo.
properties.target	JobExecutionTarget	Destino en el que se ejecuta esta ejecución.
type	string	Tipo de recurso.

JobExecutionLifecycle

Enumeration

Estado detallado de la ejecución del trabajo.

Valor	Description
Canceled
Created
Failed
InProgress
Skipped
Succeeded
SucceededWithSkipped
TimedOut
WaitingForChildJobExecutions
WaitingForRetry

JobExecutionListResult

Object

Lista de ejecuciones de trabajos.

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

JobExecutionTarget

Object

Destino en el que se ejecuta una ejecución de trabajo.

Nombre	Tipo	Description
databaseName	string	Nombre de la base de datos.
serverName	string	Nombre del servidor.
type	JobTargetType	Tipo del destino.

JobTargetType

Enumeration

Tipo del destino.

Valor	Description
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup

ProvisioningState

Enumeration

Estado de aprovisionamiento de ARM de la ejecución del trabajo.

Valor	Description
Canceled
Created
Failed
InProgress
Succeeded

Compartir a través de

Job Target Executions - List By Step

Parámetros de identificador URI

Respuestas

Ejemplos

List job step target executions

Solicitud de ejemplo

Respuesta de muestra

Definiciones

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Recursos adicionales