共用方式為


Job Agents - Get

取得作業代理程式。

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

URI 參數

名稱 位於 必要 類型 Description
jobAgentName
path True

string

要擷取之作業代理程序的名稱。

resourceGroupName
path True

string

包含資源的資源群組名稱。 您可以從 Azure Resource Manager API 或入口網站取得此值。

serverName
path True

string

伺服器的名稱。

subscriptionId
path True

string

識別 Azure 訂用帳戶的訂用帳戶標識碼。

api-version
query True

string

要用於要求的 API 版本。

回應

名稱 類型 Description
200 OK

JobAgent

已成功擷取指定的作業代理程式。

Other Status Codes

ErrorResponse

錯誤回應: ***

  • 400 ManagedInstanceStoppingOrStopped - 實例處於停止/停止狀態時提交的衝突作業

  • 400 ManagedInstanceStarting - 實例處於啟動狀態時提交的衝突作業

  • 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。

  • 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器

  • 404 JobAgentNotFound - 指定的作業代理程式不存在於指定的邏輯伺服器中。

  • 409 ServerDisabled - 伺服器已停用。

範例

Get a job agent

範例要求

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2023-08-01

範例回覆

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1",
  "name": "agent1",
  "type": "Microsoft.Sql/servers/jobAgents",
  "location": "southeastasia",
  "sku": {
    "name": "JA400",
    "capacity": 400
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

定義

名稱 Description
ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

JobAgent

Azure SQL 作業代理程式。

JobAgentIdentity

資源的 Azure Active Directory 身分識別設定。

JobAgentIdentityType

作業代理程式身分識別類型

JobAgentState

作業代理程序的狀態。

JobAgentUserAssignedIdentity

資源的 Azure Active Directory 身分識別設定。

Sku

ARM 資源 SKU。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細數據。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

JobAgent

Azure SQL 作業代理程式。

名稱 類型 Description
id

string

資源標識碼。

identity

JobAgentIdentity

作業代理程式的身分識別。

location

string

資源位置。

name

string

資源名稱。

properties.databaseId

string (arm-id)

要儲存作業元數據的資料庫資源標識碼。

properties.state

JobAgentState

作業代理程序的狀態。

sku

Sku

SKU 的名稱和層。

tags

object

資源標籤。

type

string

資源類型。

JobAgentIdentity

資源的 Azure Active Directory 身分識別設定。

名稱 類型 Description
tenantId

string (uuid)

作業代理程式身分識別租用戶標識碼

type

JobAgentIdentityType

作業代理程式身分識別類型

userAssignedIdentities

<string,  JobAgentUserAssignedIdentity>

要使用的使用者指派身分識別的資源標識碼

JobAgentIdentityType

作業代理程式身分識別類型

Description
None
SystemAssigned
UserAssigned
SystemAssignedUserAssigned

JobAgentState

作業代理程序的狀態。

Description
Creating
Ready
Updating
Deleting
Disabled

JobAgentUserAssignedIdentity

資源的 Azure Active Directory 身分識別設定。

名稱 類型 Description
clientId

string (uuid)

Azure Active Directory 用戶端標識符。

principalId

string (uuid)

Azure Active Directory 主體標識符。

Sku

ARM 資源 SKU。

名稱 類型 Description
capacity

integer (int32)

特定 SKU 的容量。

family

string

如果服務有不同世代的硬體,針對相同的 SKU,則可以在這裡擷取。

name

string

SKU 的名稱,通常是字母 + 數位碼,例如 P3。

size

string

特定 SKU 的大小

tier

string

特定 SKU 的階層或版本,例如基本、進階。