Job Steps - Create Or Update

Referenz

Dienst:: SQL Database

API-Version:: 2021-11-01

Erstellt oder aktualisiert einen Auftragsschritt. Dadurch wird implizit eine neue Auftragsversion erstellt.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
jobAgentName	path	True	string	Der Name des Auftrags-Agents.
jobName	path	True	string	Der Name des Auftrags.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
stepName	path	True	string	Der Name des Auftragsschritts.
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.action	True	JobStepAction	Die Aktionsnutzlast des Auftragsschritts.
properties.credential	True	string	Die Ressourcen-ID der Auftragsanmeldeinformationen, die zum Herstellen einer Verbindung mit den Zielen verwendet werden.
properties.targetGroup	True	string	Die Ressourcen-ID der Zielgruppe, für die der Auftragsschritt ausgeführt wird.
properties.executionOptions		JobStepExecutionOptions	Ausführungsoptionen für den Auftragsschritt.
properties.output		JobStepOutput	Ausgabezieleigenschaften des Auftragsschritts.
properties.stepId		integer	Der Index des Auftragsschritts innerhalb des Auftrags. Wenn beim Erstellen des Auftragsschritts nicht angegeben wird, wird er als letzter Schritt erstellt. Wenn beim Aktualisieren des Auftragsschritts nicht angegeben wird, wird die Schritt-ID nicht geändert.

Antworten

Name	Typ	Beschreibung
200 OK	JobStep	Der Auftragsschritt wurde erfolgreich aktualisiert.
201 Created	JobStep	Der Auftragsschritt wurde erfolgreich hinzugefügt.
Other Status Codes		Fehlerantworten: *** 400 JobStepIdMismatch: Schritt-ID im angegebenen Auftragsschritt-URI stimmt nicht mit der Schritt-ID in der angegebenen Auftragsschrittressource überein. 400 InvalidResourceRequestBody: Die Ressourcen- oder Ressourceneigenschaften im Anforderungstext sind leer oder ungültig. 400 InvalidResourceId: Ungültiger Ressourcenbezeichner. 400 MismatchingSubscriptionWithUrl: Das bereitgestellte Abonnement stimmte nicht mit dem Abonnement in der URL überein. 400 MismatchingResourceGroupNameWithUrl: Der angegebene Ressourcengruppenname stimmte nicht mit dem Namen in der URL überein. 400 MismatchingServerNameWithUrl: Der angegebene Servername stimmte nicht mit dem Namen in der URL überein. 400 MismatchingJobAccountNameWithUrl: Der angegebene Auftragskontoname stimmte nicht mit dem Namen in der URL überein. 400 ElasticJobsOperationFailed: Fehler bei der Verwaltung elastischer Aufträge. 400 ElasticJobsOperationFailed: Fehler bei der Verwaltung elastischer Aufträge. 404 JobAgentNotFound: Der angegebene Auftrags-Agent ist auf dem angegebenen logischen Server nicht vorhanden. 404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden. 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

Name

Typ

Beschreibung

200 OK

JobStep

Der Auftragsschritt wurde erfolgreich aktualisiert.

201 Created

JobStep

Der Auftragsschritt wurde erfolgreich hinzugefügt.

Other Status Codes

Fehlerantworten: ***

