Job Steps - List By Job

Odwołanie

Service:: SQL Database

API Version:: 2021-11-01

Pobiera wszystkie kroki zadania dla bieżącej wersji zadania.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps?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 do pobrania.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	JobStepListResult	Pomyślnie pobrano listę kroków zadania.
Other Status Codes		Odpowiedzi na błędy: *** 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.

Nazwa

Typ

Opis

200 OK

JobStepListResult

Pomyślnie pobrano listę kroków zadania.

Other Status Codes

Odpowiedzi na błędy: ***

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

List job steps for the latest 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/steps?api-version=2021-11-01


import com.azure.core.util.Context;

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

Definicje

Nazwa	Opis
JobStep	Krok zadania.
JobStepAction	Akcja do wykonania za pomocą kroku zadania.
JobStepActionSource	Źródło akcji do wykonania.
JobStepActionType	Typ akcji wykonywanej przez krok zadania.
JobStepExecutionOptions	Opcje wykonywania kroku zadania.
JobStepListResult	Lista kroków zadania.
JobStepOutput	Konfiguracja wyjściowa 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 obiektami docelowymi.
properties.executionOptions	JobStepExecutionOptions	Opcje wykonywania dla kroku zadania.
properties.output	JobStepOutput	Wyjściowe właściwości docelowe kroku zadania.
properties.stepId	integer	Indeks kroku zadania w zadaniu. Jeśli nie zostanie określony podczas tworzenia kroku zadania, zostanie on 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 którą zostanie wykonany krok zadania.
type	string	Typ zasobu.

JobStepAction

Akcja do wykonania za pomocą kroku 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 ponowną próbą wykonania kroku zadania.
maximumRetryIntervalSeconds	integer	120	Maksymalny czas oczekiwania między ponowną próbą wykonania kroku zadania.
retryAttempts	integer	10	Maksymalna liczba przypadków ponownego przypisania kroku zadania, jeśli pierwsza próba zakończy się niepowodzeniem.
retryIntervalBackoffMultiplier	number	2	Mnożnik wycofywania czasu między ponawianiami prób.
timeoutSeconds	integer	43200	Limit czasu wykonywania dla kroku zadania.

JobStepListResult

Lista kroków zadania.

Nazwa	Typ	Opis
nextLink	string	Link, aby pobrać następną stronę wyników.
value	JobStep[]	Tablica wyników.

JobStepOutput

Konfiguracja wyjściowa kroku zadania.

Nazwa	Typ	Wartość domyślna	Opis
credential	string		Identyfikator zasobu poświadczenia do użycia w celu nawiązania połączenia z miejscem docelowym danych wyjściowych.
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

Job Steps - List By Job

Parametry identyfikatora URI

Odpowiedzi

Przykłady

List job steps for the latest version of a job.

Sample Request

Sample Response

Definicje

JobStep

JobStepAction

JobStepActionSource

JobStepActionType

JobStepExecutionOptions

JobStepListResult

JobStepOutput

JobStepOutputType

Dodatkowe zasoby