Job Executions - Create

Dienst:

SQL Database

API-Version:

2025-01-01

Startet eine elastische Auftragsausführung.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/start?api-version=2025-01-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
jobAgentName	path	True	string	Der Name des abzurufenden Auftragsagenten.
jobName	path	True	string	Der Name des abzurufenden 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
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.

Antworten

Name	Typ	Beschreibung
200 OK	JobExecution	Azure-Operation erfolgreich abgeschlossen.
202 Accepted		Ressourcenvorgang akzeptiert. Header Location: string Retry-After: integer
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

Start a job execution.

Beispielanforderung

HTTP

POST https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/start?api-version=2025-01-01

Java

/**
 * Samples for JobExecutions Create.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/CreateJobExecution.json
     */
    /**
     * Sample code: Start a job execution.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void startAJobExecution(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getJobExecutions().create("group1", "server1", "agent1", "job1",
            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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python create_job_execution.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_executions.begin_create(
        resource_group_name="group1",
        server_name="server1",
        job_agent_name="agent1",
        job_name="job1",
    ).result()
    print(response)


# x-ms-original-file: 2025-01-01/CreateJobExecution.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

JavaScript

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

/**
 * This sample demonstrates how to starts an elastic job execution.
 *
 * @summary starts an elastic job execution.
 * x-ms-original-file: 2025-01-01/CreateJobExecution.json
 */
async function startAJobExecution() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.jobExecutions.create("group1", "server1", "agent1", "job1");
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
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/CreateJobExecution.json
// this example is just showing the usage of "JobExecutions_Create" 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);

// invoke the operation
ArmOperation<SqlServerJobExecutionResource> lro = await sqlServerJob.CreateJobExecutionAsync(WaitUntil.Completed);
SqlServerJobExecutionResource 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
SqlServerJobExecutionData 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": "5555-6666-7777-8888-999999999999",
  "type": "Microsoft.Sql/servers/jobAgents/executions",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999",
  "properties": {
    "createTime": "2016-09-23T01:00:00Z",
    "currentAttempts": 0,
    "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
    "jobVersion": 1,
    "lastMessage": "Job execution created.",
    "lifecycle": "Created",
    "provisioningState": "Created"
  }
}

Statuscode:

202

Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/locations/westus/jobAgentOperationResults/5555-6666-7777-8888-999999999999?api-version=2017-03-01-preview

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
JobExecution	Ausführung eines Auftrags
JobExecutionLifecycle	Der detaillierte Zustand der Auftragsausführung.
JobExecutionTarget	Das Ziel, für das eine Auftragsausführung ausgeführt wird.
JobTargetType	Der Typ des Ziels.
ProvisioningState	Der ARM-Bereitstellungsstatus der Auftragsausführung.
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.

JobExecution

Objekt

Ausführung eines Auftrags

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.createTime	string (date-time)	Der Zeitpunkt, zu dem die Auftragsausführung erstellt wurde.
properties.currentAttemptStartTime	string (date-time)	Startzeit des aktuellen Versuchs.
properties.currentAttempts	integer (int32)	Häufigkeit, mit der die Auftragsausführung versucht wurde.
properties.endTime	string (date-time)	Der Zeitpunkt, zu dem die Auftragsausführung abgeschlossen wurde.
properties.jobExecutionId	string (uuid)	Der eindeutige Bezeichner der Auftragsausführung.
properties.jobVersion	integer (int32)	Die Auftragsversionsnummer.
properties.lastMessage	string	Der letzte Status oder die letzte Fehlermeldung.
properties.lifecycle	JobExecutionLifecycle	Der detaillierte Zustand der Auftragsausführung.
properties.provisioningState	ProvisioningState	Der ARM-Bereitstellungsstatus der Auftragsausführung.
properties.startTime	string (date-time)	Die Zeit, zu der die Auftragsausführung gestartet wurde.
properties.stepId	integer (int32)	Die Auftragsschritt-ID.
properties.stepName	string	Der Name des Auftragsschritts.
properties.target	JobExecutionTarget	Das Ziel, für das diese Ausführung 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"

JobExecutionLifecycle

Enumeration

Der detaillierte Zustand der Auftragsausführung.

Wert	Beschreibung
Created	Erstellt
InProgress	In Bearbeitung
WaitingForChildJobExecutions	Warten auf KindJobHinrichtungen
WaitingForRetry	Warten auf einen erneuten Versuch
Succeeded	Erfolgreich
SucceededWithSkipped	ErfolgreichMetÜbersprungen
Failed	gescheitert
TimedOut	TimedOut
Canceled	Abgesagt
Skipped	Übersprungen

JobExecutionTarget

Objekt

Das Ziel, für das eine Auftragsausführung ausgeführt wird.

Name	Typ	Beschreibung
databaseName	string	Der Datenbankname.
serverName	string	Der Servername.
type	JobTargetType	Der Typ des Ziels.

JobTargetType

Enumeration

Der Typ des Ziels.

Wert	Beschreibung
TargetGroup	Zielgruppe
SqlDatabase	SqlDatabase
SqlElasticPool	SqlElasticPool
SqlShardMap	SqlShardMap
SqlServer	SqlServer

ProvisioningState

Enumeration

Der ARM-Bereitstellungsstatus der Auftragsausführung.

Wert	Beschreibung
Created	Erstellt
InProgress	In Bearbeitung
Succeeded	Erfolgreich
Failed	gescheitert
Canceled	Abgesagt

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.