Freigeben über


Job Agents - Create Or Update

Erstellt oder aktualisiert einen Auftragsagenten.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
jobAgentName
path True

string

Der Name des Auftragsagenten, der erstellt oder aktualisiert werden soll.

resourceGroupName
path True

string

Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.

serverName
path True

string

Der Name des Servers.

subscriptionId
path True

string

Die Abonnement-ID, die ein Azure-Abonnement identifiziert.

api-version
query True

string

Die API-Version, die für die Anforderung verwendet werden soll.

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Ressourcenspeicherort.

properties.databaseId True

string (arm-id)

Ressourcen-ID der Datenbank zum Speichern von Auftragsmetadaten

identity

JobAgentIdentity

Die Identität des Auftragsagenten.

sku

Sku

Der Name und die Ebene der SKU.

tags

object

Ressourcentags.

Antworten

Name Typ Beschreibung
200 OK

JobAgent

Der Auftragsagent wurde erfolgreich aktualisiert.

201 Created

JobAgent

Der Auftragsagent wurde erfolgreich erstellt.

202 Accepted

Angenommen

Header

Location: string

Other Status Codes

ErrorResponse

Fehlerantworten: ***

  • 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird

  • 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt

  • 400 InvalidResourceRequestBody – Die Ressourcen- oder Ressourceneigenschaften im Anforderungstext sind leer oder ungültig.

  • 400 MissingSkuName – Sku-Name ist erforderlich.

  • 400 InvalidDatabaseResourceId – Ungültiger Datenbankressourcenbezeichner.

  • 400 InvalidIdentityTenantId – tenantId kann nicht für eine Erstellungs- oder Aktualisierungsanforderung angegeben werden.

  • 400 MismatchingSubscriptionWithUrl – Das bereitgestellte Abonnement stimmte nicht mit dem Abonnement in der URL überein.

  • 400 MismatchingResourceGroupNameWithUrl – Der angegebene Ressourcengruppenname stimmte nicht mit dem Namen in der URL überein.

  • 400 MismatchingServerNameWithUrl – Der angegebene Servername stimmte nicht mit dem Namen in der URL überein.

  • 400 MissingUserAssignedIdentities – identity.userAssignedIdentities muss angegeben werden, wenn "identity.type" gleich "UserAssigned" ist.

  • 400 MissingIdentityType – Geben Sie den Identitätstyp an.

  • 400 MultipleIdentitiesOnJobAgent – Geben Sie nur eine vom Benutzer verwaltete Identität pro Auftrags-Agent an.

  • 400 InvalidIdentityType – Geben Sie nur die Identitätstypen "None" oder "UserAssigned" an.

  • 400 SkuMismatchingNameCapacity – Die bereitgestellte SKU-Kapazität stimmt nicht mit dem angegebenen SKU-Namen überein.

  • 400 ElasticJobAgentEditionUnsupported – Der angegebene SLO wird für job agent nicht unterstützt. Versuchen Sie es mit dem unterstützten SLO erneut.

  • 400 ElasticJobAgentObjectiveAssignmentInProgress - Die SLO-Zuordnung für elastic Job Agent '{0}' ist derzeit in Bearbeitung. Versuchen Sie es später erneut.

  • 400 ElasticJobAgentEditionUnsupported – Der angegebene SLO wird für job agent nicht unterstützt. Versuchen Sie es mit dem unterstützten SLO erneut.

  • 400 DatabaseDoesNotExist - Die angeforderte Datenbank wurde nicht gefunden

  • 400 JobAgentExceededQuota – Der Auftragsagent konnte nicht erstellt werden, da es das Kontingent überschreitet.

  • 400 JobAgentAlreadyExists – Der Auftrags-Agent ist bereits auf dem Server vorhanden.

  • 400 JobAgentDatabaseEditionUnsupported – Das Ziel der angegebenen Datenbank auf Dienstebene wird für die Verwendung als Auftrags-Agent-Datenbank nicht unterstützt.

  • 400 JobAgentDatabaseSecondary – Ein Auftragsagent kann nicht mit einer geo-sekundären Datenbank verknüpft werden.

  • 400 JobAgentDatabaseAlreadyLinked – Die angegebene Datenbank ist bereits mit einem anderen Auftragsagent verknüpft.

  • 400 ElasticJobsNotSupportedOnAutoPauseEnabledDatabase – Auto-Pause aktivierte serverlose Datenbank wird nicht als Elastic Jobs-Datenbank unterstützt, da der Auftrags-Agent verhindern würde, dass diese Datenbank angehalten wird. Sie können die automatische Pause in dieser serverlosen Datenbank deaktivieren oder den Auftrags-Agent löschen, der diese Datenbank verwendet. Weitere Informationen finden Sie hier: https://docs.microsoft.com/azure/azure-sql/database/serverless-tier-overview#auto-pausing

  • 400 CannotUseReservedDatabaseName – In diesem Vorgang kann kein reservierter Datenbankname verwendet werden.

  • 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden.

  • 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden.

  • 404 SubscriptionNotFound – Das angeforderte Abonnement wurde nicht gefunden.

  • 404 PropertyChangeUnsupported - Eigenschaft kann nicht geändert werden.

  • 404 OperationIdNotFound – Der Vorgang mit der ID ist nicht vorhanden.

  • 409 ServerDisabled – Server ist deaktiviert.

  • 409 ElasticJobAgentOperationUnavailable - Der Vorgang '{0}' wird für Elastic Job Agent '{1}' blockiert, weil {2}

  • 409 CannotCancelOperation – Der Verwaltungsvorgang befindet sich in einem Zustand, der nicht abgebrochen werden kann.

  • 409 OperationCancelled – Der Vorgang wurde vom Benutzer abgebrochen.

  • 409 OperationInterrupted – Der Vorgang für die Ressource konnte nicht abgeschlossen werden, weil er durch einen anderen Vorgang in derselben Ressource unterbrochen wurde.

  • 429 SubscriptionTooManyCreateUpdateRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

  • 429 SubscriptionTooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

  • 500 OperationTimedOut – Timeout des Vorgangs und automatisches Zurücksetzen. Versuchen Sie den Vorgang erneut.

  • 503 TooManyRequests – Anforderungen über max. Anforderungen hinaus, die von verfügbaren Ressourcen verarbeitet werden können.