400 JobStepIdMismatch: Schritt-ID im angegebenen Auftragsschritt-URI stimmt nicht mit der Schritt-ID in der angegebenen Auftragsschrittressource überein.
400 InvalidResourceRequestBody: Die Ressourcen- oder Ressourceneigenschaften im Anforderungstext sind leer oder ungültig.
400 InvalidResourceId: Ungültiger Ressourcenbezeichner.
400 MismatchingSubscriptionWithUrl: Das bereitgestellte Abonnement stimmte nicht mit dem Abonnement in der URL überein.
400 MismatchingResourceGroupNameWithUrl: Der angegebene Ressourcengruppenname stimmte nicht mit dem Namen in der URL überein.
400 MismatchingServerNameWithUrl: Der angegebene Servername stimmte nicht mit dem Namen in der URL überein.
400 MismatchingJobAccountNameWithUrl: Der angegebene Auftragskontoname stimmte nicht mit dem Namen in der URL überein.
400 ElasticJobsOperationFailed: Fehler bei der Verwaltung elastischer Aufträge.
400 ElasticJobsOperationFailed: Fehler bei der Verwaltung elastischer Aufträge.
404 JobAgentNotFound: Der angegebene Auftrags-Agent ist auf dem angegebenen logischen Server nicht vorhanden.
404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden.
404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden
404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

Beispiele

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.

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


import com.azure.resourcemanager.sql.fluent.models.JobStepInner;
import com.azure.resourcemanager.sql.models.JobStepAction;
import com.azure.resourcemanager.sql.models.JobStepActionSource;
import com.azure.resourcemanager.sql.models.JobStepActionType;
import com.azure.resourcemanager.sql.models.JobStepExecutionOptions;
import com.azure.resourcemanager.sql.models.JobStepOutput;
import com.azure.resourcemanager.sql.models.JobStepOutputType;
import java.util.UUID;

