Job Target Groups - Create Or Update

Usługa:

SQL Database

Wersja interfejsu API:

2021-11-01

Tworzy lub aktualizuje grupę docelową.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
jobAgentName	path	True	string	Nazwa agenta zadania.
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
targetGroupName	path	True	string	Nazwa grupy docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.members	True	JobTarget[]	Członkowie grupy docelowej.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	JobTargetGroup	Pomyślnie zaktualizowano grupę docelową.
201 Created	JobTargetGroup	Pomyślnie utworzono grupę docelową.
Other Status Codes		Odpowiedzi na błędy: *** 400 InvalidResourceRequestBody — właściwości zasobu lub zasobu w treści żądania są puste lub nieprawidłowe. 400 InvalidResourceId — nieprawidłowy identyfikator zasobu. 400 NiezgodnośćSubscriptionWithUrl — podana subskrypcja nie jest zgodna z subskrypcją w adresie URL. 400 MismatchingResourceGroupNameWithUrl — podana nazwa grupy zasobów nie jest zgodna z nazwą w adresie URL. 400 NiezgodnośćServerNameWithUrl — podana nazwa serwera nie jest zgodna z nazwą w adresie URL. 400 MismatchingJobAccountNameWithUrl — podana nazwa konta zadania nie jest zgodna z nazwą w adresie URL. 400 ElasticJobsOperationFailed — operacja zarządzania zadaniami elastycznymi nie powiodła się. 400 ElasticJobsOperationFailed — operacja zarządzania zadaniami elastycznymi nie powiodła się. 404 JobAgentNotFound — określony agent zadania nie istnieje na określonym serwerze logicznym. 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji.

Przykłady

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.

Przykładowe żądanie

HTTP

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

Java

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"))),
            com.azure.core.util.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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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.

Przykładowe żądanie

HTTP

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": []
  }
}

Java

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()),
            com.azure.core.util.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

Przykładowa odpowiedź

Kod stanu:

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

Kod stanu:

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

Definicje

Nazwa	Opis
JobTarget	Obiekt docelowy zadania, na przykład określoną bazę danych lub kontener baz danych, które są oceniane podczas wykonywania zadania.
JobTargetGroup	Grupa obiektów docelowych zadań.
JobTargetGroupMembershipType	Określa, czy element docelowy jest uwzględniony, czy wykluczony z grupy.
JobTargetType	Typ docelowy.

JobTarget

Obiekt docelowy zadania, na przykład określoną bazę danych lub kontener baz danych, które są oceniane podczas wykonywania zadania.

Nazwa	Typ	Domyślna wartość	Opis
databaseName	string		Docelowa nazwa bazy danych.
elasticPoolName	string		Docelowa nazwa elastycznej puli.
membershipType	JobTargetGroupMembershipType	Include	Określa, czy element docelowy jest uwzględniony, czy wykluczony z grupy.
refreshCredential	string		Identyfikator zasobu poświadczenia używanego podczas wykonywania zadania w celu nawiązania połączenia z obiektem docelowym i określenia listy baz danych wewnątrz obiektu docelowego.
serverName	string		Nazwa serwera docelowego.
shardMapName	string		Docelowa mapa fragmentów.
type	JobTargetType		Typ docelowy.

JobTargetGroup

Grupa obiektów docelowych zadań.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.members	JobTarget[]	Członkowie grupy docelowej.
type	string	Typ zasobu.

JobTargetGroupMembershipType

Określa, czy element docelowy jest uwzględniony, czy wykluczony z grupy.

Nazwa	Typ	Opis
Exclude	string
Include	string

JobTargetType

Typ docelowy.

Nazwa	Typ	Opis
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string