Job Step Executions - List By Job Execution

Referenz

Dienst:: SQL Database

API-Version:: 2021-11-01

Listen die Schrittausführungen einer Auftragsausführung.

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

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps?createTimeMin={createTimeMin}&createTimeMax={createTimeMax}&endTimeMin={endTimeMin}&endTimeMax={endTimeMax}&isActive={isActive}&$skip={$skip}&$top={$top}&api-version=2021-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
jobAgentName	path	True	string	Der Name des Auftrags-Agents.
jobExecutionId	path	True	string uuid	Die 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. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.
$skip	query		integer int64	Die Anzahl der zu überspringenden Elemente in der Auflistung.
$top	query		integer int64	Die Anzahl der Elemente, die aus der Auflistung zurückgegeben werden sollen.
createTimeMax	query		string date-time	Wenn angegeben, werden nur Auftragsausführungen eingeschlossen, die vor der angegebenen Zeit erstellt wurden.
createTimeMin	query		string date-time	Wenn angegeben, werden nur Auftragsausführungen eingeschlossen, die zu oder nach dem angegebenen Zeitpunkt erstellt wurden.
endTimeMax	query		string date-time	Wenn angegeben, werden nur Auftragsausführungen eingeschlossen, die vor der angegebenen Zeit abgeschlossen wurden.
endTimeMin	query		string date-time	Wenn angegeben, werden nur Auftragsausführungen eingeschlossen, die zu oder nach dem angegebenen Zeitpunkt abgeschlossen wurden.
isActive	query		boolean	Wenn angegeben, sind nur aktive oder nur abgeschlossene Auftragsausführungen enthalten.

Antworten

Name	Typ	Beschreibung
200 OK	JobExecutionListResult	Die Schrittausführungen wurden erfolgreich abgerufen.
Other Status Codes		Fehlerantworten: *** 404 JobAgentNotFound: Der angegebene Auftrags-Agent ist auf dem angegebenen logischen Server nicht vorhanden. 404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden. 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

Name

Typ

Beschreibung

200 OK

JobExecutionListResult

Die Schrittausführungen wurden erfolgreich abgerufen.

Other Status Codes

Fehlerantworten: ***

404 JobAgentNotFound: Der angegebene Auftrags-Agent ist auf dem angegebenen logischen Server nicht vorhanden.
404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden.
404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden
404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

Beispiele

List job step executions

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?api-version=2021-11-01


import java.util.UUID;

/**
 * Samples for JobStepExecutions ListByJobExecution.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionSteps.json
     */
    /**
     * Sample code: List job step executions.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobStepExecutions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobStepExecutions().listByJobExecution("group1", "server1",
            "agent1", "job1", UUID.fromString("5A86BF65-43AC-F258-2524-9E92992F97CA"), null, null, null, null, null,
            null, null, com.azure.core.util.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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "stepName": "step1",
        "stepId": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-03T04:33:15.7189151Z",
        "startTime": "2017-12-03T04:33:16.176937Z",
        "endTime": "2017-12-03T04:33:19.0600862Z",
        "currentAttempts": 1,
        "currentAttemptStartTime": "2017-12-03T04: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
JobExecution	Eine Ausführung eines Auftrags
JobExecutionLifecycle	Der detaillierte Zustand der Auftragsausführung.
JobExecutionListResult	Eine Liste der Auftragsausführungen.
JobExecutionTarget	Das Ziel, für das eine Auftragsausführung ausgeführt wird.
JobTargetType	Der Typ des Ziels.
ProvisioningState	Der ARM-Bereitstellungsstatus der Auftragsausführung.

JobExecution

Eine Ausführung eines Auftrags

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.createTime	string	Der Zeitpunkt, zu dem die Auftragsausführung erstellt wurde.
properties.currentAttemptStartTime	string	Startzeit des aktuellen Versuchs.
properties.currentAttempts	integer	Die Anzahl der Versuche, die Auftragsausführung durchzuführen.
properties.endTime	string	Der Zeitpunkt, zu dem die Auftragsausführung abgeschlossen wurde.
properties.jobExecutionId	string	Der eindeutige Bezeichner der Auftragsausführung.
properties.jobVersion	integer	Die Auftragsversionsnummer.
properties.lastMessage	string	Die letzte status oder Fehlermeldung.
properties.lifecycle	JobExecutionLifecycle	Der detaillierte Zustand der Auftragsausführung.
properties.provisioningState	ProvisioningState	Der ARM-Bereitstellungsstatus der Auftragsausführung.
properties.startTime	string	Die Zeit, zu der die Auftragsausführung gestartet wurde.
properties.stepId	integer	Die Auftragsschritt-ID.
properties.stepName	string	Der Name des Auftragsschritts.
properties.target	JobExecutionTarget	Das Ziel, auf dem diese Ausführung ausgeführt wird.
type	string	Der Ressourcentyp.

JobExecutionLifecycle

Der detaillierte Zustand der Auftragsausführung.

Name	Typ	Beschreibung
Canceled	string
Created	string
Failed	string
InProgress	string
Skipped	string
Succeeded	string
SucceededWithSkipped	string
TimedOut	string
WaitingForChildJobExecutions	string
WaitingForRetry	string

JobExecutionListResult

Eine Liste der Auftragsausführungen.

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Ergebnisseite.
value	JobExecution[]	Array von Ergebnissen.

JobExecutionTarget

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

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

JobTargetType

Der Typ des Ziels.

Name	Typ	Beschreibung
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

ProvisioningState

Der ARM-Bereitstellungsstatus der Auftragsausführung.

Name	Typ	Beschreibung
Canceled	string
Created	string
Failed	string
InProgress	string
Succeeded	string

Freigeben über

Job Step Executions - List By Job Execution

URI-Parameter

Antworten

Beispiele

List job step executions

Beispielanforderung

Beispiel für eine Antwort

Definitionen

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Zusätzliche Ressourcen