Sql Agent - Create Or Update

サービス:

SQL Database

API バージョン:

2023-08-01

新しい SQL エージェント構成をインスタンスに配置します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/sqlAgent/current?api-version=2023-08-01

URI パラメーター

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

要求本文

名前	型	説明
properties.state	SqlAgentState	Sql エージェントの状態。

応答

名前	型	説明
200 OK	SqlAgentConfiguration	SQL エージェントの構成を正常に配置しました
Other Status Codes	ErrorResponse	エラー応答: *** 400 SqlAgentManagedServerNotFound - ユーザーが不明なマネージド インスタンスの SQL エージェントを構成しようとしました。

例

Puts new sql agent configuration to instance.

要求のサンプル

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/sqlAgent/current?api-version=2023-08-01

{
  "properties": {
    "state": "Enabled"
  }
}

dotnet

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/SqlAgentConfigurationPut.json
// this example is just showing the usage of "SqlAgent_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 SqlAgentConfigurationResource created on azure
// for more information of creating SqlAgentConfigurationResource, please refer to the document of SqlAgentConfigurationResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string managedInstanceName = "sqlcrudtest-4645";
ResourceIdentifier sqlAgentConfigurationResourceId = SqlAgentConfigurationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
SqlAgentConfigurationResource sqlAgentConfiguration = client.GetSqlAgentConfigurationResource(sqlAgentConfigurationResourceId);

// invoke the operation
SqlAgentConfigurationData data = new SqlAgentConfigurationData
{
    State = SqlAgentConfigurationPropertiesState.Enabled,
};
ArmOperation<SqlAgentConfigurationResource> lro = await sqlAgentConfiguration.CreateOrUpdateAsync(WaitUntil.Completed, data);
SqlAgentConfigurationResource 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
SqlAgentConfigurationData 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/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/sqlAgent/current",
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/sqlAgent",
  "properties": {
    "state": "Enabled"
  }
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
SqlAgentConfiguration	回復可能なマネージド データベース リソース。
SqlAgentState	Sql エージェントの状態。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

SqlAgentConfiguration

Object

回復可能なマネージド データベース リソース。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.state	SqlAgentState	Sql エージェントの状態。
type	string	リソースの種類。

SqlAgentState

列挙

Sql エージェントの状態。

値	説明
Enabled
Disabled