Job Target Groups - Create Or Update

Référence

Service:: SQL Database

API Version:: 2021-11-01

Crée ou met à jour un groupe cible.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
jobAgentName	path	True	string	Nom de l’agent de travail.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
targetGroupName	path	True	string	Nom du groupe cible.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.members	True	JobTarget[]	Membres du groupe cible.

Réponses

Nom	Type	Description
200 OK	JobTargetGroup	Mise à jour réussie du groupe cible.
201 Created	JobTargetGroup	Le groupe cible a été créé.
Other Status Codes		Réponses d’erreur : *** 400 InvalidResourceRequestBody : la ressource ou les propriétés de ressource dans le corps de la demande sont vides ou non valides. 400 InvalidResourceId : identificateur de ressource non valide. 400 MismatchingSubscriptionWithUrl : l’abonnement fourni ne correspond pas à l’abonnement dans l’URL. 400 Non correspondanceResourceGroupNameWithUrl : le nom du groupe de ressources fourni ne correspond pas au nom dans l’URL. 400 MismatchingServerNameWithUrl : le nom du serveur fourni ne correspond pas au nom dans l’URL. 400 Non correspondanceJobAccountNameWithUrl : le nom du compte de travail fourni ne correspond pas au nom dans l’URL. 400 ElasticJobsOperationFailed : échec de l’opération de gestion des travaux élastiques. 400 ElasticJobsOperationFailed : échec de l’opération de gestion des travaux élastiques. 404 JobAgentNotFound : l’agent de travail spécifié n’existe pas dans le serveur logique spécifié. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.

Nom

Type

Description

200 OK

JobTargetGroup

Mise à jour réussie du groupe cible.

201 Created

JobTargetGroup

Le groupe cible a été créé.

Other Status Codes

Réponses d’erreur : ***

400 InvalidResourceRequestBody : la ressource ou les propriétés de ressource dans le corps de la demande sont vides ou non valides.
400 InvalidResourceId : identificateur de ressource non valide.
400 MismatchingSubscriptionWithUrl : l’abonnement fourni ne correspond pas à l’abonnement dans l’URL.
400 Non correspondanceResourceGroupNameWithUrl : le nom du groupe de ressources fourni ne correspond pas au nom dans l’URL.
400 MismatchingServerNameWithUrl : le nom du serveur fourni ne correspond pas au nom dans l’URL.
400 Non correspondanceJobAccountNameWithUrl : le nom du compte de travail fourni ne correspond pas au nom dans l’URL.
400 ElasticJobsOperationFailed : échec de l’opération de gestion des travaux élastiques.
400 ElasticJobsOperationFailed : échec de l’opération de gestion des travaux élastiques.
404 JobAgentNotFound : l’agent de travail spécifié n’existe pas dans le serveur logique spécifié.
404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable
404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.

Exemples

Create or update a target group with all properties.

Create or update a target group with minimal properties.

Create or update a target group with all properties.

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1?api-version=2021-11-01

