Job Target Executions - List By Step

Référence

Service:: SQL Database

API Version:: 2021-11-01

Listes les exécutions cibles d’une exécution d’étape de travail.

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	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 à obtenir.
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	Le nom du serveur
stepName	path	True	string	Nom de l'étape.
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 int64	Nombre d’éléments dans la collection à ignorer.
$top	query		integer int64	Nombre d’éléments à retourner à partir de la collection.
createTimeMax	query		string date-time	Si elle est spécifiée, seules les exécutions de travaux créées avant l’heure spécifiée sont incluses.
createTimeMin	query		string date-time	Si elle est spécifiée, seules les exécutions de travaux créées à l’heure spécifiée ou après cette date sont incluses.
endTimeMax	query		string date-time	Si elle est spécifiée, seules les exécutions de travaux effectuées avant l’heure spécifiée sont incluses.
endTimeMin	query		string date-time	Si elle est spécifiée, seules les exécutions de travaux effectuées à ou après l’heure spécifiée sont incluses.
isActive	query		boolean	Si elle est spécifiée, seules les exécutions de travaux actives ou terminées sont incluses.

Réponses

Nom	Type	Description
200 OK	JobExecutionListResult	Récupération réussie des exécutions cibles.
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.

Nom

Type

Description

200 OK

JobExecutionListResult

Récupération réussie des exécutions cibles.

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 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 com.azure.core.util.Context;
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, 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

Sample Response

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

Définitions

Nom	Description
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 de 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

Nom	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 status ou message d’erreur.
properties.lifecycle	JobExecutionLifecycle	État détaillé de l’exécution du travail.
properties.provisioningState	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 d’étape du travail.
properties.stepName	string	Nom de l’étape de travail.
properties.target	JobExecutionTarget	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.

Nom	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.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	JobExecution[]	Tableau de résultats.

JobExecutionTarget

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

Nom	Type	Description
databaseName	string	Nom de la base de données.
serverName	string	Nom du serveur.
type	JobTargetType	Type de la cible.

JobTargetType

Type de la cible.

Nom	Type	Description
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

ProvisioningState

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

Nom	Type	Description
Canceled	string
Created	string
Failed	string
InProgress	string
Succeeded	string

Job Target Executions - List By Step

Paramètres URI

Réponses

Exemples

List job step target executions

Sample Request

Sample Response

Définitions

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Ressources supplémentaires