Job Steps - Get
Obtém uma etapa de trabalho na versão atual de um trabalho.
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
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
job
|
path | True |
string |
O nome do agente do trabalho. |
|
job
|
path | True |
string |
O nome da tarefa. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas. |
|
server
|
path | True |
string |
O nome do servidor. |
|
step
|
path | True |
string |
O nome da etapa de trabalho. |
|
subscription
|
path | True |
string (uuid) |
A ID da assinatura de destino. O valor deve ser uma UUID. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a ser usada para esta operação. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
Operação do Azure concluída com sucesso. |
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
azure_auth
Azure Active Directory OAuth2 Flow.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
| Nome | Description |
|---|---|
| user_impersonation | representar sua conta de usuário |
Exemplos
Get the latest version of a job step.
Solicitação de exemplo
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
Resposta de exemplo
{
"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"
}
}
Definições
| Nome | Description |
|---|---|
|
created |
O tipo de identidade que criou o recurso. |
|
Error |
As informações adicionais do erro de gerenciamento de recursos. |
|
Error |
O detalhe do erro. |
|
Error |
Resposta de erro |
|
Job |
Uma etapa de trabalho. |
|
Job |
A ação a ser executada por uma etapa de trabalho. |
|
Job |
A origem da ação a ser executada. |
|
Job |
Tipo de ação que está sendo executada pela etapa de trabalho. |
|
Job |
As opções de execução de uma etapa de trabalho. |
|
Job |
A configuração de saída de uma etapa de trabalho. |
|
Job |
O tipo de destino de saída. |
|
system |
Metadados relativos à criação e última modificação do recurso. |
createdByType
O tipo de identidade que criou o recurso.
| Valor | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
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
O detalhe do erro.
| Nome | Tipo | Description |
|---|---|---|
| additionalInfo |
As informações adicionais do erro. |
|
| code |
string |
O código de erro. |
| details |
Os detalhes do erro. |
|
| message |
string |
A mensagem de erro. |
| target |
string |
O destino do erro. |
ErrorResponse
Resposta de erro
| Nome | Tipo | Description |
|---|---|---|
| error |
O objeto de erro. |
JobStep
Uma etapa de trabalho.
| Nome | Tipo | Description |
|---|---|---|
| id |
string (arm-id) |
ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
O nome do recurso |
| properties.action |
O conteúdo da ação da etapa de trabalho. |
|
| properties.credential |
string |
A ID do recurso da credencial de trabalho que será usada para se conectar aos destinos. |
| properties.executionOptions |
Opções de execução para a etapa de trabalho. |
|
| properties.output |
Propriedades de destino de saída da etapa de trabalho. |
|
| properties.stepId |
integer (int32) |
O índice da etapa de trabalho dentro do trabalho. Se não for especificado ao criar a etapa de trabalho, ela será criada como a última etapa. Se não for especificado ao atualizar a etapa de trabalho, a ID da etapa não será modificada. |
| properties.targetGroup |
string |
A ID do recurso do grupo de destino no qual a etapa de trabalho será executada. |
| systemData |
Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy. |
|
| type |
string |
O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento" |
JobStepAction
A ação a ser executada por uma etapa de trabalho.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| source | Inline |
A origem da ação a ser executada. |
|
| type | TSql |
Tipo de ação que está sendo executada pela etapa de trabalho. |
|
| value |
string |
O valor da ação, por exemplo, o texto do script T-SQL a ser executado. |
JobStepActionSource
A origem da ação a ser executada.
| Valor | Description |
|---|---|
| Inline |
Embutida |
JobStepActionType
Tipo de ação que está sendo executada pela etapa de trabalho.
| Valor | Description |
|---|---|
| TSql |
TSql |
JobStepExecutionOptions
As opções de execução de uma etapa de trabalho.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| initialRetryIntervalSeconds |
integer (int32) |
1 |
Atraso inicial entre novas tentativas para execução da etapa de trabalho. |
| maximumRetryIntervalSeconds |
integer (int32) |
120 |
O período máximo de tempo para aguardar entre as tentativas de execução da etapa de trabalho. |
| retryAttempts |
integer (int32) |
10 |
Número máximo de vezes que a etapa de trabalho será reattempada se a primeira tentativa falhar. |
| retryIntervalBackoffMultiplier |
number (float) |
2 |
O multiplicador de retirada para o tempo entre novas tentativas. |
| timeoutSeconds |
integer (int32) |
43200 |
Tempo limite de execução para a etapa de trabalho. |
JobStepOutput
A configuração de saída de uma etapa de trabalho.
| Nome | Tipo | Valor padrão | Description |
|---|---|---|---|
| credential |
string |
A ID do recurso da credencial a ser usada para se conectar ao destino de saída. |
|
| databaseName |
string |
O banco de dados de destino de saída. |
|
| resourceGroupName |
string |
O grupo de recursos de destino de saída. |
|
| schemaName |
string |
dbo |
O esquema de destino de saída. |
| serverName |
string |
O nome do servidor de destino de saída. |
|
| subscriptionId |
string (uuid) |
A ID da assinatura de destino de saída. |
|
| tableName |
string |
A tabela de destino de saída. |
|
| type | SqlDatabase |
O tipo de destino de saída. |
JobStepOutputType
O tipo de destino de saída.
| Valor | Description |
|---|---|
| SqlDatabase |
SqlDatabase |
systemData
Metadados relativos à criação e última modificação do recurso.
| Nome | Tipo | Description |
|---|---|---|
| createdAt |
string (date-time) |
O carimbo de data/hora da criação de recursos (UTC). |
| createdBy |
string |
A identidade que criou o recurso. |
| createdByType |
O tipo de identidade que criou o recurso. |
|
| lastModifiedAt |
string (date-time) |
O carimbo de data/hora da última modificação do recurso (UTC) |
| lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
| lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |