Job Steps - List By Version

Referens

Service:: SQL Database

API Version:: 2021-11-01

Hämtar alla jobbsteg i den angivna jobbversionen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
jobAgentName	path	True	string	Namnet på jobbagenten.
jobName	path	True	string	Namnet på jobbet som ska hämtas.
jobVersion	path	True	integer int32	Den version av 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.
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.

Svar

Name	Typ	Description
200 OK	JobStepListResult	Listan över jobbsteg 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

JobStepListResult

Listan över jobbsteg 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 steps for the specified version of a job.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/versions/1/steps?api-version=2021-11-01


import com.azure.core.util.Context;

/** Samples for JobSteps ListByVersion. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobStepsByVersion.json
     */
    /**
     * Sample code: List job steps for the specified version of a job.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobStepsForTheSpecifiedVersionOfAJob(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobSteps().listByVersion("group1", "server1", "agent1", "job1",
            1, 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": {
        "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/versions/1/steps/step1",
      "name": "step1",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/versions/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/versions/1/steps/step2",
      "name": "step2",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/versions/steps"
    }
  ]
}

Definitioner

Name	Description
JobStep	Ett jobbsteg.
JobStepAction	Åtgärden som ska köras med ett jobbsteg.
JobStepActionSource	Källan till åtgärden som ska köras.
JobStepActionType	Typ av åtgärd som körs av jobbsteget.
JobStepExecutionOptions	Körningsalternativen för ett jobbsteg.
JobStepListResult	En lista över jobbsteg.
JobStepOutput	Utdatakonfigurationen för ett jobbsteg.
JobStepOutputType	Utdatamåltypen.

JobStep

Ett jobbsteg.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.action	JobStepAction	Åtgärdsnyttolasten för jobbsteget.
properties.credential	string	Resurs-ID för jobbautentiseringsuppgifterna som ska användas för att ansluta till målen.
properties.executionOptions	JobStepExecutionOptions	Körningsalternativ för jobbsteget.
properties.output	JobStepOutput	Utdatamålegenskaper för jobbsteget.
properties.stepId	integer	Jobbstegets index i jobbet. Om det inte anges när du skapar jobbsteget skapas det som det sista steget. Om inget anges när jobbsteget uppdateras ändras inte steg-ID:t.
properties.targetGroup	string	Resurs-ID för den målgrupp som jobbsteget ska köras på.
type	string	Resurstyp.

JobStepAction

Åtgärden som ska köras med ett jobbsteg.

Name	Typ	Standardvärde	Description
source	JobStepActionSource	Inline	Källan till åtgärden som ska köras.
type	JobStepActionType	TSql	Typ av åtgärd som körs av jobbsteget.
value	string		Åtgärdsvärdet, till exempel texten i T-SQL-skriptet som ska köras.

JobStepActionSource

Källan till åtgärden som ska köras.

Name	Typ	Description
Inline	string

JobStepActionType

Typ av åtgärd som körs av jobbsteget.

Name	Typ	Description
TSql	string

JobStepExecutionOptions

Körningsalternativen för ett jobbsteg.

Name	Typ	Standardvärde	Description
initialRetryIntervalSeconds	integer	1	Inledande fördröjning mellan återförsök för jobbstegskörning.
maximumRetryIntervalSeconds	integer	120	Den maximala väntetiden mellan återförsök för jobbstegskörning.
retryAttempts	integer	10	Maximalt antal gånger som jobbsteget försöker igen om det första försöket misslyckas.
retryIntervalBackoffMultiplier	number	2	Backoff-multiplikatorn för tiden mellan återförsöken.
timeoutSeconds	integer	43200	Körningstimeout för jobbsteget.

JobStepListResult

En lista över jobbsteg.

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

JobStepOutput

Utdatakonfigurationen för ett jobbsteg.

Name	Typ	Standardvärde	Description
credential	string		Resurs-ID för autentiseringsuppgifterna som ska användas för att ansluta till utdatamålet.
databaseName	string		Utdatamåldatabasen.
resourceGroupName	string		Utdatamålresursgruppen.
schemaName	string	dbo	Utdatamålschemat.
serverName	string		Utdatamålserverns namn.
subscriptionId	string		Utdatamålprenumerations-ID.
tableName	string		Utdatamåltabellen.
type	JobStepOutputType	SqlDatabase	Utdatamåltypen.

JobStepOutputType

Utdatamåltypen.

Name	Typ	Description
SqlDatabase	string

Job Steps - List By Version

URI-parametrar

Svar

Exempel

List job steps for the specified version of a job.

Sample Request

Sample Response

Definitioner

JobStep

JobStepAction

JobStepActionSource

JobStepActionType

JobStepExecutionOptions

JobStepListResult

JobStepOutput

JobStepOutputType

Ytterligare resurser