Job Steps - List By Version

Référence

Service:: SQL Database

API Version:: 2021-11-01

Obtient toutes les étapes du travail dans la version de travail spécifiée.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
jobAgentName	path	True	string	Nom de l’agent de travail.
jobName	path	True	string	Nom du travail à obtenir.
jobVersion	path	True	integer int32	Version 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
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.

Réponses

Nom	Type	Description
200 OK	JobStepListResult	La liste des étapes de travail a été récupérée.
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

JobStepListResult

La liste des étapes de travail a été récupérée.

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 steps for the specified 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/versions/1/steps?api-version=2021-11-01


import com.azure.core.util.Context;

/** Samples for JobSteps ListByVersion. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobStepsByVersion.json
     */
    /**
     * Sample code: List job steps for the specified version of a job.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobStepsForTheSpecifiedVersionOfAJob(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobSteps().listByVersion("group1", "server1", "agent1", "job1",
            1, 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": {
        "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/versions/1/steps/step1",
      "name": "step1",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/versions/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/versions/1/steps/step2",
      "name": "step2",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/versions/steps"
    }
  ]
}

Définitions

Nom	Description
JobStep	Étape de travail.
JobStepAction	Action à exécuter par une étape de travail.
JobStepActionSource	Source de l’action à exécuter.
JobStepActionType	Type d’action exécuté par l’étape de travail.
JobStepExecutionOptions	Options d’exécution d’une étape de travail.
JobStepListResult	Liste des étapes du travail.
JobStepOutput	Configuration de sortie d’une étape de travail.
JobStepOutputType	Type de destination de sortie.

JobStep

Étape de travail.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.action	JobStepAction	Charge utile d’action de l’étape de travail.
properties.credential	string	ID de ressource des informations d’identification du travail qui seront utilisées pour se connecter aux cibles.
properties.executionOptions	JobStepExecutionOptions	Options d’exécution pour l’étape de travail.
properties.output	JobStepOutput	Propriétés de destination de sortie de l’étape de travail.
properties.stepId	integer	Index de l’étape de travail dans le travail. Si elle n’est pas spécifiée lors de la création de l’étape de travail, elle est créée en tant que dernière étape. S’il n’est pas spécifié lors de la mise à jour de l’étape de travail, l’ID d’étape n’est pas modifié.
properties.targetGroup	string	ID de ressource du groupe cible sur lequel l’étape de travail sera exécutée.
type	string	Type de ressource.

JobStepAction

Action à exécuter par une étape de travail.

Nom	Type	Valeur par défaut	Description
source	JobStepActionSource	Inline	Source de l’action à exécuter.
type	JobStepActionType	TSql	Type d’action exécuté par l’étape de travail.
value	string		Valeur de l’action, par exemple le texte du script T-SQL à exécuter.

JobStepActionSource

Source de l’action à exécuter.

Nom	Type	Description
Inline	string

JobStepActionType

Type d’action exécuté par l’étape de travail.

Nom	Type	Description
TSql	string

JobStepExecutionOptions

Options d’exécution d’une étape de travail.

Nom	Type	Valeur par défaut	Description
initialRetryIntervalSeconds	integer	1	Délai initial entre les nouvelles tentatives pour l’exécution de l’étape de travail.
maximumRetryIntervalSeconds	integer	120	Durée maximale d’attente entre les nouvelles tentatives pour l’exécution de l’étape de travail.
retryAttempts	integer	10	Nombre maximal de fois que l’étape de travail sera réentrée en cas d’échec de la première tentative.
retryIntervalBackoffMultiplier	number	2	Multiplicateur d’interruption pour le temps entre les nouvelles tentatives.
timeoutSeconds	integer	43200	Délai d’exécution de l’étape de travail.

JobStepListResult

Liste des étapes du travail.

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

JobStepOutput

Configuration de sortie d’une étape de travail.

Nom	Type	Valeur par défaut	Description
credential	string		ID de ressource des informations d’identification à utiliser pour se connecter à la destination de sortie.
databaseName	string		Base de données de destination de sortie.
resourceGroupName	string		Groupe de ressources de destination de sortie.
schemaName	string	dbo	Schéma de destination de sortie.
serverName	string		Nom du serveur de destination de sortie.
subscriptionId	string		ID d’abonnement de destination de sortie.
tableName	string		Table de destination de sortie.
type	JobStepOutputType	SqlDatabase	Type de destination de sortie.

JobStepOutputType

Type de destination de sortie.

Nom	Type	Description
SqlDatabase	string

Job Steps - List By Version

Paramètres URI

Réponses

Exemples

List job steps for the specified version of a job.

Sample Request

Sample Response

Définitions

JobStep

JobStepAction

JobStepActionSource

JobStepActionType

JobStepExecutionOptions

JobStepListResult

JobStepOutput

JobStepOutputType

Ressources supplémentaires