Job Executions - Create

Service:

SQL Database

Versione API:

2025-01-01

Avvia un'esecuzione di processo elastico.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
jobAgentName	path	True	string	Nome dell'agente di processo da recuperare.
jobName	path	True	string	Nome del processo da ottenere.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
serverName	path	True	string	Il nome del server.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	JobExecution	Operazione Azure completata con successo.
202 Accepted		Operazione sulle risorse accettata. Intestazioni Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Start a job execution.

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Codice di stato:

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

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
JobExecution	Esecuzione di un processo
JobExecutionLifecycle	Stato dettagliato dell'esecuzione del processo.
JobExecutionTarget	Destinazione in cui viene eseguita un'esecuzione del processo.
JobTargetType	Tipo della destinazione.
ProvisioningState	Stato di provisioning arm dell'esecuzione del processo.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

JobExecution

Oggetto

Esecuzione di un processo

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.createTime	string (date-time)	Ora di creazione dell'esecuzione del processo.
properties.currentAttemptStartTime	string (date-time)	Ora di inizio del tentativo corrente.
properties.currentAttempts	integer (int32)	Numero di tentativi di esecuzione del processo.
properties.endTime	string (date-time)	Ora di completamento dell'esecuzione del processo.
properties.jobExecutionId	string (uuid)	Identificatore univoco dell'esecuzione del processo.
properties.jobVersion	integer (int32)	Numero di versione del processo.
properties.lastMessage	string	Ultimo stato o messaggio di errore.
properties.lifecycle	JobExecutionLifecycle	Stato dettagliato dell'esecuzione del processo.
properties.provisioningState	ProvisioningState	Stato di provisioning arm dell'esecuzione del processo.
properties.startTime	string (date-time)	Ora di avvio dell'esecuzione del processo.
properties.stepId	integer (int32)	ID del passaggio del processo.
properties.stepName	string	Nome del passaggio del processo.
properties.target	JobExecutionTarget	Destinazione in cui viene eseguita l'esecuzione.
systemData	systemData	Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
type	string	Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

JobExecutionLifecycle

Enumerazione

Stato dettagliato dell'esecuzione del processo.

Valore	Descrizione
Created	Creato
InProgress	In corso
WaitingForChildJobExecutions	AspettandoUn FiglioLavoroEsecuzioni
WaitingForRetry	AspettandoRiprovare
Succeeded	Succeeded
SucceededWithSkipped	RiuscitoWithSkipped
Failed	Non riuscito
TimedOut	TimedOut
Canceled	Operazione annullata
Skipped	Ignorato

JobExecutionTarget

Oggetto

Destinazione in cui viene eseguita un'esecuzione del processo.

Nome	Tipo	Descrizione
databaseName	string	Nome del database.
serverName	string	Nome del server.
type	JobTargetType	Tipo della destinazione.

JobTargetType

Enumerazione

Tipo della destinazione.

Valore	Descrizione
TargetGroup	Gruppo di Target
SqlDatabase	SqlDatabase
SqlElasticPool	SqlElasticPool
SqlShardMap	SqlShardMap
SqlServer	SqlServer

ProvisioningState

Enumerazione

Stato di provisioning arm dell'esecuzione del processo.

Valore	Descrizione
Created	Creato
InProgress	In corso
Succeeded	Succeeded
Failed	Non riuscito
Canceled	Operazione annullata

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.