Job Agents - Update

Met à jour un agent de travail.

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

Paramètres URI

Nom Dans Obligatoire Type Description
jobAgentName
path True

string

Nom de l’agent de travail à récupérer.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serverName
path True

string

Le nom du serveur

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

Opération Azure terminée avec succès.

202 Accepted

Demande de mise à jour de ressource acceptée.

En-têtes

  • Location: string
  • Retry-After: integer
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

Update a job agent's identity.
Update a job agent's sku.
Update a job agent's tags.

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

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi": {}
    }
  }
}

Exemple de réponse

{
  "name": "agent1",
  "type": "Microsoft.Sql/servers/jobAgents",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1",
  "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": "southeastasia",
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}
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=2025-01-01

{
  "sku": {
    "name": "JA200"
  }
}

Exemple de réponse

{
  "name": "agent1",
  "type": "Microsoft.Sql/servers/jobAgents",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1",
  "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

Update a job agent's tags.

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

{
  "tags": {
    "mytag1": "myvalue1"
  }
}

Exemple de réponse

{
  "name": "agent1",
  "type": "Microsoft.Sql/servers/jobAgents",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1",
  "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

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

JobAgent

Un agent de jobs Azure SQL.

JobAgentIdentity

Configuration d’identité Azure Active Directory pour une ressource.

JobAgentIdentityType

Type d’identité de l’agent de travail

JobAgentState

État de l’agent de travail.

JobAgentUpdate

Une mise à jour d’un agent de jobs Azure SQL.

JobAgentUserAssignedIdentity

Configuration d’identité Azure Active Directory pour une ressource.

Sku

Référence SKU de ressource ARM.

systemData

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

createdByType

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

Valeur Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

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

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

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

JobAgent

Un agent de jobs Azure SQL.

Nom Type Description
id

string (arm-id)

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

identity

JobAgentIdentity

Identité de l’agent de travail.

location

string

Emplacement géographique où réside la ressource

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.

systemData

systemData

Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.

tags

object

Balises de ressource.

type

string

Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

JobAgentIdentity

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

Type d’identité de l’agent de travail

Valeur Description
None

Aucun

SystemAssigned

Attribué par le système

UserAssigned

UserAssigned

SystemAssignedUserAssigned

SystemAssignedUserAssigned

JobAgentState

État de l’agent de travail.

Valeur Description
Creating

Création

Ready

Prêt

Updating

Mise à jour

Deleting

Suppression

Disabled

Désactivé

JobAgentUpdate

Une mise à jour d’un agent de jobs 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

Configuration d’identité Azure Active Directory pour une ressource.

Nom Type Description
clientId

string (uuid)

L’ID client Azure Active Directory.

principalId

string (uuid)

L’ID principal d’Azure Active Directory.

Sku

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.

systemData

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.