Job Step Executions - Get

Referenz

Dienst:: SQL Database

API-Version:: 2023-08-01

Ruft eine Schrittausführung einer Auftragsausführung ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}?api-version=2023-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
jobAgentName	path	True	string	Der Name des Auftragsagenten.
jobExecutionId	path	True	string (uuid)	Die eindeutige ID der Auftragsausführung
jobName	path	True	string	Der Name des abzurufenden Auftrags.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
stepName	path	True	string	Der Name des Schritts.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	JobExecution	Die Ausführung des Schritts wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt 404 JobAgentNotFound – Der angegebene Auftrags-Agent ist nicht auf dem angegebenen logischen Server vorhanden. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden. 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden. 404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden.

Name

Typ

Beschreibung

200 OK

JobExecution

Die Ausführung des Schritts wurde erfolgreich abgerufen.

Other Status Codes

ErrorResponse

Fehlerantworten: ***

400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird
400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt
404 JobAgentNotFound – Der angegebene Auftrags-Agent ist nicht auf dem angegebenen logischen Server vorhanden.
404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden.
404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.
404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden.
404 ResourceNotFound – Die angeforderte Ressource wurde nicht gefunden.

Beispiele

Get a job step execution

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?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetJobExecutionStep.json
// this example is just showing the usage of "JobStepExecutions_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerJobExecutionStepResource created on azure
// for more information of creating SqlServerJobExecutionStepResource, please refer to the document of SqlServerJobExecutionStepResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
string jobName = "job1";
Guid jobExecutionId = Guid.Parse("5A86BF65-43AC-F258-2524-9E92992F97CA");
string stepName = "step1";
ResourceIdentifier sqlServerJobExecutionStepResourceId = SqlServerJobExecutionStepResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName, jobName, jobExecutionId, stepName);
SqlServerJobExecutionStepResource sqlServerJobExecutionStep = client.GetSqlServerJobExecutionStepResource(sqlServerJobExecutionStepResourceId);

// invoke the operation
SqlServerJobExecutionStepResource result = await sqlServerJobExecutionStep.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobExecutionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "properties": {
    "jobVersion": 1,
    "stepName": "step1",
    "stepId": 1,
    "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
    "lifecycle": "Succeeded",
    "provisioningState": "Succeeded",
    "createTime": "2017-12-27T04:33:15.7189151Z",
    "startTime": "2017-12-27T04:33:16.176937Z",
    "endTime": "2017-12-27T04:33:19.0600862Z",
    "currentAttempts": 1,
    "currentAttemptStartTime": "2017-12-27T04:33:17.4840068Z",
    "lastMessage": "Step 1 succeeded."
  },
  "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",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps"
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
JobExecution	Ausführung eines Auftrags
JobExecutionLifecycle	Der detaillierte Zustand der Auftragsausführung.
JobExecutionTarget	Das Ziel, für das eine Auftragsausführung ausgeführt wird.
JobTargetType	Der Typ des Ziels.
ProvisioningState	Der ARM-Bereitstellungsstatus der Auftragsausführung.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

JobExecution

Objekt

Ausführung eines Auftrags

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.createTime	string (date-time)	Der Zeitpunkt, zu dem die Auftragsausführung erstellt wurde.
properties.currentAttemptStartTime	string (date-time)	Startzeit des aktuellen Versuchs.
properties.currentAttempts	integer (int32)	Häufigkeit, mit der die Auftragsausführung versucht wurde.
properties.endTime	string (date-time)	Der Zeitpunkt, zu dem die Auftragsausführung abgeschlossen wurde.
properties.jobExecutionId	string (uuid)	Der eindeutige Bezeichner der Auftragsausführung.
properties.jobVersion	integer (int32)	Die Auftragsversionsnummer.
properties.lastMessage	string	Der letzte Status oder die letzte Fehlermeldung.
properties.lifecycle	JobExecutionLifecycle	Der detaillierte Zustand der Auftragsausführung.
properties.provisioningState	ProvisioningState	Der ARM-Bereitstellungsstatus der Auftragsausführung.
properties.startTime	string (date-time)	Die Zeit, zu der die Auftragsausführung gestartet wurde.
properties.stepId	integer (int32)	Die Auftragsschritt-ID.
properties.stepName	string	Der Name des Auftragsschritts.
properties.target	JobExecutionTarget	Das Ziel, für das diese Ausführung ausgeführt wird.
type	string	Ressourcentyp.

JobExecutionLifecycle

Enumeration

Der detaillierte Zustand der Auftragsausführung.

Wert	Beschreibung
Canceled
Created
Failed
InProgress
Skipped
Succeeded
SucceededWithSkipped
TimedOut
WaitingForChildJobExecutions
WaitingForRetry

JobExecutionTarget

Objekt

Das Ziel, für das eine Auftragsausführung ausgeführt wird.

Name	Typ	Beschreibung
databaseName	string	Der Datenbankname.
serverName	string	Der Servername.
type	JobTargetType	Der Typ des Ziels.

JobTargetType

Enumeration

Der Typ des Ziels.

Wert	Beschreibung
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup

ProvisioningState

Enumeration

Der ARM-Bereitstellungsstatus der Auftragsausführung.

Wert	Beschreibung
Canceled
Created
Failed
InProgress
Succeeded

Freigeben über

Job Step Executions - Get

URI-Parameter

Antworten

Beispiele

Get a job step execution

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JobExecution

JobExecutionLifecycle

JobExecutionTarget

JobTargetType

ProvisioningState