Job Target Groups - Get
Obtient un groupe cible.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}?api-version=2025-01-01
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
job
|
path | True |
string |
Nom de l’agent de travail à récupérer. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nom du groupe de ressources. Le nom ne respecte pas la casse. |
|
server
|
path | True |
string |
Le nom du serveur |
|
subscription
|
path | True |
string (uuid) |
ID de l’abonnement cible. La valeur doit être un UUID. |
|
target
|
path | True |
string |
Nom du groupe cible. |
|
api-version
|
query | True |
string minLength: 1 |
Version de l’API à utiliser pour cette opération. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Opération Azure terminée avec succès. |
|
| Other Status Codes |
Réponse d’erreur inattendue. |
Sécurité
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
| Nom | Description |
|---|---|
| user_impersonation | emprunter l’identité de votre compte d’utilisateur |
Exemples
Get a target group.
Exemple de requête
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
Exemple de réponse
{
"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"
}
]
}
}
Définitions
| Nom | Description |
|---|---|
|
created |
Type d’identité qui a créé la ressource. |
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse d’erreur |
|
Job |
Une cible de travail, par exemple une base de données spécifique ou un conteneur de bases de données qui est évalué pendant l’exécution du travail. |
|
Job |
Groupe de cibles de travail. |
|
Job |
Indique si la cible est incluse ou exclue du groupe. |
|
Job |
Type de la cible. |
|
system |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
createdByType
Type d’identité qui a créé la ressource.
| Valeur | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
| Nom | Type | Description |
|---|---|---|
| info |
object |
Informations supplémentaires. |
| type |
string |
Type d’informations supplémentaire. |
ErrorDetail
Détail de l’erreur.
| Nom | Type | Description |
|---|---|---|
| additionalInfo |
Informations supplémentaires sur l’erreur. |
|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
ErrorResponse
Réponse d’erreur
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
JobTarget
Une cible de travail, par exemple une base de données spécifique ou un conteneur de bases de données qui est évalué pendant l’exécution du travail.
| Nom | Type | Valeur par défaut | Description |
|---|---|---|---|
| databaseName |
string |
Nom de la base de données cible. |
|
| elasticPoolName |
string |
Nom du pool élastique cible. |
|
| membershipType | Include |
Indique si la cible est incluse ou exclue du groupe. |
|
| refreshCredential |
string |
ID de ressource des informations d’identification utilisées pendant l’exécution du travail pour se connecter à la cible et déterminer la liste des bases de données à l’intérieur de la cible. |
|
| serverName |
string |
Nom du serveur cible. |
|
| shardMapName |
string |
Carte de partitions cible. |
|
| type |
Le type de cible. |
JobTargetGroup
Groupe de cibles de travail.
| Nom | Type | Description |
|---|---|---|
| id |
string (arm-id) |
ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} » |
| name |
string |
Nom de la ressource |
| properties.members |
Membres du groupe cible. |
|
| systemData |
Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy. |
|
| type |
string |
Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts" |
JobTargetGroupMembershipType
Indique si la cible est incluse ou exclue du groupe.
| Valeur | Description |
|---|---|
| Include |
Inclure |
| Exclude |
Exclure |
JobTargetType
Type de la cible.
| Valeur | Description |
|---|---|
| TargetGroup |
Groupe cible |
| SqlDatabase |
SqlDatabase |
| SqlElasticPool |
SqlElasticPool |
| SqlShardMap |
SqlShardMap |
| SqlServer |
SqlServer |
systemData
Métadonnées relatives à la création et à la dernière modification de la ressource.
| Nom | Type | Description |
|---|---|---|
| createdAt |
string (date-time) |
Horodatage de la création de ressources (UTC). |
| createdBy |
string |
Identité qui a créé la ressource. |
| createdByType |
Type d’identité qui a créé la ressource. |
|
| lastModifiedAt |
string (date-time) |
Horodatage de la dernière modification de ressource (UTC) |
| lastModifiedBy |
string |
Identité qui a modifié la ressource pour la dernière fois. |
| lastModifiedByType |
Type d’identité qui a modifié la ressource pour la dernière fois. |