Job Agents - Create Or Update

Service:: SQL Database

API-versie:: 2023-08-01

Hiermee maakt of werkt u een taakagent bij.

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

URI-parameters

Name	In	Vereist	Type	Description
jobAgentName	path	True	string	De naam van de taakagent die moet worden gemaakt of bijgewerkt.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName	path	True	string	De naam van de server.
subscriptionId	path	True	string	De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version	query	True	string	De API-versie die moet worden gebruikt voor de aanvraag.

Aanvraagbody

Name	Vereist	Type	Description
location	True	string	Resourcelocatie.
properties.databaseId	True	string (arm-id)	Resource-id van de database waarin metagegevens van de taak moeten worden opgeslagen.
identity		JobAgentIdentity	De identiteit van de taakagent.
sku		Sku	De naam en laag van de SKU.
tags		object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	JobAgent	De taakagent is bijgewerkt.
201 Created	JobAgent	De taakagent is gemaakt.
202 Accepted		Geaccepteerd Kopteksten Location: string
Other Status Codes	ErrorResponse	Foutreacties: *** 400 ManagedInstanceStoppingOrStopped - Conflicterende bewerking verzonden terwijl het exemplaar de status gestopt/gestopt heeft 400 ManagedInstanceStarting - Conflicterende bewerking verzonden terwijl het exemplaar de beginstatus heeft 400 InvalidResourceRequestBody: de resource- of resource-eigenschappen in de hoofdtekst van de aanvraag zijn leeg of ongeldig. 400 MissingSkuName - SKU-naam is vereist. 400 InvalidDatabaseResourceId - Ongeldige databaseresource-id. 400 InvalidIdentityTenantId - tenantId kan niet worden opgegeven voor een aanvraag voor maken of bijwerken. 400 Niet-overeenkomendeSubscriptionWithUrl : het opgegeven abonnement komt niet overeen met het abonnement in de URL. 400 Komt niet overeen metResourceGroupNameWithUrl: de opgegeven resourcegroepnaam komt niet overeen met de naam in de URL. 400 Niet-overeenkomendeServerNameWithUrl : de opgegeven servernaam komt niet overeen met de naam in de URL. 400 MissingUserAssignedIdentities - identity.userAssignedIdentities moeten worden opgegeven wanneer identity.type gelijk is aan UserAssigned. 400 MissingIdentityType - Geef het identiteitstype op. 400 MultipleIdentitiesOnJobAgent: geef slechts één door de gebruiker beheerde identiteit per taakagent op. 400 InvalidIdentityType- Geef alleen identiteitstypen 'Geen' of 'UserAssigned' op. 400 SkuMismatchingNameCapacity: de opgegeven SKU-capaciteit komt niet overeen met de opgegeven SKU-naam. 400 ElasticJobAgentEditionUnsupported - De opgegeven SLO wordt niet ondersteund voor taakagent. Probeer het opnieuw met de ondersteunde SLO. 400 ElasticJobAgentObjectiveAssignmentInProgress - De SLO-toewijzing voor elastische taakagent '{0}' wordt momenteel uitgevoerd. Probeer het later opnieuw. 400 ElasticJobAgentEditionUnsupported - De opgegeven SLO wordt niet ondersteund voor taakagent. Probeer het opnieuw met de ondersteunde SLO. 400 DatabaseDoesNotExist - De aangevraagde database is niet gevonden 400 JobAgentExceededQuota - Kan geen taakagent maken omdat deze het quotum zou overschrijden. 400 JobAgentAlreadyExists : de taakagent bestaat al op de server. 400 JobAgentDatabaseEditionUnsupported : de serviceniveaudoelstelling van de opgegeven database wordt niet ondersteund voor gebruik als taakagentdatabase. 400 JobAgentDatabaseSecondary : een taakagent kan niet worden gekoppeld aan een geo-secundaire database. 400 JobAgentDatabaseAlreadyLinked: de opgegeven database is al gekoppeld aan een andere taakagent. 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase : serverloze database zonder automatische onderbreking wordt niet ondersteund als een elastische takendatabase omdat taakagent verhindert dat die database wordt onderbroken. U kunt automatisch onderbreken uitschakelen voor deze serverloze database of de taakagent verwijderen die deze database gebruikt. Zie hier voor meer informatie: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing 400 CannotUseReservedDatabaseName - Kan in deze bewerking geen gereserveerde databasenaam gebruiken. 404 ServerNotInSubscriptionResourceGroup - Opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement. 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden 404 SubscriptionNotFound - Het aangevraagde abonnement is niet gevonden. 404 PropertyChangeUnsupported - Eigenschap kan niet worden gewijzigd. 404 OperationIdNotFound - De bewerking met id bestaat niet. 409 ServerDisabled - Server is uitgeschakeld. 409 ElasticJobAgentOperationUnavailable - De bewerking '{0}' is geblokkeerd voor elastic job agent '{1}' omdat {2} 409 CannotCancelOperation - De beheerbewerking heeft een status die niet kan worden geannuleerd. 409 OperationCancelled - De bewerking is geannuleerd door de gebruiker. 409 Bewerking onderbroken: de bewerking op de resource kan niet worden voltooid omdat deze is onderbroken door een andere bewerking op dezelfde resource. 429 SubscriptionTooManyCreateUpdateRequests - Aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources. 429 SubscriptionTooManyRequests : aanvragen buiten het maximum aantal aanvragen dat kan worden verwerkt door beschikbare resources. 500 OperationTimedOut: er is een time-out opgetreden voor de bewerking en wordt automatisch teruggedraaid. Voer de bewerking opnieuw uit. 503 TooManyRequests : aanvragen die buiten het maximum aantal aanvragen kunnen worden verwerkt door beschikbare resources.

