Job Agents - Create Or Update

サービス:: SQL Database

API バージョン:: 2023-08-01

ジョブエージェントを作成または更新します。

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

URI パラメーター

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

要求本文

名前	必須	型	説明
location	True	string	リソースの場所。
properties.databaseId	True	string (arm-id)	ジョブメタデータを格納するデータベースのリソース ID。
identity		JobAgentIdentity	ジョブエージェントの ID。
sku		Sku	SKU の名前と層。
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	JobAgent	ジョブエージェントが正常に更新されました。
201 Created	JobAgent	ジョブエージェントが正常に作成されました。
202 Accepted		受け入れられるヘッダー Location: string
Other Status Codes	ErrorResponse	エラー応答: *** 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合 400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。 400 MissingSkuName - SKU 名が必要です。 400 InvalidDatabaseResourceId - データベースリソース識別子が無効です。 400 InvalidIdentityTenantId - tenantId は、作成要求または更新要求では指定できません。 400 MismatchingSubscriptionWithUrl - 指定されたサブスクリプションが URL のサブスクリプションと一致しませんでした。 400 MismatchingResourceGroupNameWithUrl - 指定されたリソースグループ名が URL 内の名前と一致しませんでした。 400 MismatchingServerNameWithUrl - 指定されたサーバー名が URL 内の名前と一致しませんでした。 400 MissingUserAssignedIdentities - identity.userAssignedIdentities は、identity.type が "UserAssigned" と等しい場合に指定する必要があります。 400 MissingIdentityType - ID の種類を指定してください。 400 MultipleIdentitiesOnJobAgent - ジョブエージェントごとに 1 つのユーザーマネージド ID のみを指定してください。 400 InvalidIdentityType - "None" または "UserAssigned" ID の種類のみを指定してください。 400 SkuMismatchingNameCapacity - 指定された SKU 容量が、指定された SKU 名と一致しません。 400 ElasticJobAgentEditionUnsupported - 指定された SLO はジョブエージェントではサポートされていません。サポートされている SLO を使用して再試行してください。 400 ElasticJobAgentObjectiveAssignmentInProgress - エラスティックジョブエージェント '{0}' の SLO 割り当ては現在進行中です。後で操作を再試行してください。 400 ElasticJobAgentEditionUnsupported - 指定された SLO はジョブエージェントではサポートされていません。サポートされている SLO を使用して再試行してください。 400 DatabaseDoesNotExist - 要求されたデータベースが見つかりませんでした 400 JobAgentExceededQuota - ジョブエージェントがクォータを超えるので作成できませんでした。 400 JobAgentAlreadyExists - ジョブエージェントは既にサーバー上に存在します。 400 JobAgentDatabaseEditionUnsupported - 指定されたデータベースのサービスレベル目標は、ジョブエージェントデータベースとして使用できません。 400 JobAgentDatabaseSecondary - ジョブエージェントを geo セカンダリデータベースにリンクすることはできません。 400 JobAgentDatabaseAlreadyLinked - 指定されたデータベースは既に別のジョブエージェントにリンクされています。 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - 自動一時停止が有効なサーバーレスデータベースは、ジョブエージェントによってそのデータベースの一時停止が妨げられるため、エラスティックジョブデータベースとしてサポートされていません。このサーバーレスデータベースで自動一時停止を無効にするか、このデータベースを使用しているジョブエージェントを削除できます。詳細については、こちらを参照してください:https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing 400 CannotUseReservedDatabaseName - この操作で予約済みデータベース名を使用できません。 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 SubscriptionNotFound - 要求されたサブスクリプションが見つかりませんでした。 404 PropertyChangeUnsupported - プロパティを変更できません。 404 OperationIdNotFound - Id を持つ操作が存在しません。 409 ServerDisabled - サーバーが無効になっています。 409 ElasticJobAgentOperationUnavailable - 操作 '{0}' は、エラスティックジョブエージェント '{1}' に対してブロックされます {2} 409 CannotCancelOperation - 管理操作が取り消すことができない状態です。 409 OperationCancelled - 操作がユーザーによって取り消されました。 409 OperationInterrupted - 同じリソースに対する別の操作によって中断されたため、リソースに対する操作を完了できませんでした。 429 SubscriptionTooManyCreateUpdateRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 429 SubscriptionTooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。 500 OperationTimedOut - 操作がタイムアウトし、自動的にロールバックされました。操作を再試行してください。 503 TooManyRequests - 使用可能なリソースによって処理できる最大要求を超える要求。

例

Create or update a job agent

Create or update a job agent with identity

Create or update a job agent with sku.

