Job Step Executions - Get

Referência

Serviço:: SQL Database

Versão da API:: 2023-08-01

Obtém uma execução em etapa de uma execução de trabalho.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}?api-version=2023-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
jobAgentName	path	True	string	O nome do agente do trabalho.
jobExecutionId	path	True	string (uuid)	A ID exclusiva da execução do trabalho
jobName	path	True	string	O nome do trabalho a ser obtido.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
serverName	path	True	string	O nome do servidor.
stepName	path	True	string	O nome da etapa.
subscriptionId	path	True	string	A ID da assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	JobExecution	Recuperou com êxito a execução da etapa.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped – Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting – Operação conflitante enviada enquanto a instância está no estado inicial 404 JobAgentNotFound – O agente de trabalho especificado não existe no servidor lógico especificado. 404 ResourceNotFound – O recurso solicitado não foi encontrado. 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 ResourceNotFound – O recurso solicitado não foi encontrado.

Nome

Tipo

Description

200 OK

JobExecution

Recuperou com êxito a execução da etapa.

Other Status Codes

ErrorResponse

Respostas de erro: ***

400 ManagedInstanceStoppingOrStopped – Operação conflitante enviada enquanto a instância está no estado de parada/parada
400 ManagedInstanceStarting – Operação conflitante enviada enquanto a instância está no estado inicial
404 JobAgentNotFound – O agente de trabalho especificado não existe no servidor lógico especificado.
404 ResourceNotFound – O recurso solicitado não foi encontrado.
404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados.
404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado
404 ResourceNotFound – O recurso solicitado não foi encontrado.

Exemplos

Get a job step execution

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5A86BF65-43AC-F258-2524-9E92992F97CA/steps/step1?api-version=2023-08-01

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

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/GetJobExecutionStep.json
// this example is just showing the usage of "JobStepExecutions_Get" 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 SqlServerJobExecutionStepResource created on azure
// for more information of creating SqlServerJobExecutionStepResource, please refer to the document of SqlServerJobExecutionStepResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
string jobName = "job1";
Guid jobExecutionId = Guid.Parse("5A86BF65-43AC-F258-2524-9E92992F97CA");
string stepName = "step1";
ResourceIdentifier sqlServerJobExecutionStepResourceId = SqlServerJobExecutionStepResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName, jobName, jobExecutionId, stepName);
SqlServerJobExecutionStepResource sqlServerJobExecutionStep = client.GetSqlServerJobExecutionStepResource(sqlServerJobExecutionStepResourceId);

// invoke the operation
SqlServerJobExecutionStepResource result = await sqlServerJobExecutionStep.GetAsync();

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

Resposta de exemplo

Código de status:: 200

{
  "properties": {
    "jobVersion": 1,
    "stepName": "step1",
    "stepId": 1,
    "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
    "lifecycle": "Succeeded",
    "provisioningState": "Succeeded",
    "createTime": "2017-12-27T04:33:15.7189151Z",
    "startTime": "2017-12-27T04:33:16.176937Z",
    "endTime": "2017-12-27T04:33:19.0600862Z",
    "currentAttempts": 1,
    "currentAttemptStartTime": "2017-12-27T04:33:17.4840068Z",
    "lastMessage": "Step 1 succeeded."
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps"
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
JobExecution	Uma execução de um trabalho
JobExecutionLifecycle	O estado detalhado da execução do trabalho.
JobExecutionTarget	O destino no qual uma execução de trabalho é executada.
JobTargetType	O tipo do destino.
ProvisioningState	O estado de provisionamento do ARM da execução do trabalho.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

JobExecution

Objeto

Uma execução de um trabalho

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.createTime	string (date-time)	A hora em que a execução do trabalho foi criada.
properties.currentAttemptStartTime	string (date-time)	Hora de início da tentativa atual.
properties.currentAttempts	integer (int32)	Número de vezes que a execução do trabalho foi tentada.
properties.endTime	string (date-time)	A hora em que a execução do trabalho foi concluída.
properties.jobExecutionId	string (uuid)	O identificador exclusivo da execução do trabalho.
properties.jobVersion	integer (int32)	O número da versão do trabalho.
properties.lastMessage	string	O último status ou mensagem de erro.
properties.lifecycle	JobExecutionLifecycle	O estado detalhado da execução do trabalho.
properties.provisioningState	ProvisioningState	O estado de provisionamento do ARM da execução do trabalho.
properties.startTime	string (date-time)	A hora em que a execução do trabalho foi iniciada.
properties.stepId	integer (int32)	A ID da etapa de trabalho.
properties.stepName	string	O nome da etapa de trabalho.
properties.target	JobExecutionTarget	O destino no qual essa execução é executada.
type	string	Tipo de recurso.

JobExecutionLifecycle

Enumeração

O estado detalhado da execução do trabalho.

Valor	Description
Canceled
Created
Failed
InProgress
Skipped
Succeeded
SucceededWithSkipped
TimedOut
WaitingForChildJobExecutions
WaitingForRetry

JobExecutionTarget

Objeto

O destino no qual uma execução de trabalho é executada.

Nome	Tipo	Description
databaseName	string	O nome do banco de dados.
serverName	string	O nome do servidor.
type	JobTargetType	O tipo do destino.

JobTargetType

Enumeração

O tipo do destino.

Valor	Description
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup

ProvisioningState

Enumeração

O estado de provisionamento do ARM da execução do trabalho.

Valor	Description
Canceled
Created
Failed
InProgress
Succeeded

Compartilhar via

Job Step Executions - Get

Parâmetros de URI

Respostas

Exemplos

Get a job step execution

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JobExecution

JobExecutionLifecycle

JobExecutionTarget

JobTargetType

ProvisioningState