Job Target Groups - Create Or Update

Reference

Service:: SQL Database

API Version:: 2021-11-01

Vytvoří nebo aktualizuje cílovou skupinu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
jobAgentName	path	True	string	Název agenta úloh.
resourceGroupName	path	True	string	Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.
serverName	path	True	string	Název serveru.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
targetGroupName	path	True	string	Název cílové skupiny.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.

Text požadavku

Name	Vyžadováno	Typ	Description
properties.members	True	JobTarget[]	Členové cílové skupiny.

Odpovědi

Name	Typ	Description
200 OK	JobTargetGroup	Cílová skupina se úspěšně aktualizovala.
201 Created	JobTargetGroup	Cílová skupina se úspěšně vytvořila.
Other Status Codes		Chybové odpovědi: *** 400 InvalidResourceRequestBody – prostředek nebo vlastnosti prostředku v textu požadavku jsou prázdné nebo neplatné. 400 InvalidResourceId – neplatný identifikátor prostředku. 400 MismatchingSubscriptionWithUrl – zadané předplatné neodpovídá předplatnému v adrese URL. 400 MismatchingResourceGroupNameWithUrl – Zadaný název skupiny prostředků neodpovídá názvu v adrese URL. 400 MismatchingServerNameWithUrl – zadaný název serveru neodpovídá názvu v adrese URL. 400 MismatchingJobAccountNameWithUrl – Zadaný název účtu úlohy neodpovídá názvu v adrese URL. 400 ElasticJobsOperationFailed – Operace správy elastických úloh selhala. 400 ElasticJobsOperationFailed – Operace správy elastických úloh selhala. 404 JobAgentNotFound – Zadaný agent úloh na zadaném logickém serveru neexistuje. 404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel. 404 ServerNotInSubscriptionResourceGroup – zadaný server v zadané skupině prostředků a předplatném neexistuje.

Name

Typ

Description

200 OK

JobTargetGroup

Cílová skupina se úspěšně aktualizovala.

201 Created

JobTargetGroup

Cílová skupina se úspěšně vytvořila.

Other Status Codes

Chybové odpovědi: ***

400 InvalidResourceRequestBody – prostředek nebo vlastnosti prostředku v textu požadavku jsou prázdné nebo neplatné.
400 InvalidResourceId – neplatný identifikátor prostředku.
400 MismatchingSubscriptionWithUrl – zadané předplatné neodpovídá předplatnému v adrese URL.
400 MismatchingResourceGroupNameWithUrl – Zadaný název skupiny prostředků neodpovídá názvu v adrese URL.
400 MismatchingServerNameWithUrl – zadaný název serveru neodpovídá názvu v adrese URL.
400 MismatchingJobAccountNameWithUrl – Zadaný název účtu úlohy neodpovídá názvu v adrese URL.
400 ElasticJobsOperationFailed – Operace správy elastických úloh selhala.
400 ElasticJobsOperationFailed – Operace správy elastických úloh selhala.
404 JobAgentNotFound – Zadaný agent úloh na zadaném logickém serveru neexistuje.
404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel.
404 ServerNotInSubscriptionResourceGroup – zadaný server v zadané skupině prostředků a předplatném neexistuje.

Příklady

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

Definice

Name	Description
JobTarget	Cíl úlohy, například konkrétní databáze nebo kontejner databází, který se vyhodnocuje během provádění úlohy.
JobTargetGroup	Skupina cílů úlohy.
JobTargetGroupMembershipType	Určuje, jestli je cíl zahrnutý nebo vyloučený ze skupiny.
JobTargetType	Typ cíle.

JobTarget

Cíl úlohy, například konkrétní databáze nebo kontejner databází, který se vyhodnocuje během provádění úlohy.

Name	Typ	Výchozí hodnota	Description
databaseName	string		Název cílové databáze.
elasticPoolName	string		Název cílového elastického fondu.
membershipType	JobTargetGroupMembershipType	Include	Určuje, jestli je cíl zahrnutý nebo vyloučený ze skupiny.
refreshCredential	string		ID prostředku přihlašovacích údajů, které se používají při provádění úlohy pro připojení k cíli a určení seznamu databází uvnitř cíle.
serverName	string		Název cílového serveru.
shardMapName	string		Cílová mapa horizontálních oddílů.
type	JobTargetType		Typ cíle.

JobTargetGroup

Skupina cílů úlohy.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku.
properties.members	JobTarget[]	Členové cílové skupiny.
type	string	Typ prostředku.

JobTargetGroupMembershipType

Určuje, jestli je cíl zahrnutý nebo vyloučený ze skupiny.

Name	Typ	Description
Exclude	string
Include	string

JobTargetType

Typ cíle.

Name	Typ	Description
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

Job Target Groups - Create Or Update

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

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

Definice

JobTarget

JobTargetGroup

JobTargetGroupMembershipType

JobTargetType

Další materiály