Partilhar 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 do URI

Name Em Necessá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 um UUID.
api-version
 query True

string

minLength: 1

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

Corpo do Pedido

Name Necessário Tipo Description
location True

string

A geolocalização onde o recurso vive
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 de emprego.
sku

Sku

O nome e a camada da SKU.
tags

object

Tags de recursos.

Respostas

Name Tipo Description
200 OK

JobAgent

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

JobAgent

Resource '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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

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

Pedido de amostra

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

Código de estado:
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 estado:
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 estado:
202

Create or update a job agent with identity

Pedido de amostra

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

Código de estado:
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 estado:
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 estado:
202

Create or update a job agent with sku.

Pedido de amostra

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

Código de estado:
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 estado:
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 estado:
202

Definições

Name Description
createdByType

O tipo de identidade que criou o recurso.
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
JobAgent

Um agente de empregos 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 de emprego.
JobAgentUserAssignedIdentity

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

Um SKU de recurso ARM.
systemData

Metadados referentes à 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

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

JobAgent

Object

Um agente de empregos SQL do Azure.

Name Tipo Description
id

string (arm-id)

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

JobAgentIdentity

A identidade do agente de emprego.
location

string

A geolocalização onde o recurso vive
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 de emprego.
sku

Sku

O nome e a camada da 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. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

JobAgentIdentity

Object

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

Name Tipo Description
tenantId

string (uuid)

O 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 ao usuário a serem usadas

JobAgentIdentityType

Enumeração

O tipo de identidade do agente de trabalho

Valor Description
None

Nenhum
SystemAssigned

Atribuído pelo Sistema
UserAssigned

UserAssigned
SystemAssignedUserAssigned

SystemAssignedUserAssigned

JobAgentState

Enumeração

O estado do agente de emprego.

Valor Description
Creating

Criação
Ready

Pronto/a
Updating

Atualização
Deleting

Apagar
Disabled

Disabled

JobAgentUserAssignedIdentity

Object

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

Name Tipo Description
clientId

string (uuid)

O ID do cliente do Azure Active Directory.
principalId

string (uuid)

O principal id do Azure Active Directory.

Sku

Object

Um SKU de recurso ARM.

Name Tipo Description
capacity

integer (int32)

Capacidade do SKU específico.
family

string

Se o serviço tiver diferentes gerações de hardware, para o mesmo SKU, isso pode ser capturado aqui.
name

string

O nome do SKU, normalmente, uma letra + código numérico, por exemplo, P3.
size

string

Tamanho do SKU específico
tier

string

O nível ou edição do SKU específico, por exemplo, Basic, Premium.

systemData

Object

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

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