Freigeben über

Job Agents - Create Or Update

Dienst:
SQL Database
API-Version:
2025-01-01

Erstellt oder aktualisiert einen Auftragsagenten.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
jobAgentName
 path True

string

Der Name des abzurufenden Auftragsagenten.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serverName
 path True

string

Name des Servers
subscriptionId
 path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version
 query True

string

minLength: 1

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

Anforderungstext

Name Erforderlich Typ Beschreibung
location True

string

Der geografische Standort, an dem sich die Ressource befindet
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

Die Aktualisierung der Ressource 'JobAgent' war erfolgreich
201 Created

JobAgent

Die Erstellungsoperation der Ressource 'JobAgent' war erfolgreich

Header

  • Location: string
  • Retry-After: integer
202 Accepted

Ressourcenvorgang akzeptiert.

Header

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

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=2025-01-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

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

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

Beispiel für eine Antwort

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

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort
JobAgent

Ein Azure SQL Job 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.
systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

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

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

JobAgent

Objekt

Ein Azure SQL Job Agent.

Name Typ Beschreibung
id

string (arm-id)

Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity

JobAgentIdentity

Die Identität des Auftragsagenten.
location

string

Der geografische Standort, an dem sich die Ressource befindet
name

string

Der Name der Ressource
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.
systemData

systemData

Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten.
tags

object

Ressourcentags.
type

string

Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten"

JobAgentIdentity

Objekt

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

Enumeration

Der Identitätstyp des Auftrags-Agents

Wert Beschreibung
None

Nichts
SystemAssigned

SystemAssigned
UserAssigned

UserAssigned
SystemAssignedUserAssigned

SystemAssignedUserAssigned

JobAgentState

Enumeration

Der Status des Auftragsagenten.

Wert Beschreibung
Creating

Erstellen
Ready

Bereit
Updating

Aktualisieren
Deleting

Löschen
Disabled

Deaktiviert

JobAgentUserAssignedIdentity

Objekt

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

Name Typ Beschreibung
clientId

string (uuid)

Die Client-ID von Azure Active Directory.
principalId

string (uuid)

Die Azure Active Directory principal id.

Sku

Objekt

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.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string (date-time)

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string (date-time)

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.