Job Steps - Create Or Update

Dienst:: SQL Database

API-Version:: 2025-01-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=2025-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
jobAgentName	path	True	string	Der Name des Auftragsagenten.
jobName	path	True	string	Der Name des Auftrags.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName	path	True	string	Name des Servers
stepName	path	True	string	Der Name des Auftragsschritts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.action	True	JobStepAction	Die Aktionsnutzlast des Auftragsschritts.
properties.targetGroup	True	string	Die Ressourcen-ID der Zielgruppe, für die der Auftragsschritt ausgeführt wird.
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 (int32)	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 die Schritt-ID nicht geändert.

Antworten

Name	Typ	Beschreibung
200 OK	JobStep	Die Aktualisierungsoperation der Ressource 'JobStep' war erfolgreich
201 Created	JobStep	Die Erstellungsoperation der Ressource 'JobStep' war erfolgreich
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

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.

Beispielanforderung

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=2025-01-01

{
  "properties": {
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "executionOptions": {
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryAttempts": 42,
      "retryIntervalBackoffMultiplier": 3,
      "timeoutSeconds": 1234
    },
    "output": {
      "type": "SqlDatabase",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
      "databaseName": "database3",
      "resourceGroupName": "group3",
      "schemaName": "myschema1234",
      "serverName": "server3",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "tableName": "mytable5678"
    },
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1"
  }
}


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: 2025-01-01/CreateOrUpdateJobStepMax.json
     */
    /**
     * Sample code: Create or update a job step with all properties specified.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        createOrUpdateAJobStepWithAllPropertiesSpecified(com.azure.resourcemanager.sql.SqlServerManager manager) {
        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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python create_or_update_job_step_max.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.job_steps.create_or_update(
        resource_group_name="group1",
        server_name="server1",
        job_agent_name="agent1",
        job_name="job1",
        step_name="step1",
        parameters={
            "properties": {
                "action": {"source": "Inline", "type": "TSql", "value": "select 2"},
                "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
                "executionOptions": {
                    "initialRetryIntervalSeconds": 11,
                    "maximumRetryIntervalSeconds": 222,
                    "retryAttempts": 42,
                    "retryIntervalBackoffMultiplier": 3,
                    "timeoutSeconds": 1234,
                },
                "output": {
                    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
                    "databaseName": "database3",
                    "resourceGroupName": "group3",
                    "schemaName": "myschema1234",
                    "serverName": "server3",
                    "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
                    "tableName": "mytable5678",
                    "type": "SqlDatabase",
                },
                "stepId": 1,
                "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
            }
        },
    )
    print(response)


# x-ms-original-file: 2025-01-01/CreateOrUpdateJobStepMax.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates or updates a job step. This will implicitly create a new job version.
 *
 * @summary creates or updates a job step. This will implicitly create a new job version.
 * x-ms-original-file: 2025-01-01/CreateOrUpdateJobStepMax.json
 */
async function createOrUpdateAJobStepWithAllPropertiesSpecified() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.jobSteps.createOrUpdate(
    "group1",
    "server1",
    "agent1",
    "job1",
    "step1",
    {
      action: { type: "TSql", source: "Inline", value: "select 2" },
      credential:
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
      executionOptions: {
        initialRetryIntervalSeconds: 11,
        maximumRetryIntervalSeconds: 222,
        retryAttempts: 42,
        retryIntervalBackoffMultiplier: 3,
        timeoutSeconds: 1234,
      },
      output: {
        type: "SqlDatabase",
        credential:
          "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
        databaseName: "database3",
        resourceGroupName: "group3",
        schemaName: "myschema1234",
        serverName: "server3",
        subscriptionId: "3501b905-a848-4b5d-96e8-b253f62d735a",
        tableName: "mytable5678",
      },
      stepId: 1,
      targetGroup:
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CreateOrUpdateJobStepMax.json
// this example is just showing the usage of "JobSteps_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerJobResource created on azure
// for more information of creating SqlServerJobResource, please refer to the document of SqlServerJobResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
string jobName = "job1";
ResourceIdentifier sqlServerJobResourceId = SqlServerJobResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName, jobName);
SqlServerJobResource sqlServerJob = client.GetSqlServerJobResource(sqlServerJobResourceId);

// get the collection of this SqlServerJobStepResource
SqlServerJobStepCollection collection = sqlServerJob.GetSqlServerJobSteps();

// invoke the operation
string stepName = "step1";
SqlServerJobStepData data = new SqlServerJobStepData
{
    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 = new JobStepAction("select 2")
    {
        ActionType = JobStepActionType.TSql,
        Source = JobStepActionSource.Inline,
    },
    Output = new JobStepOutput("server3", "database3", "mytable5678")
    {
        OutputType = JobStepOutputType.SqlDatabase,
        SubscriptionId = Guid.Parse("3501b905-a848-4b5d-96e8-b253f62d735a"),
        ResourceGroupName = "group3",
        SchemaName = "myschema1234",
        Credential = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    },
    ExecutionOptions = new JobStepExecutionOptions
    {
        TimeoutSeconds = 1234,
        RetryAttempts = 42,
        InitialRetryIntervalSeconds = 11,
        MaximumRetryIntervalSeconds = 222,
        RetryIntervalBackoffMultiplier = 3,
    },
};
ArmOperation<SqlServerJobStepResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, stepName, data);
SqlServerJobStepResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobStepData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "properties": {
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "executionOptions": {
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryAttempts": 42,
      "retryIntervalBackoffMultiplier": 3,
      "timeoutSeconds": 1234
    },
    "output": {
      "type": "SqlDatabase",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
      "databaseName": "database3",
      "resourceGroupName": "group3",
      "schemaName": "myschema1234",
      "serverName": "server3",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "tableName": "mytable5678"
    },
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1"
  }
}

