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 |
|---|---|---|---|---|
|
job
|
path | True |
string |
Der Name des Auftragsagenten, der erstellt oder aktualisiert werden soll. |
|
resource
|
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. |
|
server
|
path | True |
string |
Der Name des Servers. |
|
subscription
|
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 |
Die Identität des Auftragsagenten. |
||
| sku |
Der Name und die Ebene der SKU. |
||
| tags |
object |
Ressourcentags. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Der Auftragsagent wurde erfolgreich aktualisiert. |
|
| 201 Created |
Der Auftragsagent wurde erfolgreich erstellt. |
|
| 202 Accepted |
Angenommen Header Location: string |
|
| Other Status Codes |
Fehlerantworten: ***
|
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 |
|---|---|
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Fehlerantwort |
|
Job |
Ein Azure SQL-Auftrags-Agent. |
|
Job |
Azure Active Directory-Identitätskonfiguration für eine Ressource. |
|
Job |
Der Identitätstyp des Auftrags-Agents |
|
Job |
Der Status des Auftragsagenten. |
|
Job |
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 |
Die zusätzlichen Informationen des Fehlers. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Das Fehlerziel. |
ErrorResponse
Fehlerantwort
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
JobAgent
Ein Azure SQL-Auftrags-Agent.
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string |
Ressourcen-ID. |
| identity |
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 |
Der Status des Auftragsagenten. |
|
| 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 |
Der Identitätstyp des Auftrags-Agents |
|
| userAssignedIdentities |
<string,
Job |
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. |