Create or update a job agent

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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobAgent.json
// this example is just showing the usage of "JobAgents_CreateOrUpdate" 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://learn.microsoft.com/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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerJobAgentResource
SqlServerJobAgentCollection collection = sqlServer.GetSqlServerJobAgents();

// invoke the operation
string jobAgentName = "agent1";
SqlServerJobAgentData data = new SqlServerJobAgentData(new AzureLocation("southeastasia"))
{
    DatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"),
};
ArmOperation<SqlServerJobAgentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, jobAgentName, data);
SqlServerJobAgentResource result = lro.Value;

// the variable result 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
SqlServerJobAgentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

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

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

状態コード:: 202

Create or update a job agent with identity

要求のサンプル

HTTP
dotnet

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

{
  "location": "southeastasia",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi": {}
    }
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobAgentWithIdentity.json
// this example is just showing the usage of "JobAgents_CreateOrUpdate" 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://learn.microsoft.com/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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerJobAgentResource
SqlServerJobAgentCollection collection = sqlServer.GetSqlServerJobAgents();

// invoke the operation
string jobAgentName = "agent1";
SqlServerJobAgentData data = new SqlServerJobAgentData(new AzureLocation("southeastasia"))
{
    Identity = new JobAgentIdentity(JobAgentIdentityType.UserAssigned)
    {
        UserAssignedIdentities =
        {
        ["/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi"] = new UserAssignedIdentity()
        },
    },
    DatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"),
};
ArmOperation<SqlServerJobAgentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, jobAgentName, data);
SqlServerJobAgentResource result = lro.Value;

// the variable result 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
SqlServerJobAgentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:: 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",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi": {
        "clientId": "0c29d9b7-0ae2-4014-96ea-faf8e0cf2bc7",
        "principalId": "0c29d9b7-0ae2-4014-96ea-faf8e0cf2bc7"
      }
    }
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

状態コード:: 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",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi": {
        "clientId": "0c29d9b7-0ae2-4014-96ea-faf8e0cf2bc7",
        "principalId": "0c29d9b7-0ae2-4014-96ea-faf8e0cf2bc7"
      }
    }
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

状態コード:: 202

Create or update a job agent with sku.

要求のサンプル

HTTP
dotnet

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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobAgentWithSku.json
// this example is just showing the usage of "JobAgents_CreateOrUpdate" 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://learn.microsoft.com/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 SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerJobAgentResource
SqlServerJobAgentCollection collection = sqlServer.GetSqlServerJobAgents();

// invoke the operation
string jobAgentName = "agent1";
SqlServerJobAgentData data = new SqlServerJobAgentData(new AzureLocation("southeastasia"))
{
    Sku = new SqlSku("JA400"),
    DatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"),
};
ArmOperation<SqlServerJobAgentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, jobAgentName, data);
SqlServerJobAgentResource result = lro.Value;

// the variable result 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
SqlServerJobAgentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

応答のサンプル

状態コード:: 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": "JA400",
    "capacity": 400
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

状態コード:: 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": "JA400",
    "capacity": 400
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

状態コード:: 202

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
JobAgent	Azure SQL ジョブエージェント。
JobAgentIdentity	リソースの Azure Active Directory ID 構成。
JobAgentIdentityType	ジョブエージェント ID の種類
JobAgentState	ジョブエージェントの状態。
JobAgentUserAssignedIdentity	リソースの Azure Active Directory ID 構成。
Sku	ARM リソース SKU。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

JobAgent

Object

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

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

JobAgentIdentity

Object

リソースの Azure Active Directory ID 構成。

名前	型	説明
tenantId	string (uuid)	ジョブエージェント ID テナント ID
type	JobAgentIdentityType	ジョブエージェント ID の種類
userAssignedIdentities	<string, JobAgentUserAssignedIdentity>	使用するユーザー割り当て ID のリソース ID

JobAgentIdentityType

列挙

ジョブエージェント ID の種類

値	説明
None
SystemAssigned
UserAssigned
SystemAssignedUserAssigned

JobAgentState

列挙

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

値	説明
Creating
Ready
Updating
Deleting
Disabled

JobAgentUserAssignedIdentity

Object

リソースの Azure Active Directory ID 構成。

名前	型	説明
clientId	string (uuid)	Azure Active Directory クライアント ID。
principalId	string (uuid)	Azure Active Directory プリンシパル ID。

Sku

Object

ARM リソース SKU。

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

次の方法で共有

Job Agents - Create Or Update

URI パラメーター

要求本文

応答

例

Create or update a job agent

要求のサンプル

応答のサンプル

Create or update a job agent with identity

要求のサンプル

応答のサンプル

Create or update a job agent with sku.

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JobAgent

JobAgentIdentity

JobAgentIdentityType

JobAgentState

JobAgentUserAssignedIdentity

Sku