Sql Agent - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets current instance sql agent configuration.

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

URI Parameters

Name	In	Required	Type	Description
managedInstanceName	path	True	string	The name of the managed instance.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	SqlAgentConfiguration	Successfully retrieved current sql agent configuration.
Other Status Codes	ErrorResponse	* Error Responses: * 400 SqlAgentManagedServerNotFound - User tried to configure sql agent of unknown managed instance.

Name

Type

Description

200 OK

SqlAgentConfiguration

Successfully retrieved current sql agent configuration.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 SqlAgentManagedServerNotFound - User tried to configure sql agent of unknown managed instance.

Examples

Gets current instance sql agent configuration.

GET 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

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/SqlAgentConfigurationGet.json
// this example is just showing the usage of "SqlAgent_Get" 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
SqlAgentConfigurationResource result = await sqlAgentConfiguration.GetAsync();

// 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

Sample response

Status code:: 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"
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
SqlAgentConfiguration	A recoverable managed database resource.
SqlAgentState	The state of Sql Agent.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

SqlAgentConfiguration

Object

A recoverable managed database resource.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.state	SqlAgentState	The state of Sql Agent.
type	string	Resource type.

SqlAgentState

Enumeration

The state of Sql Agent.

Value	Description
Enabled
Disabled

Share via

Sql Agent - Get

URI Parameters

Responses

Examples

Gets current instance sql agent configuration.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SqlAgentConfiguration

SqlAgentState