Ler em inglês

Partilhar via

Job Agents - Create Or Update

  • Referência
Serviço:
SQL Database
Versão da API:
2023-08-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=2023-08-01

Parâmetros do URI

Name Em Necessário Tipo Description
jobAgentName
 path True

string

O nome do agente de trabalho a ser criado ou atualizado.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
serverName
 path True

string

O nome do servidor.
subscriptionId
 path True

string

A ID de assinatura que identifica uma assinatura do Azure.
api-version
 query True

string

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

Corpo do Pedido

Name Necessário Tipo Description
location True

string

Localização do recurso.
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

Atualizado com êxito o agente de trabalho.
201 Created

JobAgent

Criado com sucesso o agente de trabalho.
202 Accepted

Aceito

Cabeçalhos

Location: string
Other Status Codes

ErrorResponse

Respostas de erro: ***

  • 400 ManagedInstanceStoppingOrStopped - Operação conflitante enviada enquanto a instância está no estado de parada/parada

  • 400 ManagedInstanceStarting - Operação conflitante enviada enquanto a instância está no estado inicial

  • 400 InvalidResourceRequestBody - As propriedades do recurso ou do recurso no corpo da solicitação estão vazias ou são inválidas.

  • 400 MissingSkuName - O nome do Sku é necessário.

  • 400 InvalidDatabaseResourceId - Identificador de recurso de banco de dados inválido.

  • 400 InvalidIdentityTenantId - tenantId não pode ser especificado em uma solicitação de criação ou atualização.

  • 400 MismatchingSubscriptionWithUrl - A assinatura fornecida não correspondeu à assinatura na Url.

  • 400 MismatchingResourceGroupNameWithUrl - O nome do grupo de recursos fornecido não correspondia ao nome na Url.

  • 400 MismatchingServerNameWithUrl - O nome do servidor fornecido não correspondeu ao nome na Url.

  • 400 MissingUserAssignedIdentities - identity.userAssignedIdentities deve ser fornecido quando identity.type é igual a "UserAssigned".

  • 400 MissingIdentityType - Especifique o tipo de identidade.

  • 400 MultipleIdentitiesOnJobAgent - Especifique apenas uma identidade gerenciada pelo usuário por agente de trabalho.

  • 400 InvalidIdentityType - Especifique apenas os tipos de identidade "None" ou "UserAssigned".

  • 400 SkuMismatchingNameCapacity - A capacidade de SKU fornecida não corresponde ao nome de SKU fornecido.

  • 400 ElasticJobAgentEditionUnsupported - O SLO fornecido não é suportado para o agente de trabalho. Tente novamente com o SLO suportado.

  • 400 ElasticJobAgentObjectiveAssignmentInProgress - A atribuição SLO para o agente de trabalho elástico '{0}' está atualmente em andamento. Tente novamente a operação mais tarde.

  • 400 ElasticJobAgentEditionUnsupported - O SLO fornecido não é suportado para o agente de trabalho. Tente novamente com o SLO suportado.

  • 400 DatabaseDoesNotExist - O banco de dados solicitado não foi encontrado

  • 400 JobAgentExceededQuota - Não foi possível criar agente de trabalho porque ele excederia a cota.

  • 400 JobAgentAlreadyExists - O agente de trabalho já existe no servidor.

  • 400 JobAgentDatabaseEditionUnsupported - O objetivo de nível de serviço do banco de dados especificado não é suportado para uso como um banco de dados de agente de trabalho.

  • 400 JobAgentDatabaseSecondary - Um agente de trabalho não pode ser vinculado a um banco de dados geosecundário.

  • 400 JobAgentDatabaseAlreadyLinked - O banco de dados especificado já está vinculado a outro agente de trabalho.

  • 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase - O banco de dados sem servidor habilitado para pausa automática não é suportado como um banco de dados Elastic Jobs porque o agente de trabalho impediria que esse banco de dados fosse pausado. Você pode desabilitar a pausa automática neste banco de dados sem servidor ou excluir o agente de trabalho que está usando esse banco de dados. Veja aqui mais detalhes: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing

  • 400 CannotUseReservedDatabaseName - Não é possível usar o nome do banco de dados reservado nesta operação.

  • 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na assinatura especificados.

  • 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado

  • 404 SubscriptionNotFound - A assinatura solicitada não foi encontrada.

  • 404 PropertyChangeUnsupported - A propriedade não pode ser modificada.

  • 404 OperationIdNotFound - A operação com Id não existe.

  • 409 ServerDisabled - O servidor está desativado.

  • 409 ElasticJobAgentOperationUnavailable - A operação '{0}' está bloqueada para o Elastic Job Agent '{1}' porque {2}

  • 409 CannotCancelOperation - A operação de gerenciamento está em um estado que não pode ser cancelado.

  • 409 OperationCancelled - A operação foi cancelada pelo usuário.

  • 409 OperationInterrupted - A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso.

  • 429 SubscriptionTooManyCreateUpdateRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

  • 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

  • 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Por favor, tente novamente a operação.

  • 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

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=2023-08-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 
{
  "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",
  "sku": {
    "name": "JA100",
    "capacity": 100
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}
Código de estado:
201 
{
  "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",
  "sku": {
    "name": "JA100",
    "capacity": 100
  },
  "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 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=2023-08-01

{
  "location": "southeastasia",
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi": {}
    }
  },
  "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 
{
  "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",
  "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"
      }
    }
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}
Código de estado:
201 
{
  "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",
  "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"
      }
    }
  },
  "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=2023-08-01

{
  "location": "southeastasia",
  "sku": {
    "name": "JA400"
  },
  "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 
{
  "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",
  "sku": {
    "name": "JA400",
    "capacity": 400
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}
Código de estado:
201 
{
  "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",
  "sku": {
    "name": "JA400",
    "capacity": 400
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}
Código de estado:
202

Definições

Name Description
ErrorAdditionalInfo

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

O detalhe do erro.
ErrorResponse

Resposta de erro
JobAgent

Um agente de trabalho SQL do Azure.
JobAgentIdentity

Configuração de identidade do Azure Ative 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 Ative Directory para um recurso.
Sku

Um SKU de recurso ARM.

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 destino do erro.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

JobAgent

Object

Um agente de trabalho SQL do Azure.

Name Tipo Description
id

string

ID do recurso.
identity

JobAgentIdentity

A identidade do agente de emprego.
location

string

Localização do recurso.
name

string

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

object

Tags de recursos.
type

string

Tipo de recurso.

JobAgentIdentity

Object

Configuração de identidade do Azure Ative 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
SystemAssigned
SystemAssignedUserAssigned
UserAssigned

JobAgentState

Enumeração

O estado do agente de emprego.

Valor Description
Creating
Deleting
Disabled
Ready
Updating

JobAgentUserAssignedIdentity

Object

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

Name Tipo Description
clientId

string (uuid)

A ID do cliente do Azure Ative Directory.
principalId

string (uuid)

A ID principal do Azure Ative 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.