Job Steps - List By Version

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-08-01-preview

URI-parametrar

Name In Required Type 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

Det prenumerations-ID som identifierar en Azure-prenumeration.

api-version
query True
  • string

DEN API-version som ska användas för begäran.

Svar

Name Type Description
200 OK

Listan över jobbsteg har hämtats.

Other Status Codes

Felsvar: ***

  • 404 JobAgentNotFound – Den angivna jobbagenten 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.

Sample Request

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-08-01-preview

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/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

JobStep

Ett jobbsteg.

JobStepAction

Den åtgärd som ska utföras av ett jobbsteg.

JobStepActionSource

Källan för å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

Måltypen för utdata.

JobStep

Ett jobbsteg.

Name Type Description
id
  • string

Resurs-ID.

name
  • string

Resursnamn.

properties.action

Å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

Körningsalternativ för jobbsteget.

properties.output

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 vid uppdatering av jobbsteget ändras inte steg-ID:t.

properties.targetGroup
  • string

Resurs-ID för målgruppen som jobbsteget ska köras på.

type
  • string

Resurstyp.

JobStepAction

Den åtgärd som ska utföras av ett jobbsteg.

Name Type Default Value Description
source Inline

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

type TSql

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

value
  • string

Åtgärdsvärdet, till exempel texten i T-SQL skript som ska köras.

JobStepActionSource

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

Name Type Description
Inline
  • string

JobStepActionType

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

Name Type Description
TSql
  • string

JobStepExecutionOptions

Körningsalternativen för ett jobbsteg.

Name Type Default Value Description
initialRetryIntervalSeconds
  • integer
1

Inledande fördröjning mellan återförsök för körning av jobbsteg.

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ök.

timeoutSeconds
  • integer
43200

Körningstimeout för jobbsteget.

JobStepListResult

En lista över jobbsteg.

Name Type Description
nextLink
  • string

Länk för att hämta nästa sida med resultat.

value

Matris med resultat.

JobStepOutput

Utdatakonfigurationen för ett jobbsteg.

Name Type Default Value Description
credential
  • string

Resurs-ID för autentiseringsuppgifterna som ska användas för att ansluta till utdatamålet.

databaseName
  • string

Måldatabasen för utdata.

resourceGroupName
  • string

Målresursgruppen för utdata.

schemaName
  • string
dbo

Utdatamålschemat.

serverName
  • string

Namnet på målservern för utdata.

subscriptionId
  • string

Utdatamålets prenumerations-ID.

tableName
  • string

Utdatamåltabellen.

type SqlDatabase

Måltypen för utdata.

JobStepOutputType

Måltypen för utdata.

Name Type Description
SqlDatabase
  • string