Job Agents - Get

Dienst:

SQL Database

API-Version:

2023-08-01

Ruft einen Auftragsagenten ab.

GET 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 abzurufenden Auftragsagenten.
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.

Antworten

Name	Typ	Beschreibung
200 OK	JobAgent	Der angegebene Auftragsagent wurde erfolgreich abgerufen.
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 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 JobAgentNotFound – Der angegebene Auftrags-Agent ist nicht auf dem angegebenen logischen Server vorhanden. 409 ServerDisabled – Server ist deaktiviert.

Beispiele

Get a job agent

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1?api-version=2023-08-01

Beispiel für eine Antwort

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

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

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

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

JobAgentState

Enumeration

Der Status des Auftragsagenten.

Wert	Beschreibung
Creating
Deleting
Disabled
Ready
Updating

JobAgentUserAssignedIdentity

Objekt

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

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.