Job Agents - Create Or Update

Service:

SQL Database

API Version:

2021-11-01

建立或更新作業代理程式。

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

URI 參數

名稱	位於	必要	類型	Description
jobAgentName	path	True	string	要建立或更新之作業代理程序的名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源位置。
properties.databaseId	True	string	要儲存作業元數據的資料庫資源標識碼。
sku		Sku	SKU 的名稱和層級。
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	JobAgent	已成功更新作業代理程式。
201 Created	JobAgent	已成功建立作業代理程式。
202 Accepted		已接受
Other Status Codes		錯誤回應： ≦ 400 InvalidResourceRequestBody - 要求本文中的資源或資源屬性是空的或無效的。 400 MissingSkuName - 需要 Sku 名稱。 400 InvalidDatabaseResourceId - 無效的資料庫資源標識符。 400 MatchingSubscriptionWithUrl - 提供的訂用帳戶不符合 URL 中的訂用帳戶。 400 MatchingResourceGroupNameWithUrl - 提供的資源組名與 URL 中的名稱不符。 400 不相符ServerNameWithUrl - 提供的伺服器名稱與 URL 中的名稱不符。 400 JobAgentDatabaseEditionUnsupported - 不支援指定的資料庫服務等級目標做為作業代理程序資料庫使用。 400 JobAgentDatabaseSecondary - 作業代理程式無法連結至異地輔助資料庫。 400 JobAgentDatabaseAlreadyLinked - 指定的資料庫已經連結到另一個作業代理程式。 400 DatabaseDoesNotExist - 找不到要求的資料庫 400 CannotUseReservedDatabaseName - 無法在此作業中使用保留的資料庫名稱。 400 JobAgentExceededQuota - 無法建立作業代理程序，因為它會超過配額。 400 JobAgentAlreadyExists - 作業代理程式已存在於伺服器上。 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 ServerNotInSubscriptionResourceGroup - 指定的伺服器不存在於指定的資源群組和訂用帳戶中。 404 PropertyChangeUnsupported - 無法修改屬性。 404 SubscriptionNotFound - 找不到要求的訂用帳戶。 404 OperationIdNotFound - 標識符為 的作業不存在。 409 ServerDisabled - 伺服器已停用。 409 OperationCancelled - 使用者已取消作業。 409 OperationInterrupted - 無法完成資源上的作業，因為它被相同資源上的另一個作業中斷。 429 SubscriptionTooManyCreateUpdateRequests - 超出可用資源可處理之最大要求的要求。 429 SubscriptionTooManyRequests - 超出可用資源可處理之最大要求的要求。 500 OperationTimedOut - 作業逾時並自動回復。 請重試該作業。 503 TooManyRequests - 超出可用資源可處理之最大要求的要求。

範例

Create or update a job agent

Sample Request

HTTP

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

{
  "location": "southeastasia",
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.JobAgentInner;

/** Samples for JobAgents CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateJobAgent.json
     */
    /**
     * Sample code: Create or update a job agent.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createOrUpdateAJobAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobAgents().createOrUpdate("group1", "server1", "agent1",
            new JobAgentInner().withLocation("southeastasia").withDatabaseId(
                "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"),
            Context.NONE);
    }
}

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

Sample Response

Status code:

200

{
  "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": "Agent",
    "capacity": 100
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

Status code:

201

{
  "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": "Agent",
    "capacity": 100
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

Status code:

202

定義

名稱	Description
JobAgent	Azure SQL 作業代理程式。
JobAgentState	作業代理程序的狀態。
Sku	ARM 資源 SKU。

JobAgent

Azure SQL 作業代理程式。

名稱	類型	Description
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.databaseId	string	要儲存作業元數據的資料庫資源標識碼。
properties.state	JobAgentState	作業代理程序的狀態。
sku	Sku	SKU 的名稱和層級。
tags	object	資源標籤。
type	string	資源類型。

JobAgentState

作業代理程序的狀態。

名稱	類型	Description
Creating	string
Deleting	string
Disabled	string
Ready	string
Updating	string

Sku

ARM 資源 SKU。

名稱	類型	Description
capacity	integer	特定 SKU 的容量。
family	string	如果服務有不同的硬體世代，則針對相同的 SKU，則可以在這裡擷取。
name	string	SKU 的名稱，通常是字母 + 編號代碼，例如 P3。
size	string	特定 SKU 的大小
tier	string	特定 SKU 的層級或版本，例如基本、進階。