/**
 * Samples for JobSteps CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateJobStepMax.json
     */
    /**
     * Sample code: Create or update a job step with all properties specified.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createOrUpdateAJobStepWithAllPropertiesSpecified(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobSteps().createOrUpdateWithResponse("group1", "server1",
            "agent1", "job1", "step1",
            new JobStepInner().withStepId(1).withTargetGroup(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1")
                .withCredential("fakeTokenPlaceholder")
                .withAction(new JobStepAction().withType(JobStepActionType.TSQL).withSource(JobStepActionSource.INLINE)
                    .withValue("select 2"))
                .withOutput(new JobStepOutput().withType(JobStepOutputType.SQL_DATABASE)
                    .withSubscriptionId(UUID.fromString("3501b905-a848-4b5d-96e8-b253f62d735a"))
                    .withResourceGroupName("group3").withServerName("server3").withDatabaseName("database3")
                    .withSchemaName("myschema1234").withTableName("mytable5678").withCredential("fakeTokenPlaceholder"))
                .withExecutionOptions(new JobStepExecutionOptions().withTimeoutSeconds(1234).withRetryAttempts(42)
                    .withInitialRetryIntervalSeconds(11).withMaximumRetryIntervalSeconds(222)
                    .withRetryIntervalBackoffMultiplier(3.0F)),
            com.azure.core.util.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

Beispiel für eine Antwort

Statuscode:: 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"
}

Statuscode:: 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.

Beispielanforderung

HTTP
Java

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


import com.azure.resourcemanager.sql.fluent.models.JobStepInner;
import com.azure.resourcemanager.sql.models.JobStepAction;

/**
 * Samples for JobSteps CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateJobStepMin.json
     */
    /**
     * Sample code: Create or update a job step with minimal properties specified.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createOrUpdateAJobStepWithMinimalPropertiesSpecified(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobSteps().createOrUpdateWithResponse("group1", "server1",
            "agent1", "job1", "step1",
            new JobStepInner().withTargetGroup(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0")
                .withCredential("fakeTokenPlaceholder").withAction(new JobStepAction().withValue("select 1")),
            com.azure.core.util.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

Beispiel für eine Antwort

Statuscode:: 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"
}

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
JobStep	Ein Auftragsschritt.
JobStepAction	Die Aktion, die von einem Auftragsschritt ausgeführt werden soll.
JobStepActionSource	Die Quelle der auszuführenden Aktion.
JobStepActionType	Art der Aktion, die vom Auftragsschritt ausgeführt wird.
JobStepExecutionOptions	Die Ausführungsoptionen eines Auftragsschritts.
JobStepOutput	Die Ausgabekonfiguration eines Auftragsschritts.
JobStepOutputType	Der Ausgabezieltyp.

JobStep

Ein Auftragsschritt.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
name	string	Name der Ressource.
properties.action	JobStepAction	Die Aktionsnutzlast des Auftragsschritts.
properties.credential	string	Die Ressourcen-ID der Auftragsanmeldeinformationen, die zum Herstellen einer Verbindung mit den Zielen verwendet werden.
properties.executionOptions	JobStepExecutionOptions	Ausführungsoptionen für den Auftragsschritt.
properties.output	JobStepOutput	Ausgabezieleigenschaften des Auftragsschritts.
properties.stepId	integer	Der Index des Auftragsschritts innerhalb des Auftrags. Wenn beim Erstellen des Auftragsschritts nicht angegeben wird, wird er als letzter Schritt erstellt. Wenn beim Aktualisieren des Auftragsschritts nicht angegeben wird, wird die Schritt-ID nicht geändert.
properties.targetGroup	string	Die Ressourcen-ID der Zielgruppe, für die der Auftragsschritt ausgeführt wird.
type	string	Der Ressourcentyp.

JobStepAction

Die Aktion, die von einem Auftragsschritt ausgeführt werden soll.

Name	Typ	Standardwert	Beschreibung
source	JobStepActionSource	Inline	Die Quelle der auszuführenden Aktion.
type	JobStepActionType	TSql	Art der Aktion, die vom Auftragsschritt ausgeführt wird.
value	string		Der Aktionswert, z. B. der Text des auszuführenden T-SQL-Skripts.

JobStepActionSource

Die Quelle der auszuführenden Aktion.

Name	Typ	Beschreibung
Inline	string

JobStepActionType

Art der Aktion, die vom Auftragsschritt ausgeführt wird.

Name	Typ	Beschreibung
TSql	string

JobStepExecutionOptions

Die Ausführungsoptionen eines Auftragsschritts.

Name	Typ	Standardwert	Beschreibung
initialRetryIntervalSeconds	integer	1	Anfängliche Verzögerung zwischen Wiederholungen für die Ausführung des Auftragsschritts.
maximumRetryIntervalSeconds	integer	120	Die maximale Wartezeit zwischen Wiederholungen für die Ausführung des Auftragsschritts.
retryAttempts	integer	10	Die maximale Anzahl der Wiederholungen des Auftragsschritts, wenn der erste Versuch fehlschlägt.
retryIntervalBackoffMultiplier	number	2	Der Backoff-Multiplikator für die Zeit zwischen Wiederholungen.
timeoutSeconds	integer	43200	Ausführungstimeout für den Auftragsschritt.

JobStepOutput

Die Ausgabekonfiguration eines Auftragsschritts.

Name	Typ	Standardwert	Beschreibung
credential	string		Die Ressourcen-ID der Anmeldeinformationen, die zum Herstellen einer Verbindung mit dem Ausgabeziel verwendet werden sollen.
databaseName	string		Die Ausgabezieldatenbank.
resourceGroupName	string		Die Ausgabezielressourcengruppe.
schemaName	string	dbo	Das Zielschema der Ausgabe.
serverName	string		Der Name des Ausgabezielservers.
subscriptionId	string		Die ID des Ausgabezielabonnements.
tableName	string		Die Ausgabezieltabelle.
type	JobStepOutputType	SqlDatabase	Der Ausgabezieltyp.

JobStepOutputType

Der Ausgabezieltyp.

Name	Typ	Beschreibung
SqlDatabase	string

Freigeben über

Job Steps - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create or update a job step with all properties specified.

Beispielanforderung

Beispiel für eine Antwort

Create or update a job step with minimal properties specified.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

JobStep

JobStepAction

JobStepActionSource

JobStepActionType

JobStepExecutionOptions

JobStepOutput

JobStepOutputType

Zusätzliche Ressourcen