你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Job Target Executions - List By Step

服务:: SQL Database

API 版本:: 2023-08-01

列出作业步骤执行的目标执行。

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

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets?createTimeMin={createTimeMin}&createTimeMax={createTimeMax}&endTimeMin={endTimeMin}&endTimeMax={endTimeMax}&isActive={isActive}&$skip={$skip}&$top={$top}&api-version=2023-08-01

URI 参数

名称	在	必需	类型	说明
jobAgentName	path	True	string	作业代理的名称。
jobExecutionId	path	True	string (uuid)	作业执行的 ID
jobName	path	True	string	要获取的作业的名称。
resourceGroupName	path	True	string	包含资源的资源组的名称。可以从 Azure 资源管理器 API 或门户获取此值。
serverName	path	True	string	服务器的名称。
stepName	path	True	string	步骤的名称。
subscriptionId	path	True	string	标识 Azure 订阅的订阅 ID。
api-version	query	True	string	要用于请求的 API 版本。
$skip	query		integer (int64)	要跳过的集合中的元素数。
$top	query		integer (int64)	要从集合返回的元素数。
createTimeMax	query		string (date-time)	如果指定，则仅包含指定时间之前创建的作业执行。
createTimeMin	query		string (date-time)	如果指定，则仅包含指定时间或之后创建的作业执行。
endTimeMax	query		string (date-time)	如果指定，则仅包含指定时间之前完成的作业执行。
endTimeMin	query		string (date-time)	如果指定，则仅包含指定时间或之后完成的作业执行。
isActive	query		boolean	如果已指定，则仅包含活动或仅已完成的作业执行。

响应

名称	类型	说明
200 OK	JobExecutionListResult	已成功检索目标执行。
Other Status Codes	ErrorResponse	错误响应： *** 400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作 400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作 404 JobAgentNotFound - 指定的作业代理在指定的逻辑服务器中不存在。 404 ResourceNotFound - 找不到请求的资源。 404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

名称

类型

说明

200 OK

JobExecutionListResult

已成功检索目标执行。

Other Status Codes

ErrorResponse

错误响应： ***

400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作
400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作
404 JobAgentNotFound - 指定的作业代理在指定的逻辑服务器中不存在。
404 ResourceNotFound - 找不到请求的资源。
404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。
404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

示例

List job step target executions

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/targets?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.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ListJobExecutionTargetsByStep.json
// this example is just showing the usage of "JobTargetExecutions_ListByStep" 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://free.blessedness.top/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);

// get the collection of this SqlServerJobExecutionStepTargetResource
SqlServerJobExecutionStepTargetCollection collection = sqlServerJobExecutionStep.GetSqlServerJobExecutionStepTargets();

// invoke the operation and iterate over the result
SqlServerJobExecutionStepTargetCollectionGetAllOptions options = new SqlServerJobExecutionStepTargetCollectionGetAllOptions();
await foreach (SqlServerJobExecutionStepTargetResource item in collection.GetAllAsync(options))
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "stepName": "step1",
        "stepId": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-07-01T04:33:17.5133333Z",
        "startTime": "2017-07-01T04:33:18.1230403Z",
        "endTime": "2017-07-01T04:33:18.7031029Z",
        "currentAttempts": 1,
        "currentAttemptStartTime": "2017-07-01T04:33:18.2391013Z",
        "lastMessage": "Step 1 succeeded execution on target (server 'server1', database 'database1').",
        "target": {
          "type": "SqlDatabase",
          "serverName": "server1",
          "databaseName": "database1"
        }
      },
      "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/targets/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions/steps/targets"
    }
  ]
}

定义

名称	说明
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
JobExecution	作业的执行
JobExecutionLifecycle	作业执行的详细状态。
JobExecutionListResult	作业执行的列表。
JobExecutionTarget	执行作业的目标。
JobTargetType	目标的类型。
ProvisioningState	作业执行的 ARM 预配状态。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

JobExecution

Object

作业的执行

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.createTime	string (date-time)	创建作业执行的时间。
properties.currentAttemptStartTime	string (date-time)	当前尝试的开始时间。
properties.currentAttempts	integer (int32)	尝试执行作业的次数。
properties.endTime	string (date-time)	作业执行完成的时间。
properties.jobExecutionId	string (uuid)	作业执行的唯一标识符。
properties.jobVersion	integer (int32)	作业版本号。
properties.lastMessage	string	最后一个状态或错误消息。
properties.lifecycle	JobExecutionLifecycle	作业执行的详细状态。
properties.provisioningState	ProvisioningState	作业执行的 ARM 预配状态。
properties.startTime	string (date-time)	作业执行开始的时间。
properties.stepId	integer (int32)	作业步骤 ID。
properties.stepName	string	作业步骤名称。
properties.target	JobExecutionTarget	执行此执行的目标。
type	string	资源类型。

JobExecutionLifecycle

枚举

作业执行的详细状态。

值	说明
Created
InProgress
WaitingForChildJobExecutions
WaitingForRetry
Succeeded
SucceededWithSkipped
Failed
TimedOut
Canceled
Skipped

JobExecutionListResult

Object

作业执行的列表。

名称	类型	说明
nextLink	string	用于检索下一页结果的链接。
value	JobExecution[]	结果数组。

JobExecutionTarget

Object

执行作业的目标。

名称	类型	说明
databaseName	string	数据库名称。
serverName	string	服务器名称。
type	JobTargetType	目标的类型。

JobTargetType

枚举

目标的类型。

值	说明
TargetGroup
SqlDatabase
SqlElasticPool
SqlShardMap
SqlServer

ProvisioningState

枚举

作业执行的 ARM 预配状态。

值	说明
Created
InProgress
Succeeded
Failed
Canceled

通过

Job Target Executions - List By Step

URI 参数

响应

示例

List job step target executions

示例请求

示例响应

定义

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState