Job Steps - List By Job
Obtient toutes les étapes de travail pour 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?api-version=2021-11-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
job
|
path | True |
string |
Nom de l’agent de travail. |
job
|
path | True |
string |
Nom du travail à obtenir. |
resource
|
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. |
server
|
path | True |
string |
Le nom du serveur |
subscription
|
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 |
La liste des étapes du travail a été récupérée. |
|
Other Status Codes |
Réponses d’erreur : ***
|
Exemples
List job steps for the latest version of a job.
Sample Request
Sample Response
{
"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/steps/step1",
"name": "step1",
"type": "Microsoft.Sql/servers/jobAgents/jobs/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/steps/step2",
"name": "step2",
"type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}
]
}
Définitions
Nom | Description |
---|---|
Job |
Étape de travail. |
Job |
Action à exécuter par une étape de travail. |
Job |
Source de l’action à exécuter. |
Job |
Type d’action exécuté par l’étape du travail. |
Job |
Options d’exécution d’une étape de travail. |
Job |
Liste des étapes du travail. |
Job |
Configuration de sortie d’une étape de travail. |
Job |
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 |
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 |
Options d’exécution pour l’étape du travail. |
|
properties.output |
Propriétés de destination de sortie de l’étape du travail. |
|
properties.stepId |
integer |
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, elle sera créée comme dernière étape. S’il n’est pas spécifié lors de la mise à jour de l’étape, l’ID d’étape n’est pas modifié. |
properties.targetGroup |
string |
ID de ressource du groupe cible sur lequel l’étape du 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 | Inline |
Source de l’action à exécuter. |
|
type | TSql |
Type d’action exécuté par l’étape du travail. |
|
value |
string |
Valeur d’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 du 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 d’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 du travail. |
retryAttempts |
integer |
10 |
Nombre maximal de fois que l’étape du travail est réentrée en cas d’échec de la première tentative. |
retryIntervalBackoffMultiplier |
number |
2 |
Multiplicateur de backoff pour le temps entre les nouvelles tentatives. |
timeoutSeconds |
integer |
43200 |
Délai d’exécution pour 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 |
Job |
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 | SqlDatabase |
Type de destination de sortie. |
JobStepOutputType
Type de destination de sortie.
Nom | Type | Description |
---|---|---|
SqlDatabase |
string |