Job Steps - Create Or Update

Referens

Service:: SQL Database

API Version:: 2021-11-01

Skapar eller uppdaterar ett jobbsteg. Detta skapar implicit en ny jobbversion.

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

Name	I	Obligatorisk	Typ	Description
jobAgentName	path	True	string	Namnet på jobbagenten.
jobName	path	True	string	Namnet på jobbet.
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.
stepName	path	True	string	Namnet på jobbsteget.
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.

Begärandetext

Name	Obligatorisk	Typ	Description
properties.action	True	JobStepAction	Åtgärdsnyttolasten för jobbsteget.
properties.credential	True	string	Resurs-ID för jobbautentiseringsuppgifterna som ska användas för att ansluta till målen.
properties.targetGroup	True	string	Resurs-ID för målgruppen som jobbsteget ska köras på.
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 vid uppdatering av jobbsteget ändras inte steg-ID:t.

Svar

Name	Typ	Description
200 OK	JobStep	Jobbsteget har uppdaterats.
201 Created	JobStep	Jobbsteget har lagts till.
Other Status Codes		Felsvar: *** 400 JobStepIdMismatch – Steg-ID i den angivna jobbstegs-URI:n matchar inte steg-ID:t i den angivna jobbstegsresursen. 400 InvalidResourceRequestBody – Resurs- eller resursegenskaperna i begärandetexten är tomma eller ogiltiga. 400 InvalidResourceId – Ogiltig resursidentifierare. 400 MismatchingSubscriptionWithUrl – den angivna prenumerationen matchade inte prenumerationen i URL:en. 400 MismatchingResourceGroupNameWithUrl – Det angivna resursgruppsnamnet matchade inte namnet i URL:en. 400 MismatchingServerNameWithUrl – det angivna servernamnet matchade inte namnet i URL:en. 400 MismatchingJobAccountNameWithUrl – Det angivna jobbkontonamnet matchade inte namnet i URL:en. 400 ElasticJobsOperationFailed – Det gick inte att hantera elastiska jobb. 400 ElasticJobsOperationFailed – Det gick inte att hantera elastiska jobb. 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.

Name

Typ

Description

200 OK

JobStep

Jobbsteget har uppdaterats.

201 Created

JobStep

Jobbsteget har lagts till.

Other Status Codes

Felsvar: ***

400 JobStepIdMismatch – Steg-ID i den angivna jobbstegs-URI:n matchar inte steg-ID:t i den angivna jobbstegsresursen.
400 InvalidResourceRequestBody – Resurs- eller resursegenskaperna i begärandetexten är tomma eller ogiltiga.
400 InvalidResourceId – Ogiltig resursidentifierare.
400 MismatchingSubscriptionWithUrl – den angivna prenumerationen matchade inte prenumerationen i URL:en.
400 MismatchingResourceGroupNameWithUrl – Det angivna resursgruppsnamnet matchade inte namnet i URL:en.
400 MismatchingServerNameWithUrl – det angivna servernamnet matchade inte namnet i URL:en.
400 MismatchingJobAccountNameWithUrl – Det angivna jobbkontonamnet matchade inte namnet i URL:en.
400 ElasticJobsOperationFailed – Det gick inte att hantera elastiska jobb.
400 ElasticJobsOperationFailed – Det gick inte att hantera elastiska jobb.
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

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.core.util.Context;
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)),
            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

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

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.core.util.Context;
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")),
            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

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

Definitioner

Name	Description
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.
JobStepOutput	Utdatakonfigurationen för ett jobbsteg.
JobStepOutputType	Måltypen för utdata.

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 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	Typ	Standardvärde	Description
source	JobStepActionSource	Inline	Källan för å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 för å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 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.

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		Måldatabasen för utdata.
resourceGroupName	string		Målresursgruppen för utdata.
schemaName	string	dbo	Utdatamålschemat.
serverName	string		Namnet på utdatamålservern.
subscriptionId	string		Utdatamålets prenumerations-ID.
tableName	string		Utdatamåltabellen.
type	JobStepOutputType	SqlDatabase	Måltypen för utdata.

JobStepOutputType

Måltypen för utdata.

Name	Typ	Description
SqlDatabase	string

Job Steps - Create Or Update

URI-parametrar

Begärandetext

Svar

Exempel

Create or update a job step with all properties specified.

Sample Request

Sample Response

Create or update a job step with minimal properties specified.

Sample Request

Sample Response

Definitioner

JobStep

JobStepAction

JobStepActionSource

JobStepActionType

JobStepExecutionOptions

JobStepOutput

JobStepOutputType

Ytterligare resurser