Compartilhar via

Job Agents - Create Or Update

Serviço:
SQL Database
Versão da API:
2025-01-01

Cria ou atualiza um agente de trabalho.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
jobAgentName
 path True

string

O nome do agente de trabalho a ser recuperado.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName
 path True

string

O nome do servidor.
subscriptionId
 path True

string (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Obrigatório Tipo Description
location True

string

A localização geográfica onde o recurso reside
properties.databaseId True

string (arm-id)

ID do recurso do banco de dados no qual armazenar metadados de trabalho.
identity

JobAgentIdentity

A identidade do agente do trabalho.
sku

Sku

O nome e a camada do SKU.
tags

object

Tags de recursos.

Respostas

Nome Tipo Description
200 OK

JobAgent

Operação de atualização do recurso 'JobAgent' bem-sucedida
201 Created

JobAgent

Recurso 'JobAgent' criar operação bem-sucedida

Cabeçalhos

  • Location: string
  • Retry-After: integer
202 Accepted

Operação de recurso aceita.

Cabeçalhos

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Create or update a job agent
Create or update a job agent with identity
Create or update a job agent with sku.

Create or update a job agent

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2025-01-01

{
  "location": "southeastasia",
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

Resposta de exemplo

Código de status:
200 
{
  "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": "JA100",
    "capacity": 100
  }
}
Código de status:
201 
{
  "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": "JA100",
    "capacity": 100
  }
}
Código de status:
202

Create or update a job agent with identity

Solicitação de exemplo

PUT 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": {}
    }
  },
  "location": "southeastasia",
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

Resposta de exemplo

Código de status:
200 
{
  "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": "0c29d9b7-0ae2-4014-96ea-faf8e0cf2bc7",
        "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"
  }
}
Código de status:
201 
{
  "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": "0c29d9b7-0ae2-4014-96ea-faf8e0cf2bc7",
        "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"
  }
}
Código de status:
202

Create or update a job agent with sku.

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2025-01-01

{
  "location": "southeastasia",
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  },
  "sku": {
    "name": "JA400"
  }
}

Resposta de exemplo

Código de status:
200 
{
  "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": "JA400",
    "capacity": 400
  }
}
Código de status:
201 
{
  "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": "JA400",
    "capacity": 400
  }
}
Código de status:
202

Definições

Nome Description
createdByType

O tipo de identidade que criou o recurso.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
JobAgent

Um agente de trabalho SQL do Azure.
JobAgentIdentity

Configuração de identidade do Azure Active Directory para um recurso.
JobAgentIdentityType

O tipo de identidade do agente de trabalho
JobAgentState

O estado do agente do trabalho.
JobAgentUserAssignedIdentity

Configuração de identidade do Azure Active Directory para um recurso.
Sku

Um SKU de recurso do ARM.
systemData

Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

JobAgent

Objeto

Um agente de trabalho SQL do Azure.

Nome Tipo Description
id

string (arm-id)

ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity

JobAgentIdentity

A identidade do agente do trabalho.
location

string

A localização geográfica onde o recurso reside
name

string

O nome do recurso
properties.databaseId

string (arm-id)

ID do recurso do banco de dados no qual armazenar metadados de trabalho.
properties.state

JobAgentState

O estado do agente do trabalho.
sku

Sku

O nome e a camada do SKU.
systemData

systemData

Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
tags

object

Tags de recursos.
type

string

O tipo do recurso. Por exemplo, "Microsoft. Compute/virtualMachines" ou "Microsoft. ContasArmazenamento/Armazenamento"

JobAgentIdentity

Objeto

Configuração de identidade do Azure Active Directory para um recurso.

Nome Tipo Description
tenantId

string (uuid)

A ID do locatário de identidade do agente de trabalho
type

JobAgentIdentityType

O tipo de identidade do agente de trabalho
userAssignedIdentities

<string,  JobAgentUserAssignedIdentity>

As IDs de recurso das identidades atribuídas pelo usuário a serem usadas

JobAgentIdentityType

Enumeração

O tipo de identidade do agente de trabalho

Valor Description
None

Nenhum
SystemAssigned

AtribuídoPeloSistema
UserAssigned

UserAssigned
SystemAssignedUserAssigned

SystemAssignedUserAssigned

JobAgentState

Enumeração

O estado do agente do trabalho.

Valor Description
Creating

Criando
Ready

Pronto
Updating

Atualização
Deleting

Excluir
Disabled

Desactivado

JobAgentUserAssignedIdentity

Objeto

Configuração de identidade do Azure Active Directory para um recurso.

Nome Tipo Description
clientId

string (uuid)

O ID do cliente do Azure Active Directory.
principalId

string (uuid)

O principal id do Azure Active Directory.

Sku

Objeto

Um SKU de recurso do ARM.

Nome Tipo Description
capacity

integer (int32)

Capacidade da SKU específica.
family

string

Se o serviço tiver diferentes gerações de hardware, para a mesma SKU, isso poderá ser capturado aqui.
name

string

O nome da SKU, normalmente, uma letra + código de número, por exemplo, P3.
size

string

Tamanho da SKU específica
tier

string

A camada ou edição da SKU específica, por exemplo, Basic, Premium.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.