Voorbeelden

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

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

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

Statuscode:: 202

Create or update a job agent with identity

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

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

Statuscode:: 202

Create or update a job agent with sku.

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

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

Statuscode:: 202

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
JobAgent	Een Azure SQL-taakagent.
JobAgentIdentity	Azure Active Directory-identiteitsconfiguratie voor een resource.
JobAgentIdentityType	Het identiteitstype van de taakagent
JobAgentState	De status van de taakagent.
JobAgentUserAssignedIdentity	Azure Active Directory-identiteitsconfiguratie voor een resource.
Sku	Een ARM-resource-SKU.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

JobAgent

Object

Een Azure SQL-taakagent.

Name	Type	Description
id	string	Resource-id.
identity	JobAgentIdentity	De identiteit van de taakagent.
location	string	Resourcelocatie.
name	string	Resourcenaam.
properties.databaseId	string (arm-id)	Resource-id van de database waarin metagegevens van de taak moeten worden opgeslagen.
properties.state	JobAgentState	De status van de taakagent.
sku	Sku	De naam en laag van de SKU.
tags	object	Resourcetags.
type	string	Resourcetype.

JobAgentIdentity

Object

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name	Type	Description
tenantId	string (uuid)	De tenant-id van de taakagent-id
type	JobAgentIdentityType	Het identiteitstype van de taakagent
userAssignedIdentities	<string, JobAgentUserAssignedIdentity>	De resource-id's van de door de gebruiker toegewezen identiteiten die moeten worden gebruikt

JobAgentIdentityType

Opsomming

Het identiteitstype van de taakagent

Waarde	Description
None
SystemAssigned
UserAssigned
SystemAssignedUserAssigned

JobAgentState

Opsomming

De status van de taakagent.

Waarde	Description
Creating
Ready
Updating
Deleting
Disabled

JobAgentUserAssignedIdentity

Object

Azure Active Directory-identiteitsconfiguratie voor een resource.

Name	Type	Description
clientId	string (uuid)	De Azure Active Directory-client-id.
principalId	string (uuid)	De principal-id van Azure Active Directory.

Sku

Object

Een ARM-resource-SKU.

Name	Type	Description
capacity	integer (int32)	Capaciteit van de specifieke SKU.
family	string	Als de service verschillende generaties hardware heeft, voor dezelfde SKU, kan die hier worden vastgelegd.
name	string	De naam van de SKU, meestal een letter + cijfercode, bijvoorbeeld P3.
size	string	Grootte van de specifieke SKU
tier	string	De laag of editie van de specifieke SKU, bijvoorbeeld Basic, Premium.

Delen via

Job Agents - Create Or Update

URI-parameters

Aanvraagbody

Antwoorden

Voorbeelden

Create or update a job agent

Voorbeeldaanvraag

Voorbeeldrespons

Create or update a job agent with identity

Voorbeeldaanvraag

Voorbeeldrespons

Create or update a job agent with sku.

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JobAgent

JobAgentIdentity

JobAgentIdentityType

JobAgentState

JobAgentUserAssignedIdentity

Sku