Compartir a través de

Job Agents - Update

  • Referencia
Servicio:
SQL Database
Versión de la API:
2023-08-01

Actualiza un agente de trabajo.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
jobAgentName
 path True

string

Nombre del agente de trabajo que se va a actualizar.
resourceGroupName
 path True

string

Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
serverName
 path True

string

Nombre del servidor.
subscriptionId
 path True

string

Identificador de suscripción que identifica una suscripción de Azure.
api-version
 query True

string

Versión de la API que se va a usar para la solicitud.

Cuerpo de la solicitud

Nombre Tipo Description
identity

JobAgentIdentity

Identidad administrada asignada al agente de trabajo
sku

Sku

Nombre y nivel de la SKU.
tags

object

Etiquetas de recursos.

Respuestas

Nombre Tipo Description
200 OK

JobAgent

Se actualizó correctamente el agente de trabajo.
202 Accepted

Aceptado

Encabezados

Location: string
Other Status Codes

ErrorResponse

Respuestas de error: ***

  • 400 ManagedInstanceStoppingOrStopped: operación en conflicto enviada mientras la instancia está en estado de detención o detención

  • 400 ManagedInstanceStarting: operación en conflicto enviada mientras la instancia está en estado de inicio

  • 400 InvalidResourceRequestBody: las propiedades de recurso o recurso del cuerpo de la solicitud están vacías o no son válidas.

  • 400 MissingIdentityType: especifique el tipo de identidad.

  • 400 MultipleIdentitiesOnJobAgent: especifique solo una identidad administrada por usuario por agente de trabajo.

  • 400 InvalidIdentityTenantId: no se puede especificar tenantId en una solicitud de creación o actualización.

  • 400 InvalidIdentityType: especifique solo los tipos de identidad "None" o "UserAssigned".

  • 400 SkuMismatchingNameCapacity: la capacidad de SKU proporcionada no coincide con el nombre de SKU proporcionado.

  • 400 ElasticJobAgentEditionUnsupported: el SLO especificado no se admite para el agente de trabajos. Vuelva a intentarlo con el SLO compatible.

  • 400 ElasticJobAgentObjectiveAssignmentInProgress: la asignación de SLO para el agente de trabajos elásticos "{0}" está actualmente en curso. Vuelva a intentar la operación más adelante.

  • 400 ElasticJobAgentEditionUnsupported: el SLO especificado no se admite para el agente de trabajos. Vuelva a intentarlo con el SLO compatible.

  • 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase: la base de datos sin servidor habilitada para pausa automática no se admite como una base de datos de trabajos elásticos porque el agente de trabajos impediría que esa base de datos se pausase. Puede deshabilitar la pausa automática en esta base de datos sin servidor o eliminar el agente de trabajo que usa esta base de datos. Consulte aquí para obtener más información: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing

  • 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

  • 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.

  • 404 JobAgentNotFound: el agente de trabajo especificado no existe en el servidor lógico especificado.

  • 404 PropertyChangeUnsupported: no se puede modificar la propiedad.

  • 404 OperationIdNotFound: la operación con id. no existe.

  • 409 ServerDisabled: el servidor está deshabilitado.

  • 409 ElasticJobAgentOperationUnavailable: la operación "{0}" está bloqueada para el agente de trabajos elásticos "{1}" porque {2}

  • 409 CannotCancelOperation: la operación de administración está en un estado que no se puede cancelar.

  • 409 OperationCancelled: el usuario canceló la operación.

  • 409 OperationInterrupted: no se pudo completar la operación en el recurso porque se interrumpió otra operación en el mismo recurso.

  • 429 SubscriptionTooManyCreateUpdateRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

  • 429 SubscriptionTooManyRequests: solicitudes más allá de las solicitudes máximas que los recursos disponibles pueden procesar.

  • 500 OperationTimedOut: la operación agota el tiempo de espera y se revierte automáticamente. Vuelva a intentar la operación.

  • 503 TooManyRequests: solicitudes más allá de las solicitudes máximas que pueden procesar los recursos disponibles.

Ejemplos

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

Update a job agent's identity.

Solicitud de ejemplo

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": {}
    }
  }
}

Respuesta de muestra

status code:
200 
{
  "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"
      }
    }
  }
}
status code:
202 
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.

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "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
  }
}
status code:
202 
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.

Solicitud de ejemplo

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

Respuesta de muestra

status code:
200 
{
  "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"
  }
}
status code:
202 
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

Definiciones

Nombre Description
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
JobAgent

Un agente de trabajo de Azure SQL.
JobAgentIdentity

Configuración de identidad de Azure Active Directory para un recurso.
JobAgentIdentityType

Tipo de identidad del agente de trabajo
JobAgentState

Estado del agente de trabajo.
JobAgentUpdate

Una actualización de un agente de trabajo de Azure SQL.
JobAgentUserAssignedIdentity

Configuración de identidad de Azure Active Directory para un recurso.
Sku

Una SKU de recursos de ARM.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

JobAgent

Object

Un agente de trabajo de Azure SQL.

Nombre Tipo Description
id

string

Identificador de recurso.
identity

JobAgentIdentity

Identidad del agente de trabajo.
location

string

Ubicación del recurso.
name

string

Nombre del recurso.
properties.databaseId

string (arm-id)

Identificador de recurso de la base de datos en el que se almacenarán los metadatos del trabajo.
properties.state

JobAgentState

Estado del agente de trabajo.
sku

Sku

Nombre y nivel de la SKU.
tags

object

Etiquetas de recursos.
type

string

Tipo de recurso.

JobAgentIdentity

Object

Configuración de identidad de Azure Active Directory para un recurso.

Nombre Tipo Description
tenantId

string (uuid)

Identificador de inquilino de identidad del agente de trabajo
type

JobAgentIdentityType

Tipo de identidad del agente de trabajo
userAssignedIdentities

<string,  JobAgentUserAssignedIdentity>

Identificadores de recursos de las identidades asignadas por el usuario que se van a usar

JobAgentIdentityType

Enumeración

Tipo de identidad del agente de trabajo

Valor Description
None
SystemAssigned
SystemAssignedUserAssigned
UserAssigned

JobAgentState

Enumeración

Estado del agente de trabajo.

Valor Description
Creating
Deleting
Disabled
Ready
Updating

JobAgentUpdate

Object

Una actualización de un agente de trabajo de Azure SQL.

Nombre Tipo Description
identity

JobAgentIdentity

Identidad administrada asignada al agente de trabajo
sku

Sku

Nombre y nivel de la SKU.
tags

object

Etiquetas de recursos.

JobAgentUserAssignedIdentity

Object

Configuración de identidad de Azure Active Directory para un recurso.

Nombre Tipo Description
clientId

string (uuid)

Identificador de cliente de Azure Active Directory.
principalId

string (uuid)

Identificador de entidad de seguridad de Azure Active Directory.

Sku

Object

Una SKU de recursos de ARM.

Nombre Tipo Description
capacity

integer (int32)

Capacidad de la SKU determinada.
family

string

Si el servicio tiene diferentes generaciones de hardware, para la misma SKU, se puede capturar aquí.
name

string

El nombre de la SKU, normalmente, una letra + código de número, por ejemplo, P3.
size

string

Tamaño de la SKU determinada
tier

string

Nivel o edición de la SKU concreta, por ejemplo, Básico, Premium.