{
  "properties": {
    "members": [
      {
        "membershipType": "Exclude",
        "type": "SqlDatabase",
        "serverName": "server1",
        "databaseName": "database1"
      },
      {
        "membershipType": "Include",
        "type": "SqlServer",
        "serverName": "server1",
        "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
      },
      {
        "membershipType": "Include",
        "type": "SqlElasticPool",
        "serverName": "server2",
        "elasticPoolName": "pool1",
        "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
      },
      {
        "membershipType": "Include",
        "type": "SqlShardMap",
        "serverName": "server3",
        "shardMapName": "shardMap1",
        "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
      }
    ]
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.JobTargetGroupInner;
import com.azure.resourcemanager.sql.models.JobTarget;
import com.azure.resourcemanager.sql.models.JobTargetGroupMembershipType;
import com.azure.resourcemanager.sql.models.JobTargetType;
import java.util.Arrays;

/** Samples for JobTargetGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateJobTargetGroupMax.json
     */
    /**
     * Sample code: Create or update a target group with all properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createOrUpdateATargetGroupWithAllProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobTargetGroups().createOrUpdateWithResponse("group1",
            "server1", "agent1", "targetGroup1",
            new JobTargetGroupInner().withMembers(Arrays.asList(
                new JobTarget().withMembershipType(JobTargetGroupMembershipType.EXCLUDE)
                    .withType(JobTargetType.SQL_DATABASE).withServerName("server1").withDatabaseName("database1"),
                new JobTarget().withMembershipType(JobTargetGroupMembershipType.INCLUDE)
                    .withType(JobTargetType.SQL_SERVER).withServerName("server1")
                    .withRefreshCredential("fakeTokenPlaceholder"),
                new JobTarget().withMembershipType(JobTargetGroupMembershipType.INCLUDE)
                    .withType(JobTargetType.SQL_ELASTIC_POOL).withServerName("server2").withElasticPoolName("pool1")
                    .withRefreshCredential("fakeTokenPlaceholder"),
                new JobTarget().withMembershipType(JobTargetGroupMembershipType.INCLUDE)
                    .withType(JobTargetType.SQL_SHARD_MAP).withServerName("server3").withShardMapName("shardMap1")
                    .withRefreshCredential("fakeTokenPlaceholder"))),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "properties": {
    "members": [
      {
        "membershipType": "Exclude",
        "type": "SqlDatabase",
        "serverName": "server1",
        "databaseName": "database1"
      },
      {
        "membershipType": "Include",
        "type": "SqlServer",
        "serverName": "server1",
        "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
      },
      {
        "membershipType": "Include",
        "type": "SqlElasticPool",
        "serverName": "server2",
        "elasticPoolName": "pool1",
        "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
      },
      {
        "membershipType": "Include",
        "type": "SqlShardMap",
        "serverName": "server3",
        "shardMapName": "shardMap1",
        "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
      }
    ]
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
  "name": "targetGroup1",
  "type": "Microsoft.Sql/servers/jobAgents/targetGroups"
}

Status code:: 201

{
  "properties": {
    "members": [
      {
        "membershipType": "Exclude",
        "type": "SqlDatabase",
        "serverName": "server1",
        "databaseName": "database1"
      },
      {
        "membershipType": "Include",
        "type": "SqlServer",
        "serverName": "server1",
        "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
      },
      {
        "membershipType": "Include",
        "type": "SqlElasticPool",
        "serverName": "server2",
        "elasticPoolName": "pool1",
        "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
      },
      {
        "membershipType": "Include",
        "type": "SqlShardMap",
        "serverName": "server3",
        "shardMapName": "shardMap1",
        "refreshCredential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/testCredential"
      }
    ]
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
  "name": "targetGroup1",
  "type": "Microsoft.Sql/servers/jobAgents/targetGroups"
}

Create or update a target group with minimal properties.

Sample Request

HTTP
Java

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1?api-version=2021-11-01

{
  "properties": {
    "members": []
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.JobTargetGroupInner;
import java.util.Arrays;

/** Samples for JobTargetGroups CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/CreateOrUpdateJobTargetGroupMin.json
     */
    /**
     * Sample code: Create or update a target group with minimal properties.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        createOrUpdateATargetGroupWithMinimalProperties(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobTargetGroups().createOrUpdateWithResponse("group1",
            "server1", "agent1", "targetGroup1", new JobTargetGroupInner().withMembers(Arrays.asList()), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "properties": {
    "members": []
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
  "name": "targetGroup1",
  "type": "Microsoft.Sql/servers/jobAgents/targetGroups"
}

Status code:: 201

{
  "properties": {
    "members": []
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
  "name": "targetGroup1",
  "type": "Microsoft.Sql/servers/jobAgents/targetGroups"
}

Définitions

Nom	Description
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.
JobTargetGroup	Groupe de cibles de travail.
JobTargetGroupMembershipType	Indique si la cible est incluse ou exclue du groupe.
JobTargetType	Type cible.

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	JobTargetGroupMembershipType	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	JobTargetType		Type cible.

JobTargetGroup

Groupe de cibles de travail.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.members	JobTarget[]	Membres du groupe cible.
type	string	Type de ressource.

JobTargetGroupMembershipType

Indique si la cible est incluse ou exclue du groupe.

Nom	Type	Description
Exclude	string
Include	string

JobTargetType

Type cible.

Nom	Type	Description
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

Job Target Groups - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

Create or update a target group with all properties.

Sample Request

Sample Response

Create or update a target group with minimal properties.

Sample Request

Sample Response

Définitions

JobTarget

JobTargetGroup

JobTargetGroupMembershipType

JobTargetType

Ressources supplémentaires