Job Agents - Update

Service:

SQL Database

API Version:

2021-11-01

ジョブ エージェントを更新します。

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

URI パラメーター

名前	/	必須	型	説明
jobAgentName	path	True	string	更新するジョブ エージェントの名前。
resourceGroupName	path	True	string	リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

要求本文

名前	型	説明
tags	object	リソース タグ。

応答

名前	型	説明
200 OK	JobAgent	ジョブ エージェントが正常に更新されました。
202 Accepted		同意
Other Status Codes		エラー応答: *** 400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。 404 PropertyChangeUnsupported - プロパティを変更できません。 404 JobAgentNotFound - 指定されたジョブ エージェントが、指定された論理サーバーに存在しません。 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 ServerDisabled - サーバーが無効になっています。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。 操作をやり直してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求数を超える要求。

例

Update a job agent's tags.

Sample Request

HTTP

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

{
  "tags": {
    "mytag1": "myvalue1"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.JobAgentUpdate;
import java.util.HashMap;
import java.util.Map;

/** Samples for JobAgents Update. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/UpdateJobAgent.json
     */
    /**
     * Sample code: Update a job agent's tags.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAJobAgentSTags(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobAgents().update("group1", "server1", "agent1",
            new JobAgentUpdate().withTags(mapOf("mytag1", "myvalue1")), Context.NONE);
    }

    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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

Status code:

202

定義

名前	説明
JobAgent	Azure SQL ジョブ エージェント。
JobAgentState	ジョブ エージェントの状態。
JobAgentUpdate	Azure SQL ジョブ エージェントの更新。
Sku	ARM リソース SKU。

JobAgent

Azure SQL ジョブ エージェント。

名前	型	説明
id	string	リソースの ID
location	string	リソースの場所。
name	string	リソース名。
properties.databaseId	string	ジョブ メタデータを格納するデータベースのリソース ID。
properties.state	JobAgentState	ジョブ エージェントの状態。
sku	Sku	SKU の名前と階層。
tags	object	リソース タグ。
type	string	リソースの種類。

JobAgentState

ジョブ エージェントの状態。

名前	型	説明
Creating	string
Deleting	string
Disabled	string
Ready	string
Updating	string

JobAgentUpdate

Azure SQL ジョブ エージェントの更新。

名前	型	説明
tags	object	リソース タグ。

Sku

ARM リソース SKU。

名前	型	説明
capacity	integer	特定の SKU の容量。
family	string	サービスのハードウェアの世代が異なる場合は、同じ SKU に対して、ここでキャプチャできます。
name	string	SKU の名前 (通常は文字 + 番号コード、例: P3)。
size	string	特定の SKU のサイズ
tier	string	特定の SKU のレベルまたはエディション (Basic、Premium など)。