Job Target Groups - Create Or Update

참조

Service:: SQL Database

API Version:: 2021-11-01

대상 그룹을 만들거나 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
jobAgentName	path	True	string	작업 에이전트의 이름입니다.
resourceGroupName	path	True	string	리소스를 포함하는 리소스 그룹의 이름입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
serverName	path	True	string	서버의 이름입니다.
subscriptionId	path	True	string	Azure 구독을 식별하는 구독 ID입니다.
targetGroupName	path	True	string	대상 그룹의 이름입니다.
api-version	query	True	string	요청에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
properties.members	True	JobTarget[]	대상 그룹의 구성원입니다.

응답

Name	형식	Description
200 OK	JobTargetGroup	대상 그룹을 업데이트했습니다.
201 Created	JobTargetGroup	대상 그룹을 만들었습니다.
Other Status Codes		오류 응답: *** 400 InvalidResourceRequestBody - 요청 본문의 리소스 또는 리소스 속성이 비어 있거나 잘못되었습니다. 400 InvalidResourceId - 잘못된 리소스 식별자입니다. 400 MismatchingSubscriptionWithUrl - 제공된 구독이 URL의 구독과 일치하지 않습니다. 400 MismatchingResourceGroupNameWithUrl - 제공된 리소스 그룹 이름이 URL의 이름과 일치하지 않습니다. 400 MismatchingServerNameWithUrl - 제공된 서버 이름이 URL의 이름과 일치하지 않습니다. 400 MismatchingJobAccountNameWithUrl - 제공된 작업 계정 이름이 URL의 이름과 일치하지 않습니다. 400 ElasticJobsOperationFailed - 탄력적 작업 관리 작업이 실패했습니다. 400 ElasticJobsOperationFailed - 탄력적 작업 관리 작업이 실패했습니다. 404 JobAgentNotFound - 지정된 작업 에이전트가 지정된 논리 서버에 없습니다. 404 SubscriptionDoesNotHaveServer - 요청된 서버를 찾을 수 없습니다. 404 ServerNotInSubscriptionResourceGroup - 지정된 서버가 지정된 리소스 그룹 및 구독에 없습니다.

Name

형식

Description

200 OK

JobTargetGroup

대상 그룹을 업데이트했습니다.

201 Created

JobTargetGroup

대상 그룹을 만들었습니다.

Other Status Codes

오류 응답: ***

400 InvalidResourceRequestBody - 요청 본문의 리소스 또는 리소스 속성이 비어 있거나 잘못되었습니다.
400 InvalidResourceId - 잘못된 리소스 식별자입니다.
400 MismatchingSubscriptionWithUrl - 제공된 구독이 URL의 구독과 일치하지 않습니다.
400 MismatchingResourceGroupNameWithUrl - 제공된 리소스 그룹 이름이 URL의 이름과 일치하지 않습니다.
400 MismatchingServerNameWithUrl - 제공된 서버 이름이 URL의 이름과 일치하지 않습니다.
400 MismatchingJobAccountNameWithUrl - 제공된 작업 계정 이름이 URL의 이름과 일치하지 않습니다.
400 ElasticJobsOperationFailed - 탄력적 작업 관리 작업이 실패했습니다.
400 ElasticJobsOperationFailed - 탄력적 작업 관리 작업이 실패했습니다.
404 JobAgentNotFound - 지정된 작업 에이전트가 지정된 논리 서버에 없습니다.
404 SubscriptionDoesNotHaveServer - 요청된 서버를 찾을 수 없습니다.
404 ServerNotInSubscriptionResourceGroup - 지정된 서버가 지정된 리소스 그룹 및 구독에 없습니다.

예제

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

정의

Name	Description
JobTarget	작업 대상(예: 특정 데이터베이스 또는 작업 실행 중에 평가되는 데이터베이스의 컨테이너)입니다.
JobTargetGroup	작업 대상 그룹입니다.
JobTargetGroupMembershipType	대상을 그룹에서 포함할지 제외할지 여부입니다.
JobTargetType	대상 형식입니다.

JobTarget

작업 대상(예: 특정 데이터베이스 또는 작업 실행 중에 평가되는 데이터베이스의 컨테이너)입니다.

Name	형식	기본값	Description
databaseName	string		대상 데이터베이스 이름입니다.
elasticPoolName	string		대상 탄력적 풀 이름입니다.
membershipType	JobTargetGroupMembershipType	Include	대상을 그룹에서 포함할지 제외할지 여부입니다.
refreshCredential	string		대상에 연결하고 대상 내의 데이터베이스 목록을 결정하는 데 작업 실행 중에 사용되는 자격 증명의 리소스 ID입니다.
serverName	string		대상 서버 이름입니다.
shardMapName	string		대상 분할된 데이터베이스 맵입니다.
type	JobTargetType		대상 형식입니다.

JobTargetGroup

작업 대상 그룹입니다.

Name	형식	Description
id	string	리소스 ID입니다.
name	string	리소스 이름입니다.
properties.members	JobTarget[]	대상 그룹의 구성원입니다.
type	string	리소스 종류.

JobTargetGroupMembershipType

대상을 그룹에서 포함할지 제외할지 여부입니다.

Name	형식	Description
Exclude	string
Include	string

JobTargetType

대상 형식입니다.

Name	형식	Description
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

Job Target Groups - Create Or Update

URI 매개 변수

요청 본문

응답

예제

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

정의

JobTarget

JobTargetGroup

JobTargetGroupMembershipType

JobTargetType

추가 리소스