Met à jour un agent de travail.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}?api-version=2023-08-01
Paramètres URI
| Nom |
Dans |
Obligatoire |
Type |
Description |
|
jobAgentName
|
path |
True
|
string
|
Nom de l’agent de travail à mettre à jour.
|
|
resourceGroupName
|
path |
True
|
string
|
Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
|
|
serverName
|
path |
True
|
string
|
Nom du serveur.
|
|
subscriptionId
|
path |
True
|
string
|
ID d’abonnement qui identifie un abonnement Azure.
|
|
api-version
|
query |
True
|
string
|
Version de l’API à utiliser pour la requête.
|
Corps de la demande
| Nom |
Type |
Description |
|
identity
|
JobAgentIdentity
|
Identité managée affectée à l’agent de travail
|
|
sku
|
Sku
|
Nom et niveau de la référence SKU.
|
|
tags
|
object
|
Balises de ressource.
|
Réponses
| Nom |
Type |
Description |
|
200 OK
|
JobAgent
|
Mise à jour réussie de l’agent de travail.
|
|
202 Accepted
|
|
Accepté
En-têtes
Location: string
|
|
Other Status Codes
|
ErrorResponse
|
Réponses d’erreur : ***
400 ManagedInstanceStoppingOrStopped : opération en conflit envoyée pendant l’arrêt/l’état arrêté de l’instance
400 ManagedInstanceStarting - Opération en conflit envoyée pendant que l’instance est à l’état de démarrage
400 InvalidResourceRequestBody : les propriétés de ressource ou de ressource dans le corps de la requête sont vides ou non valides.
400 MissingIdentityType : spécifiez le type d’identité.
400 MultipleIdentitiesOnJobAgent : spécifiez une seule identité managée par utilisateur par agent de travail.
400 InvalidIdentityTenantId - tenantId ne peut pas être spécifié sur une demande de création ou de mise à jour.
400 InvalidIdentityType : spécifiez uniquement les types d’identité « None » ou « UserAssigned ».
400 SkuMismatchingNameCapacity : la capacité de référence SKU fournie ne correspond pas au nom de la référence SKU fournie.
400 ElasticJobAgentEditionUnsupported : le SLO donné n’est pas pris en charge pour l’agent de travail. Réessayez avec le SLO pris en charge.
400 ElasticJobAgentObjectiveAssignmentInProgress : l’affectation SLO pour l’agent de travail élastique{0}' est en cours. Réessayez l’opération ultérieurement.
400 ElasticJobAgentEditionUnsupported : le SLO donné n’est pas pris en charge pour l’agent de travail. Réessayez avec le SLO pris en charge.
400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - La mise en pause automatique de la base de données serverless activée n’est pas prise en charge en tant que base de données elastic Jobs, car l’agent de travail empêcherait cette base de données de suspendre. Vous pouvez désactiver la pause automatique sur cette base de données serverless ou supprimer l’agent de travail qui utilise cette base de données. Pour plus d’informations, voir ici : https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.
404 SubscriptionDoesNotHaveServer - Le serveur demandé est introuvable
404 JobAgentNotFound : l’agent de travail spécifié n’existe pas dans le serveur logique spécifié.
404 PropertyChangeUnsupported - Impossible de modifier la propriété.
404 OperationIdNotFound : l’opération avec ID n’existe pas.
409 ServerDisabled : le serveur est désactivé.
409 ElasticJobAgentOperationUnavailable - L’opération '{0}' est bloquée pour l’agent de travail élastique '{1}' car {2}
409 CannotCancelOperation : l’opération de gestion est dans un état qui ne peut pas être annulé.
409 OperationCancelled : l’opération a été annulée par l’utilisateur.
409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource.
429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
429 SubscriptionTooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
500 OperationTimedOut : l’opération a expiré et a été restaurée automatiquement. Réessayez l’opération.
503 TooManyRequests : demandes au-delà des requêtes maximales pouvant être traitées par les ressources disponibles.
|
Exemples
Update a job agent's identity.
Exemple de requête
PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2023-08-01
{
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi": {}
}
}
}
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/UpdateJobAgentWithIdentity.json
// this example is just showing the usage of "JobAgents_Update" 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 SqlServerJobAgentResource created on azure
// for more information of creating SqlServerJobAgentResource, please refer to the document of SqlServerJobAgentResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
ResourceIdentifier sqlServerJobAgentResourceId = SqlServerJobAgentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName);
SqlServerJobAgentResource sqlServerJobAgent = client.GetSqlServerJobAgentResource(sqlServerJobAgentResourceId);
// invoke the operation
SqlServerJobAgentPatch patch = new SqlServerJobAgentPatch
{
Identity = new JobAgentIdentity(JobAgentIdentityType.UserAssigned)
{
UserAssignedIdentities =
{
["/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi"] = new UserAssignedIdentity()
},
},
};
ArmOperation<SqlServerJobAgentResource> lro = await sqlServerJobAgent.UpdateAsync(WaitUntil.Completed, patch);
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
Exemple de réponse
{
"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"
},
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi": {
"clientId": "e09c8507-0000-0000-97e2-18c5beec59dc",
"principalId": "0c29d9b7-0ae2-4014-96ea-faf8e0cf2bc7"
}
}
}
}
Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/southeastasia/jobAgentOperationResults/00000000-1111-2222-3333-444444444444?api-version=2017-03-01-preview
Update a job agent's sku.
Exemple de requête
PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2023-08-01
{
"sku": {
"name": "JA200"
}
}
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/UpdateJobAgentWithSku.json
// this example is just showing the usage of "JobAgents_Update" 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 SqlServerJobAgentResource created on azure
// for more information of creating SqlServerJobAgentResource, please refer to the document of SqlServerJobAgentResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
ResourceIdentifier sqlServerJobAgentResourceId = SqlServerJobAgentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName);
SqlServerJobAgentResource sqlServerJobAgent = client.GetSqlServerJobAgentResource(sqlServerJobAgentResourceId);
// invoke the operation
SqlServerJobAgentPatch patch = new SqlServerJobAgentPatch
{
Sku = new SqlSku("JA200"),
};
ArmOperation<SqlServerJobAgentResource> lro = await sqlServerJobAgent.UpdateAsync(WaitUntil.Completed, patch);
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
Exemple de réponse
{
"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"
},
"sku": {
"name": "JA200",
"capacity": 200
}
}
Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/southeastasia/jobAgentOperationResults/00000000-1111-2222-3333-444444444444?api-version=2017-03-01-preview
Exemple de requête
PATCH https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2023-08-01
{
"tags": {
"mytag1": "myvalue1"
}
}
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/UpdateJobAgent.json
// this example is just showing the usage of "JobAgents_Update" 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 SqlServerJobAgentResource created on azure
// for more information of creating SqlServerJobAgentResource, please refer to the document of SqlServerJobAgentResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
ResourceIdentifier sqlServerJobAgentResourceId = SqlServerJobAgentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName);
SqlServerJobAgentResource sqlServerJobAgent = client.GetSqlServerJobAgentResource(sqlServerJobAgentResourceId);
// invoke the operation
SqlServerJobAgentPatch patch = new SqlServerJobAgentPatch
{
Tags =
{
["mytag1"] = "myvalue1"
},
};
ArmOperation<SqlServerJobAgentResource> lro = await sqlServerJobAgent.UpdateAsync(WaitUntil.Completed, patch);
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
Exemple de réponse
{
"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"
}
}
Location: https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/locations/southeastasia/jobAgentOperationResults/00000000-1111-2222-3333-444444444444?api-version=2017-03-01-preview
Définitions
ErrorAdditionalInfo
Object
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
Object
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
Object
Réponse d’erreur
JobAgent
Object
Agent de travail Azure SQL.
| Nom |
Type |
Description |
|
id
|
string
|
ID de ressource.
|
|
identity
|
JobAgentIdentity
|
Identité de l’agent de travail.
|
|
location
|
string
|
Emplacement des ressources.
|
|
name
|
string
|
Nom de la ressource.
|
|
properties.databaseId
|
string
(arm-id)
|
ID de ressource de la base de données dans lequel stocker les métadonnées du travail.
|
|
properties.state
|
JobAgentState
|
État de l’agent de travail.
|
|
sku
|
Sku
|
Nom et niveau de la référence SKU.
|
|
tags
|
object
|
Balises de ressource.
|
|
type
|
string
|
Type de ressource.
|
JobAgentIdentity
Object
Configuration d’identité Azure Active Directory pour une ressource.
| Nom |
Type |
Description |
|
tenantId
|
string
(uuid)
|
ID de locataire de l’agent de travail
|
|
type
|
JobAgentIdentityType
|
Type d’identité de l’agent de travail
|
|
userAssignedIdentities
|
<string,
JobAgentUserAssignedIdentity>
|
ID de ressource des identités affectées par l’utilisateur à utiliser
|
JobAgentIdentityType
Énumération
Type d’identité de l’agent de travail
| Valeur |
Description |
|
None
|
|
|
SystemAssigned
|
|
|
UserAssigned
|
|
|
SystemAssignedUserAssigned
|
|
JobAgentState
Énumération
État de l’agent de travail.
| Valeur |
Description |
|
Creating
|
|
|
Ready
|
|
|
Updating
|
|
|
Deleting
|
|
|
Disabled
|
|
JobAgentUpdate
Object
Mise à jour d’un agent de travail Azure SQL.
| Nom |
Type |
Description |
|
identity
|
JobAgentIdentity
|
Identité managée affectée à l’agent de travail
|
|
sku
|
Sku
|
Nom et niveau de la référence SKU.
|
|
tags
|
object
|
Balises de ressource.
|
JobAgentUserAssignedIdentity
Object
Configuration d’identité Azure Active Directory pour une ressource.
| Nom |
Type |
Description |
|
clientId
|
string
(uuid)
|
ID client Azure Active Directory.
|
|
principalId
|
string
(uuid)
|
ID du principal Azure Active Directory.
|
Sku
Object
Référence SKU de ressource ARM.
| Nom |
Type |
Description |
|
capacity
|
integer
(int32)
|
Capacité de la référence SKU particulière.
|
|
family
|
string
|
Si le service a différentes générations de matériel, pour la même référence SKU, vous pouvez le capturer ici.
|
|
name
|
string
|
Nom de la référence SKU, généralement une lettre + code numérique, par exemple P3.
|
|
size
|
string
|
Taille de la référence SKU particulière
|
|
tier
|
string
|
Niveau ou édition de la référence SKU particulière, par exemple De base, Premium.
|