Job Steps - Create Or Update

  • Odwołanie
Service:
SQL Database
API Version:
2021-11-01

Tworzy lub aktualizuje krok zadania. Spowoduje to niejawne utworzenie nowej wersji zadania.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
jobAgentName
 path True

string

Nazwa agenta zadania.
jobName
 path True

string

Nazwa zadania.
resourceGroupName
 path True

string

Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
serverName
 path True

string

Nazwa serwera.
stepName
 path True

string

Nazwa kroku zadania.
subscriptionId
 path True

string

Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version
 query True

string

Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa Wymagane Typ Opis
properties.action True

JobStepAction

Ładunek akcji kroku zadania.
properties.credential True

string

Identyfikator zasobu poświadczenia zadania, który będzie używany do nawiązywania połączenia z miejscami docelowymi.
properties.targetGroup True

string

Identyfikator zasobu grupy docelowej, na podstawie którego zostanie wykonany krok zadania.
properties.executionOptions

JobStepExecutionOptions

Opcje wykonywania dla kroku zadania.
properties.output

JobStepOutput

Wyjściowe właściwości miejsca docelowego kroku zadania.
properties.stepId

integer

Indeks kroku zadania w ramach zadania. Jeśli nie zostanie określony podczas tworzenia kroku zadania, zostanie utworzony jako ostatni krok. Jeśli nie zostanie określony podczas aktualizowania kroku zadania, identyfikator kroku nie zostanie zmodyfikowany.

Odpowiedzi

Nazwa Typ Opis
200 OK

JobStep

Pomyślnie zaktualizowano krok zadania.
201 Created

JobStep

Pomyślnie dodano krok zadania.
Other Status Codes

Odpowiedzi na błędy: ***

  • 400 JobStepIdMismatch — identyfikator kroku w określonym identyfikatorze URI kroku zadania nie jest zgodny z identyfikatorem kroku w podanym zasobie kroku zadania.

  • 400 InvalidResourceRequestBody — właściwości zasobu lub zasobu w treści żądania są puste lub nieprawidłowe.

  • 400 InvalidResourceId — nieprawidłowy identyfikator zasobu.

  • 400 NiezgodnośćSubscriptionWithUrl — podana subskrypcja nie jest zgodna z subskrypcją w adresie URL.

  • 400 MismatchingResourceGroupNameWithUrl — podana nazwa grupy zasobów nie jest zgodna z nazwą w adresie URL.

  • 400 NiezgodnośćServerNameWithUrl — podana nazwa serwera nie jest zgodna z nazwą w adresie URL.

  • 400 MismatchingJobAccountNameWithUrl — podana nazwa konta zadania nie jest zgodna z nazwą w adresie URL.

  • 400 ElasticJobsOperationFailed — operacja zarządzania zadaniami elastycznymi nie powiodła się.

  • 400 ElasticJobsOperationFailed — operacja zarządzania zadaniami elastycznymi nie powiodła się.

  • 404 JobAgentNotFound — określony agent zadania nie istnieje na określonym serwerze logicznym.

  • 404 ResourceNotFound — żądany zasób nie został znaleziony.

  • 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera

  • 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji.

Przykłady

Create or update a job step with all properties specified.
Create or update a job step with minimal properties specified.

Create or update a job step with all properties specified.

Sample Request

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

{
  "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
    }
  }
}

Sample Response

Status code:
200 
{
  "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/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}
Status code:
201 
{
  "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/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}

Create or update a job step with minimal properties specified.

Sample Request

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

{
  "properties": {
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "value": "select 1"
    }
  }
}

Sample Response

Status code:
200 
{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}
Status code:
201 
{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}

Definicje

Nazwa Opis
JobStep

Krok zadania.
JobStepAction

Akcja do wykonania przez krok zadania.
JobStepActionSource

Źródło akcji do wykonania.
JobStepActionType

Typ akcji wykonywanej przez krok zadania.
JobStepExecutionOptions

Opcje wykonywania kroku zadania.
JobStepOutput

Konfiguracja danych wyjściowych kroku zadania.
JobStepOutputType

Typ miejsca docelowego danych wyjściowych.

JobStep

Krok zadania.

Nazwa Typ Opis
id

string

Identyfikator zasobu.
name

string

Nazwa zasobu.
properties.action

JobStepAction

Ładunek akcji kroku zadania.
properties.credential

string

Identyfikator zasobu poświadczenia zadania, który będzie używany do nawiązywania połączenia z miejscami docelowymi.
properties.executionOptions

JobStepExecutionOptions

Opcje wykonywania dla kroku zadania.
properties.output

JobStepOutput

Wyjściowe właściwości miejsca docelowego kroku zadania.
properties.stepId

integer

Indeks kroku zadania w ramach zadania. Jeśli nie zostanie określony podczas tworzenia kroku zadania, zostanie utworzony jako ostatni krok. Jeśli nie zostanie określony podczas aktualizowania kroku zadania, identyfikator kroku nie zostanie zmodyfikowany.
properties.targetGroup

string

Identyfikator zasobu grupy docelowej, na podstawie którego zostanie wykonany krok zadania.
type

string

Typ zasobu.

JobStepAction

Akcja do wykonania przez krok zadania.

Nazwa Typ Wartość domyślna Opis
source

JobStepActionSource

Inline

Źródło akcji do wykonania.
type

JobStepActionType

TSql

Typ akcji wykonywanej przez krok zadania.
value

string

Wartość akcji, na przykład tekst skryptu T-SQL do wykonania.

JobStepActionSource

Źródło akcji do wykonania.

Nazwa Typ Opis
Inline

string

JobStepActionType

Typ akcji wykonywanej przez krok zadania.

Nazwa Typ Opis
TSql

string

JobStepExecutionOptions

Opcje wykonywania kroku zadania.

Nazwa Typ Wartość domyślna Opis
initialRetryIntervalSeconds

integer

1

Początkowe opóźnienie między kolejnymi próbami wykonania kroku zadania.
maximumRetryIntervalSeconds

integer

120

Maksymalny czas oczekiwania między kolejnymi próbami wykonania kroku zadania.
retryAttempts

integer

10

Maksymalna liczba powtórzeń kroku zadania w przypadku niepowodzenia pierwszej próby.
retryIntervalBackoffMultiplier

number

2

Mnożnik wycofywania dla czasu między ponawianiami prób.
timeoutSeconds

integer

43200

Limit czasu wykonywania dla kroku zadania.

JobStepOutput

Konfiguracja danych wyjściowych kroku zadania.

Nazwa Typ Wartość domyślna Opis
credential

string

Identyfikator zasobu poświadczenia do użycia w celu nawiązania połączenia z wyjściowym miejscem docelowym.
databaseName

string

Wyjściowa docelowa baza danych.
resourceGroupName

string

Wyjściowa docelowa grupa zasobów.
schemaName

string

dbo

Schemat docelowy danych wyjściowych.
serverName

string

Nazwa wyjściowego serwera docelowego.
subscriptionId

string

Wyjściowy identyfikator subskrypcji docelowej.
tableName

string

Tabela docelowa danych wyjściowych.
type

JobStepOutputType

SqlDatabase

Typ miejsca docelowego danych wyjściowych.

JobStepOutputType

Typ miejsca docelowego danych wyjściowych.

Nazwa Typ Opis
SqlDatabase

string