Job Agents - Create Or Update

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

Nome	Em	Obrigató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 na API do Azure Resource Manager ou no portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID da 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 da solicitação

Nome	Obrigatório	Tipo	Description
location	True	string	Local 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 do trabalho.
sku		Sku	O nome e a camada do SKU.
tags		object	Marcas de recurso.

Respostas

Nome	Tipo	Description
200 OK	JobAgent	Atualizou com êxito o agente de trabalho.
201 Created	JobAgent	Criou com êxito o agente de trabalho.
202 Accepted		Aceitado 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 de recurso ou recurso no corpo da solicitação estão vazias ou 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 correspondeu 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 determinado não tem suporte para agente de trabalho. Tente novamente com o SLO com suporte. 400 ElasticJobAgentObjectiveAssignmentInProgress - A atribuição SLO para o agente de trabalho elástico '{0}' está em andamento no momento. Tente novamente a operação mais tarde. 400 ElasticJobAgentEditionUnsupported – O SLO determinado não tem suporte para agente de trabalho. Tente novamente com o SLO com suporte. 400 DatabaseDoesNotExist – O banco de dados solicitado não foi encontrado 400 JobAgentExceededQuota – Não foi possível criar um 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 tem suporte para uso como um banco de dados do agente de trabalho. 400 JobAgentDatabaseSecondary – Um agente de trabalho não pode ser vinculado a um banco de dados geográfico secundá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 tem suporte como um banco de dados de Trabalhos Elásticos porque o agente de trabalho impediria que esse banco de dados pausasse. 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á desabilitado. 409 ElasticJobAgentOperationUnavailable – A operação '{0}' está bloqueada para o agente de trabalho elástico '{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 por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 500 OperationTimedOut – A operação atingiu o tempo limite e foi revertida automaticamente. Tente novamente a operação. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por 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

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobAgent.json
// this example is just showing the usage of "JobAgents_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerJobAgentResource
SqlServerJobAgentCollection collection = sqlServer.GetSqlServerJobAgents();

// invoke the operation
string jobAgentName = "agent1";
SqlServerJobAgentData data = new SqlServerJobAgentData(new AzureLocation("southeastasia"))
{
    DatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"),
};
ArmOperation<SqlServerJobAgentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, jobAgentName, data);
SqlServerJobAgentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobAgentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

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

Create or update a job agent with identity

Solicitação de exemplo

HTTP
dotnet

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobAgentWithIdentity.json
// this example is just showing the usage of "JobAgents_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerJobAgentResource
SqlServerJobAgentCollection collection = sqlServer.GetSqlServerJobAgents();

// invoke the operation
string jobAgentName = "agent1";
SqlServerJobAgentData data = new SqlServerJobAgentData(new AzureLocation("southeastasia"))
{
    Identity = new JobAgentIdentity(JobAgentIdentityType.UserAssigned)
    {
        UserAssignedIdentities =
        {
        ["/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test-umi"] = new UserAssignedIdentity()
        },
    },
    DatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"),
};
ArmOperation<SqlServerJobAgentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, jobAgentName, data);
SqlServerJobAgentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobAgentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

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

Create or update a job agent with sku.

Solicitação de exemplo

HTTP
dotnet

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/CreateOrUpdateJobAgentWithSku.json
// this example is just showing the usage of "JobAgents_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerJobAgentResource
SqlServerJobAgentCollection collection = sqlServer.GetSqlServerJobAgents();

// invoke the operation
string jobAgentName = "agent1";
SqlServerJobAgentData data = new SqlServerJobAgentData(new AzureLocation("southeastasia"))
{
    Sku = new SqlSku("JA400"),
    DatabaseId = new ResourceIdentifier("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"),
};
ArmOperation<SqlServerJobAgentResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, jobAgentName, data);
SqlServerJobAgentResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlServerJobAgentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

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

Definições

Nome	Description
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 do 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.

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 do SQL do Azure.

Nome	Tipo	Description
id	string	ID do recurso.
identity	JobAgentIdentity	A identidade do agente do trabalho.
location	string	Local 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 do trabalho.
sku	Sku	O nome e a camada do SKU.
tags	object	Marcas de recurso.
type	string	Tipo de recurso.

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
SystemAssigned
UserAssigned
SystemAssignedUserAssigned

JobAgentState

Enumeração

O estado do agente do trabalho.

Valor	Description
Creating
Ready
Updating
Deleting
Disabled

JobAgentUserAssignedIdentity

Objeto

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

Nome	Tipo	Description
clientId	string (uuid)	A ID do cliente do Azure Active Directory.
principalId	string (uuid)	A ID da entidade de segurança 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.

Compartilhar via

Job Agents - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Exemplos

Create or update a job agent

Solicitação de exemplo

Resposta de exemplo

Create or update a job agent with identity

Solicitação de exemplo

Resposta de exemplo

Create or update a job agent with sku.

Solicitação de exemplo

Resposta de exemplo

Definições

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JobAgent

JobAgentIdentity

JobAgentIdentityType

JobAgentState

JobAgentUserAssignedIdentity

Sku