Beispiele

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Create or update a job agent with identity

Beispielanforderung

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

Beispiel für eine Antwort

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

Create or update a job agent with sku.

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

ErrorDetail

Das Fehlerdetails.

ErrorResponse

Fehlerantwort

JobAgent

Ein Azure SQL-Auftrags-Agent.

JobAgentIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

JobAgentIdentityType

Der Identitätstyp des Auftrags-Agents

JobAgentState

Der Status des Auftragsagenten.

JobAgentUserAssignedIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Sku

Eine ARM-Ressourcen-SKU.

ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.

type

string

Der zusätzliche Informationstyp.

ErrorDetail

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

JobAgent

Ein Azure SQL-Auftrags-Agent.

Name Typ Beschreibung
id

string

Ressourcen-ID.

identity

JobAgentIdentity

Die Identität des Auftragsagenten.

location

string

Ressourcenspeicherort.

name

string

Ressourcenname.

properties.databaseId

string (arm-id)

Ressourcen-ID der Datenbank zum Speichern von Auftragsmetadaten

properties.state

JobAgentState

Der Status des Auftragsagenten.

sku

Sku

Der Name und die Ebene der SKU.

tags

object

Ressourcentags.

type

string

Ressourcentyp.

JobAgentIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Name Typ Beschreibung
tenantId

string (uuid)

Die Id des Auftrags-Agent-Identitätsmandanten

type

JobAgentIdentityType

Der Identitätstyp des Auftrags-Agents

userAssignedIdentities

<string,  JobAgentUserAssignedIdentity>

Die Ressourcen-IDs der vom Benutzer zugewiesenen Identitäten, die verwendet werden sollen

JobAgentIdentityType

Der Identitätstyp des Auftrags-Agents

Wert Beschreibung
None
SystemAssigned
UserAssigned
SystemAssignedUserAssigned

JobAgentState

Der Status des Auftragsagenten.

Wert Beschreibung
Creating
Ready
Updating
Deleting
Disabled

JobAgentUserAssignedIdentity

Azure Active Directory-Identitätskonfiguration für eine Ressource.

Name Typ Beschreibung
clientId

string (uuid)

Die Azure Active Directory-Client-ID.

principalId

string (uuid)

Die Azure Active Directory-Prinzipal-ID.

Sku

Eine ARM-Ressourcen-SKU.

Name Typ Beschreibung
capacity

integer (int32)

Kapazität der jeweiligen SKU.

family

string

Wenn der Dienst über unterschiedliche Hardwaregenerationen verfügt, kann dies für dieselbe SKU hier erfasst werden.

name

string

Der Name der SKU, in der Regel ein Buchstabe + Zahlencode, z. B. P3.

size

string

Größe der jeweiligen SKU

tier

string

Die Stufe oder Edition der jeweiligen SKU, z. B. Basic, Premium.