Job Steps - Create Or Update

  • Référence
Service:
SQL Database
API Version:
2021-11-01

Crée ou met à jour une étape de travail. Cela crée implicitement une nouvelle version de travail.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}?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.
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 de travail.
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.

Corps de la demande

Nom Obligatoire Type Description
properties.action True

JobStepAction

Charge utile d’action de l’étape de travail.
properties.credential True

string

ID de ressource des informations d’identification du travail qui seront utilisées pour se connecter aux cibles.
properties.targetGroup True

string

ID de ressource du groupe cible sur lequel l’étape de travail sera exécutée.
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é.

Réponses

Nom Type Description
200 OK

JobStep

Mise à jour réussie de l’étape de travail.
201 Created

JobStep

L’étape de travail a été ajoutée.
Other Status Codes

Réponses d’erreur : ***

  • 400 JobStepIdMismatch : l’ID d’étape dans l’URI d’étape de travail spécifié ne correspond pas à l’ID d’étape dans la ressource d’étape de travail fournie.

  • 400 InvalidResourceRequestBody : la ressource ou les propriétés de ressource dans le corps de la demande sont vides ou non valides.

  • 400 InvalidResourceId : identificateur de ressource non valide.

  • 400 MismatchingSubscriptionWithUrl : l’abonnement fourni ne correspond pas à l’abonnement dans l’URL.

  • 400 Non correspondanceResourceGroupNameWithUrl : le nom du groupe de ressources fourni ne correspond pas au nom dans l’URL.

  • 400 MismatchingServerNameWithUrl : le nom du serveur fourni ne correspond pas au nom dans l’URL.

  • 400 Non correspondanceJobAccountNameWithUrl : le nom du compte de travail fourni ne correspond pas au nom dans l’URL.

  • 400 ElasticJobsOperationFailed : échec de l’opération de gestion des travaux élastiques.

  • 400 ElasticJobsOperationFailed : échec de l’opération de gestion des travaux élastiques.

  • 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

Create or update a job step with all properties specified.
Create or update a job step with minimal properties specified.

Create or update a job step with all properties specified.

Sample Request

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

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

Sample Response

Status code:
200 
{
  "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"
}
Status code:
201 
{
  "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"
}

Create or update a job step with minimal properties specified.

Sample Request

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

{
  "properties": {
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "value": "select 1"
    }
  }
}

Sample Response

Status code:
200 
{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "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"
}
Status code:
201 
{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "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"
}

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

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