Job Steps - Get

Ruft einen Auftragsschritt in der aktuellen Version eines Auftrags ab.

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

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.

Antworten

Name Typ Beschreibung
200 OK

JobStep

Azure-Operation erfolgreich abgeschlossen.

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

Get the latest version of a job step.

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

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

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

JobStep

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

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

Die Quelle der auszuführenden Aktion.

Wert Beschreibung
Inline

Integriert

JobStepActionType

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

Wert Beschreibung
TSql

TSql

JobStepExecutionOptions

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

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

Der Ausgabezieltyp.

Wert Beschreibung
SqlDatabase

SqlDatabase

systemData

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.