Job Target Executions - List By Step

Referens

Service:: SQL Database

API Version:: 2021-11-01

Listor målkörningarna för en jobbstegskörning.

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

With optional parameters:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
jobAgentName	path	True	string	Namnet på jobbagenten.
jobExecutionId	path	True	string uuid	Jobbkörningens ID
jobName	path	True	string	Namnet på jobbet som ska hämtas.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName	path	True	string	Namnet på servern.
stepName	path	True	string	Namnet på steget.
subscriptionId	path	True	string	Prenumerations-ID:t som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.
$skip	query		integer int64	Antalet element i samlingen som ska hoppa över.
$top	query		integer int64	Antalet element som ska returneras från samlingen.
createTimeMax	query		string date-time	Om det anges inkluderas endast jobbkörningar som skapats före den angivna tiden.
createTimeMin	query		string date-time	Om det anges inkluderas endast jobbkörningar som skapats vid eller efter den angivna tiden.
endTimeMax	query		string date-time	Om det anges slutförs endast jobbkörningar innan den angivna tiden inkluderas.
endTimeMin	query		string date-time	Om det anges inkluderas endast jobbkörningar som slutförts vid eller efter den angivna tiden.
isActive	query		boolean	Om det anges inkluderas endast aktiva eller endast slutförda jobbkörningar.

Svar

Name	Typ	Description
200 OK	JobExecutionListResult	Målkörningarna har hämtats.
Other Status Codes		Felsvar: *** 404 JobAgentNotFound – Angiven jobbagent finns inte på den angivna logiska servern. 404 ResourceNotFound – Den begärda resursen hittades inte. 404 SubscriptionDoesNotHaveServer – den begärda servern hittades inte 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.

Name

Typ

Description

200 OK

JobExecutionListResult

Målkörningarna har hämtats.

Other Status Codes

Felsvar: ***

404 JobAgentNotFound – Angiven jobbagent finns inte på den angivna logiska servern.
404 ResourceNotFound – Den begärda resursen hittades inte.
404 SubscriptionDoesNotHaveServer – den begärda servern hittades inte
404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.

Exempel

List job step target 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/step1/targets?api-version=2021-11-01


import com.azure.core.util.Context;
import java.util.UUID;

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "stepName": "step1",
        "stepId": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-07-01T04:33:17.5133333Z",
        "startTime": "2017-07-01T04:33:18.1230403Z",
        "endTime": "2017-07-01T04:33:18.7031029Z",
        "currentAttempts": 1,
        "currentAttemptStartTime": "2017-07-01T04:33:18.2391013Z",
        "lastMessage": "Step 1 succeeded execution on target (server 'server1', database 'database1').",
        "target": {
          "type": "SqlDatabase",
          "serverName": "server1",
          "databaseName": "database1"
        }
      },
      "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/targets/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets"
    }
  ]
}

Definitioner

Name	Description
JobExecution	En körning av ett jobb
JobExecutionLifecycle	Det detaljerade tillståndet för jobbkörningen.
JobExecutionListResult	En lista över jobbkörningar.
JobExecutionTarget	Målet som en jobbkörning körs på.
JobTargetType	Typ av mål.
ProvisioningState	ARM-etableringstillståndet för jobbkörningen.

JobExecution

En körning av ett jobb

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.createTime	string	Den tid då jobbkörningen skapades.
properties.currentAttemptStartTime	string	Starttiden för det aktuella försöket.
properties.currentAttempts	integer	Antal gånger som jobbkörningen har försökts.
properties.endTime	string	Den tid då jobbkörningen slutfördes.
properties.jobExecutionId	string	Den unika identifieraren för jobbkörningen.
properties.jobVersion	integer	Jobbversionsnumret.
properties.lastMessage	string	Den senaste statusen eller felmeddelandet.
properties.lifecycle	JobExecutionLifecycle	Det detaljerade tillståndet för jobbkörningen.
properties.provisioningState	ProvisioningState	ARM-etableringstillståndet för jobbkörningen.
properties.startTime	string	Tiden då jobbkörningen startade.
properties.stepId	integer	Jobbets steg-ID.
properties.stepName	string	Jobbstegets namn.
properties.target	JobExecutionTarget	Det mål som den här körningen körs på.
type	string	Resurstyp.

JobExecutionLifecycle

Det detaljerade tillståndet för jobbkörningen.

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

JobExecutionListResult

En lista över jobbkörningar.

Name	Typ	Description
nextLink	string	Länka för att hämta nästa sida med resultat.
value	JobExecution[]	Matris med resultat.

JobExecutionTarget

Målet som en jobbkörning körs på.

Name	Typ	Description
databaseName	string	Databasnamnet.
serverName	string	Servernamnet.
type	JobTargetType	Typ av mål.

JobTargetType

Typ av mål.

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

ProvisioningState

ARM-etableringstillståndet för jobbkörningen.

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

Job Target Executions - List By Step

URI-parametrar

Svar

Exempel

List job step target executions

Sample Request

Sample Response

Definitioner

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

Ytterligare resurser