Statuscode:: 201

{
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
  "properties": {
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 2"
    },
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
    "executionOptions": {
      "initialRetryIntervalSeconds": 11,
      "maximumRetryIntervalSeconds": 222,
      "retryAttempts": 42,
      "retryIntervalBackoffMultiplier": 3,
      "timeoutSeconds": 1234
    },
    "output": {
      "type": "SqlDatabase",
      "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
      "databaseName": "database3",
      "resourceGroupName": "group3",
      "schemaName": "myschema1234",
      "serverName": "server3",
      "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
      "tableName": "mytable5678"
    },
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1"
  }
}

Create or update a job step with minimal properties specified.

Beispielanforderung

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=2025-01-01

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


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: 2025-01-01/CreateOrUpdateJobStepMin.json
     */
    /**
     * Sample code: Create or update a job step with minimal properties specified.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        createOrUpdateAJobStepWithMinimalPropertiesSpecified(com.azure.resourcemanager.sql.SqlServerManager manager) {
        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")
                .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

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python create_or_update_job_step_min.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.job_steps.create_or_update(
        resource_group_name="group1",
        server_name="server1",
        job_agent_name="agent1",
        job_name="job1",
        step_name="step1",
        parameters={
            "properties": {
                "action": {"value": "select 1"},
                "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
            }
        },
    )
    print(response)


# x-ms-original-file: 2025-01-01/CreateOrUpdateJobStepMin.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to creates or updates a job step. This will implicitly create a new job version.
 *
 * @summary creates or updates a job step. This will implicitly create a new job version.
 * x-ms-original-file: 2025-01-01/CreateOrUpdateJobStepMin.json
 */
async function createOrUpdateAJobStepWithMinimalPropertiesSpecified() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.jobSteps.createOrUpdate(
    "group1",
    "server1",
    "agent1",
    "job1",
    "step1",
    {
      action: { value: "select 1" },
      targetGroup:
        "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    },
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/CreateOrUpdateJobStepMin.json
// this example is just showing the usage of "JobSteps_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerJobResource created on azure
// for more information of creating SqlServerJobResource, please refer to the document of SqlServerJobResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
string jobName = "job1";
ResourceIdentifier sqlServerJobResourceId = SqlServerJobResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName, jobName);
SqlServerJobResource sqlServerJob = client.GetSqlServerJobResource(sqlServerJobResourceId);

// get the collection of this SqlServerJobStepResource
SqlServerJobStepCollection collection = sqlServerJob.GetSqlServerJobSteps();

// invoke the operation
string stepName = "step1";
SqlServerJobStepData data = new SqlServerJobStepData
{
    TargetGroup = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    Action = new JobStepAction("select 1"),
};
ArmOperation<SqlServerJobStepResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, stepName, data);
SqlServerJobStepResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobStepData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

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

Statuscode:: 201

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
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.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

JobStep

Objekt

Ein Auftragsschritt.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der 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 (int32)	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 die Schritt-ID nicht geändert.
properties.targetGroup	string	Die Ressourcen-ID der Zielgruppe, für die der Auftragsschritt ausgeführt wird.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

JobStepAction

Objekt

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

Enumeration

Die Quelle der auszuführenden Aktion.

Wert	Beschreibung
Inline	Integriert

JobStepActionType

Enumeration

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

Wert	Beschreibung
TSql	TSql

JobStepExecutionOptions

Objekt

Die Ausführungsoptionen eines Auftragsschritts.

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

JobStepOutput

Objekt

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 Ausgabezielschema.
serverName	string		Der Name des Ausgabezielservers.
subscriptionId	string (uuid)		Die Id des Ausgabezielabonnements.
tableName	string		Die Ausgabezieltabelle.
type	JobStepOutputType	SqlDatabase	Der Ausgabezieltyp.

JobStepOutputType

Enumeration

Der Ausgabezieltyp.

Wert	Beschreibung
SqlDatabase	SqlDatabase

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.