Job Step Executions - List By Job Execution

Répertorie les exécutions d’étapes d’une exécution de travail.

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

Paramètres URI

Name In Required Type Description
jobAgentName
path True
  • string

Nom de l’agent de travail.

jobExecutionId
path True
  • string
uuid

ID de l’exécution du travail

jobName
path True
  • string

Nom du travail à récupérer.

resourceGroupName
path True
  • string

Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.

serverName
path True
  • string

Nom du serveur.

subscriptionId
path True
  • string

L’ID d’abonnement d’un abonnement Azure.

api-version
query True
  • string

Version de l’API à utiliser pour la requête.

$skip
query
  • integer

Nombre d’éléments de la collection à ignorer.

$top
query
  • integer

Nombre d’éléments à retourner à partir de la collection.

createTimeMax
query
  • string
date-time

S’il est spécifié, seules les exécutions de tâches créées avant l’heure spécifiée sont incluses.

createTimeMin
query
  • string
date-time

S’il est spécifié, seules les exécutions de tâches créées à ou après l’heure spécifiée sont incluses.

endTimeMax
query
  • string
date-time

S’il est spécifié, seules les exécutions de tâches effectuées avant l’heure spécifiée sont incluses.

endTimeMin
query
  • string
date-time

S’il est spécifié, seules les exécutions de tâches effectuées à ou après l’heure spécifiée sont incluses.

isActive
query
  • boolean

S’il est spécifié, seules les exécutions de travaux actives ou terminées sont incluses.

Réponses

Name Type Description
200 OK

Les exécutions de l’étape ont été récupérées avec succès.

Other Status Codes

Réponses d’erreur : * * *

  • 404 JobAgentNotFound-l’agent de travail spécifié n’existe pas dans le serveur logique spécifié.

  • 404 ResourceNotFound-la ressource demandée est introuvable.

  • 404 SubscriptionDoesNotHaveServer-le serveur demandé est introuvable

  • 404 ServerNotInSubscriptionResourceGroup-le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.

Exemples

List job step executions

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps?api-version=2020-11-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "stepName": "step1",
        "stepId": 1,
        "jobExecutionId": "5555-6666-7777-8888-999999999999",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-03T04:33:15.7189151Z",
        "startTime": "2017-12-03T04:33:16.176937Z",
        "endTime": "2017-12-03T04:33:19.0600862Z",
        "currentAttempts": 1,
        "currentAttemptStartTime": "2017-12-03T04:33:17.4840068Z",
        "lastMessage": "Step 1 succeeded."
      },
      "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",
      "name": "step1",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps"
    }
  ]
}

Définitions

JobExecution

Exécution d’un travail

JobExecutionLifecycle

État détaillé de l’exécution du travail.

JobExecutionListResult

Liste des exécutions de travaux.

JobExecutionTarget

Cible sur laquelle une exécution du travail est exécutée.

JobTargetType

Type de la cible.

ProvisioningState

État d’approvisionnement ARM de l’exécution du travail.

JobExecution

Exécution d’un travail

Name Type Description
id
  • string

ID de la ressource

name
  • string

Nom de la ressource.

properties.createTime
  • string

Heure à laquelle l’exécution du travail a été créée.

properties.currentAttemptStartTime
  • string

Heure de début de la tentative en cours.

properties.currentAttempts
  • integer

Nombre de tentatives d’exécution du travail.

properties.endTime
  • string

Heure à laquelle l’exécution du travail s’est terminée.

properties.jobExecutionId
  • string

Identificateur unique de l’exécution du travail.

properties.jobVersion
  • integer

Numéro de version du travail.

properties.lastMessage
  • string

Dernier État ou message d’erreur.

properties.lifecycle

État détaillé de l’exécution du travail.

properties.provisioningState

État d’approvisionnement ARM de l’exécution du travail.

properties.startTime
  • string

Heure à laquelle l’exécution du travail a démarré.

properties.stepId
  • integer

ID de l’étape de travail.

properties.stepName
  • string

Nom de l’étape de travail.

properties.target

Cible sur laquelle cette exécution est exécutée.

type
  • string

Type de ressource.

JobExecutionLifecycle

État détaillé de l’exécution du travail.

Name Type Description
Canceled
  • string
Created
  • string
Failed
  • string
InProgress
  • string
Skipped
  • string
Succeeded
  • string
SucceededWithSkipped
  • string
TimedOut
  • string
WaitingForChildJobExecutions
  • string
WaitingForRetry
  • string

JobExecutionListResult

Liste des exécutions de travaux.

Name Type Description
nextLink
  • string

Lien permettant de récupérer la page de résultats suivante.

value

Tableau de résultats.

JobExecutionTarget

Cible sur laquelle une exécution du travail est exécutée.

Name Type Description
databaseName
  • string

Nom de la base de données.

serverName
  • string

Nom du serveur.

type

Type de la cible.

JobTargetType

Type de la cible.

Name Type Description
SqlDatabase
  • string
SqlElasticPool
  • string
SqlServer
  • string
SqlShardMap
  • string
TargetGroup
  • string

ProvisioningState

État d’approvisionnement ARM de l’exécution du travail.

Name Type Description
Canceled
  • string
Created
  • string
Failed
  • string
InProgress
  • string
Succeeded
  • string