Job Steps - Get

Ottiene un passaggio del processo nella versione corrente di un processo.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
jobAgentName
path True

string

Nome dell'agente di processo.

jobName
path True

string

Nome del lavoro.

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.

stepName
path True

string

Nome del passaggio del processo.

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

JobStep

Operazione Azure completata con successo.

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

Get the latest version of a job step.

Esempio di richiesta

GET 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

Risposta di esempio

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

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

JobStep

Un passaggio del processo.

JobStepAction

Azione da eseguire da un passaggio del processo.

JobStepActionSource

Origine dell'azione da eseguire.

JobStepActionType

Tipo di azione eseguita dal passaggio del processo.

JobStepExecutionOptions

Opzioni di esecuzione di un passaggio del processo.

JobStepOutput

Configurazione di output di un passaggio del processo.

JobStepOutputType

Tipo di destinazione di output.

systemData

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

createdByType

Tipo di identità che ha creato la risorsa.

Valore Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

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

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

JobStep

Un passaggio del 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.action

JobStepAction

Payload dell'azione del passaggio del processo.

properties.credential

string

ID risorsa delle credenziali del processo che verranno usate per connettersi alle destinazioni.

properties.executionOptions

JobStepExecutionOptions

Opzioni di esecuzione per il passaggio del processo.

properties.output

JobStepOutput

Proprietà di destinazione di output del passaggio del processo.

properties.stepId

integer (int32)

Indice del passaggio del processo all'interno del processo. Se non specificato durante la creazione del passaggio di processo, verrà creato come ultimo passaggio. Se non specificato durante l'aggiornamento del passaggio del processo, l'ID passaggio non viene modificato.

properties.targetGroup

string

ID risorsa del gruppo di destinazione in cui verrà eseguito il passaggio del processo.

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"

JobStepAction

Azione da eseguire da un passaggio del processo.

Nome Tipo Valore predefinito Descrizione
source

JobStepActionSource

Inline

Origine dell'azione da eseguire.

type

JobStepActionType

TSql

Tipo di azione eseguita dal passaggio del processo.

value

string

Valore dell'azione, ad esempio il testo dello script T-SQL da eseguire.

JobStepActionSource

Origine dell'azione da eseguire.

Valore Descrizione
Inline

In linea

JobStepActionType

Tipo di azione eseguita dal passaggio del processo.

Valore Descrizione
TSql

TSql

JobStepExecutionOptions

Opzioni di esecuzione di un passaggio del processo.

Nome Tipo Valore predefinito Descrizione
initialRetryIntervalSeconds

integer (int32)

1

Ritardo iniziale tra i tentativi per l'esecuzione del passaggio del processo.

maximumRetryIntervalSeconds

integer (int32)

120

Quantità massima di tempo di attesa tra i tentativi per l'esecuzione del passaggio del processo.

retryAttempts

integer (int32)

10

Numero massimo di tentativi di ripetizione del passaggio del processo se il primo tentativo ha esito negativo.

retryIntervalBackoffMultiplier

number (float)

2

Moltiplicatore backoff per il tempo tra i tentativi.

timeoutSeconds

integer (int32)

43200

Timeout di esecuzione per il passaggio del processo.

JobStepOutput

Configurazione di output di un passaggio del processo.

Nome Tipo Valore predefinito Descrizione
credential

string

ID risorsa della credenziale da usare per connettersi alla destinazione di output.

databaseName

string

Database di destinazione dell'output.

resourceGroupName

string

Gruppo di risorse di destinazione di output.

schemaName

string

dbo

Schema di destinazione dell'output.

serverName

string

Nome del server di destinazione di output.

subscriptionId

string (uuid)

ID sottoscrizione di destinazione di output.

tableName

string

Tabella di destinazione dell'output.

type

JobStepOutputType

SqlDatabase

Tipo di destinazione di output.

JobStepOutputType

Tipo di destinazione di output.

Valore Descrizione
SqlDatabase

SqlDatabase

systemData

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.