Sql Agent - Create Or Update

Service:

SQL Database

Version d’API:

2025-01-01

Place la nouvelle configuration de l’agent sql à l’instance.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
managedInstanceName	path	True	string	Nom de l’instance managée.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.state	SqlAgentConfigurationPropertiesState	État de Sql Agent.

Réponses

Nom	Type	Description
200 OK	SqlAgentConfiguration	Opération de mise à jour de la ressource 'SqlAgentConfiguration' réussie
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Puts new sql agent configuration to instance.

Exemple de requête

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=2025-01-01

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

Java

import com.azure.resourcemanager.sql.fluent.models.SqlAgentConfigurationInner;
import com.azure.resourcemanager.sql.models.SqlAgentConfigurationPropertiesState;

/**
 * Samples for SqlAgent CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/SqlAgentConfigurationPut.json
     */
    /**
     * Sample code: Puts new sql agent configuration to instance.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void putsNewSqlAgentConfigurationToInstance(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getSqlAgents().createOrUpdateWithResponse("sqlcrudtest-7398", "sqlcrudtest-4645",
            new SqlAgentConfigurationInner().withState(SqlAgentConfigurationPropertiesState.ENABLED),
            com.azure.core.util.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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python sql_agent_configuration_put.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.sql_agent.create_or_update(
        resource_group_name="sqlcrudtest-7398",
        managed_instance_name="sqlcrudtest-4645",
        parameters={"properties": {"state": "Enabled"}},
    )
    print(response)


# x-ms-original-file: 2025-01-01/SqlAgentConfigurationPut.json
if __name__ == "__main__":
    main()

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to puts new sql agent configuration to instance.
 *
 * @summary puts new sql agent configuration to instance.
 * x-ms-original-file: 2025-01-01/SqlAgentConfigurationPut.json
 */
async function putsNewSqlAgentConfigurationToInstance() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.sqlAgent.createOrUpdate("sqlcrudtest-7398", "sqlcrudtest-4645", {
    state: "Enabled",
  });
  console.log(result);
}

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

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/SQL/stable/2025-01-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

Exemple de réponse

Code d’état:

200

{
  "name": "current",
  "type": "Microsoft.Sql/managedInstances/sqlAgent",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/sqlAgent/current",
  "properties": {
    "state": "Enabled"
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
SqlAgentConfiguration	Ressource de base de données managée récupérable.
SqlAgentConfigurationPropertiesState	État de Sql Agent.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

SqlAgentConfiguration

Objet

Ressource de base de données managée récupérable.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.state	SqlAgentConfigurationPropertiesState	État de Sql Agent.
systemData	systemData	Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

SqlAgentConfigurationPropertiesState

Énumération

État de Sql Agent.

Valeur	Description
Enabled	Activé
Disabled	Désactivé

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.