Job Steps - Get

Obtient une étape de travail dans la version actuelle d’un travail.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}?api-version=2025-01-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

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serverName
path True

string

Le nom du serveur

stepName
path True

string

Nom de l’étape de travail.

subscriptionId
path True

string (uuid)

ID de l’abonnement cible. La valeur doit être un UUID.

api-version
query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

JobStep

Opération Azure terminée avec succès.

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Get the latest version of a job step.

Exemple de requête

GET 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=2025-01-01

Exemple de réponse

{
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "properties": {
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "executionOptions": {
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryAttempts": 42,
      "retryIntervalBackoffMultiplier": 3,
      "timeoutSeconds": 1234
    },
    "output": {
      "type": "SqlDatabase",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
      "databaseName": "database3",
      "resourceGroupName": "group3",
      "schemaName": "myschema1234",
      "serverName": "server3",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "tableName": "mytable5678"
    },
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1"
  }
}

Définitions

Nom Description
createdByType

Type d’identité qui a créé la ressource.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

JobStep

Étape du 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.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Valeur Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

JobStep

Étape du travail.

Nom Type Description
id

string (arm-id)

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

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 de l’étape de travail.

properties.output

JobStepOutput

Propriétés de destination de sortie de l’étape de travail.

properties.stepId

integer (int32)

Index de l’étape de travail dans le travail. S’il n’est pas spécifié lors de la création de l’étape de travail, il est créé 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.

systemData

systemData

Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.

type

string

Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

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 d’action, par exemple le texte du script T-SQL à exécuter.

JobStepActionSource

Source de l’action à exécuter.

Valeur Description
Inline

En ligne

JobStepActionType

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

Valeur Description
TSql

TSql

JobStepExecutionOptions

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

Nom Type Valeur par défaut Description
initialRetryIntervalSeconds

integer (int32)

1

Délai initial entre les nouvelles tentatives pour l’exécution de l’étape du travail.

maximumRetryIntervalSeconds

integer (int32)

120

Durée maximale d’attente entre les nouvelles tentatives pour l’exécution de l’étape du travail.

retryAttempts

integer (int32)

10

Nombre maximal de fois où l’étape du travail sera réattempée si la première tentative échoue.

retryIntervalBackoffMultiplier

number (float)

2

Multiplicateur d’interruption pour le temps entre les nouvelles tentatives.

timeoutSeconds

integer (int32)

43200

Délai d’expiration de l’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 (uuid)

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.

Valeur Description
SqlDatabase

SqlDatabase

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.