Job Target Groups - Get
Ruft eine Zielgruppe ab.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}?api-version=2025-01-01
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
job
|
path | True |
string |
Der Name des abzurufenden Auftragsagenten. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet. |
|
server
|
path | True |
string |
Name des Servers |
|
subscription
|
path | True |
string (uuid) |
Die ID des Zielabonnements. Der Wert muss eine UUID sein. |
|
target
|
path | True |
string |
Der Name der Zielgruppe. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Azure-Operation erfolgreich abgeschlossen. |
|
| Other Status Codes |
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
Get a target group.
Beispielanforderung
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1?api-version=2025-01-01
Beispiel für eine Antwort
{
"name": "targetGroup1",
"type": "Microsoft.Sql/servers/jobAgents/targetGroups",
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
"properties": {
"members": [
{
"type": "SqlDatabase",
"databaseName": "database1",
"membershipType": "Exclude",
"serverName": "server1"
},
{
"type": "SqlServer",
"membershipType": "Include",
"refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential",
"serverName": "server1"
},
{
"type": "SqlElasticPool",
"elasticPoolName": "pool1",
"membershipType": "Include",
"refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential",
"serverName": "server2"
},
{
"type": "SqlShardMap",
"membershipType": "Include",
"refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential",
"serverName": "server3",
"shardMapName": "shardMap1"
}
]
}
}
Definitionen
| Name | Beschreibung |
|---|---|
|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
|
Error |
Der Ressourcenverwaltungsfehler zusätzliche Informationen. |
|
Error |
Das Fehlerdetails. |
|
Error |
Fehlerantwort |
|
Job |
Ein Auftragsziel, z. B. eine bestimmte Datenbank oder ein Container mit Datenbanken, die während der Auftragsausführung ausgewertet werden. |
|
Job |
Eine Gruppe von Auftragszielen. |
|
Job |
Gibt an, ob das Ziel in der Gruppe enthalten oder ausgeschlossen ist. |
|
Job |
Die Art des Ziels. |
|
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
| Wert | Beschreibung |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
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. |
JobTarget
Ein Auftragsziel, z. B. eine bestimmte Datenbank oder ein Container mit Datenbanken, die während der Auftragsausführung ausgewertet werden.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| databaseName |
string |
Der Name der Zieldatenbank. |
|
| elasticPoolName |
string |
Der Name des ziellastischen Pools. |
|
| membershipType | Include |
Gibt an, ob das Ziel in der Gruppe enthalten oder ausgeschlossen ist. |
|
| refreshCredential |
string |
Die Ressourcen-ID der Anmeldeinformationen, die während der Auftragsausführung verwendet werden, um eine Verbindung mit dem Ziel herzustellen und die Liste der Datenbanken innerhalb des Ziels zu bestimmen. |
|
| serverName |
string |
Der Zielservername. |
|
| shardMapName |
string |
Die Zielshardmap. |
|
| type |
Der Zieltyp. |
JobTargetGroup
Eine Gruppe von Auftragszielen.
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string (arm-id) |
Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
Der Name der Ressource |
| properties.members |
Mitglieder der Zielgruppe. |
|
| systemData |
Azure Resource Manager-Metadaten, die createdBy und modifiedBy-Informationen enthalten. |
|
| type |
string |
Der Typ der Ressource. Zum Beispiel "Microsoft. Compute/virtualMachines" oder "Microsoft. Speicher/Speicherkonten" |
JobTargetGroupMembershipType
Gibt an, ob das Ziel in der Gruppe enthalten oder ausgeschlossen ist.
| Wert | Beschreibung |
|---|---|
| Include |
Einbeziehen |
| Exclude |
Ausschließen |
JobTargetType
Die Art des Ziels.
| Wert | Beschreibung |
|---|---|
| TargetGroup |
Zielgruppe |
| SqlDatabase |
SqlDatabase |
| SqlElasticPool |
SqlElasticPool |
| SqlShardMap |
SqlShardMap |
| SqlServer |
SqlServer |
systemData
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 |
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 |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |