Job Target Groups - Create Or Update

Referencia

Servicio:: SQL Database

Versión de la API:: 2021-11-01

Crea o actualiza un grupo de destino.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
jobAgentName	path	True	string	Nombre del agente de trabajo.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
targetGroupName	path	True	string	Nombre del grupo de destino.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.members	True	JobTarget[]	Miembros del grupo de destino.

Respuestas

Nombre	Tipo	Description
200 OK	JobTargetGroup	Se actualizó correctamente el grupo de destino.
201 Created	JobTargetGroup	Se creó correctamente el grupo de destino.
Other Status Codes		Respuestas de error: *** 400 InvalidResourceRequestBody: las propiedades de recurso o recurso del cuerpo de la solicitud están vacías o no son válidas. 400 InvalidResourceId: identificador de recurso no válido. 400 No coincidentesSubscriptionWithUrl: la suscripción proporcionada no coincide con la suscripción en la dirección URL. 400 No coincidentesResourceGroupNameWithUrl: el nombre del grupo de recursos proporcionado no coincide con el nombre de la dirección URL. 400 No coincidentesServerNameWithUrl: el nombre del servidor proporcionado no coincide con el nombre de la dirección URL. 400 No coincidentesJobAccountNameWithUrl: el nombre de la cuenta de trabajo proporcionada no coincide con el nombre de la dirección URL. 400 ElasticJobsOperationFailed: error en la operación de administración de trabajos elásticos. 400 ElasticJobsOperationFailed: error en la operación de administración de trabajos elásticos. 404 JobAgentNotFound: el agente de trabajo especificado no existe en el servidor lógico especificado. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

Nombre

Tipo

Description

200 OK

JobTargetGroup

Se actualizó correctamente el grupo de destino.

201 Created

JobTargetGroup

Se creó correctamente el grupo de destino.

Other Status Codes

Respuestas de error: ***

400 InvalidResourceRequestBody: las propiedades de recurso o recurso del cuerpo de la solicitud están vacías o no son válidas.
400 InvalidResourceId: identificador de recurso no válido.
400 No coincidentesSubscriptionWithUrl: la suscripción proporcionada no coincide con la suscripción en la dirección URL.
400 No coincidentesResourceGroupNameWithUrl: el nombre del grupo de recursos proporcionado no coincide con el nombre de la dirección URL.
400 No coincidentesServerNameWithUrl: el nombre del servidor proporcionado no coincide con el nombre de la dirección URL.
400 No coincidentesJobAccountNameWithUrl: el nombre de la cuenta de trabajo proporcionada no coincide con el nombre de la dirección URL.
400 ElasticJobsOperationFailed: error en la operación de administración de trabajos elásticos.
400 ElasticJobsOperationFailed: error en la operación de administración de trabajos elásticos.
404 JobAgentNotFound: el agente de trabajo especificado no existe en el servidor lógico especificado.
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.
404 ServerNotInSubscriptionResourceGroup: el servidor especificado no existe en el grupo de recursos y la suscripción especificados.

Ejemplos

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.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

Respuesta de muestra

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.

Solicitud de ejemplo

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.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

Respuesta de muestra

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

Definiciones

Nombre	Description
JobTarget	Un destino de trabajo, por ejemplo, una base de datos específica o un contenedor de bases de datos que se evalúan durante la ejecución del trabajo.
JobTargetGroup	Un grupo de destinos de trabajo.
JobTargetGroupMembershipType	Si el destino está incluido o excluido del grupo.
JobTargetType	Tipo de destino.

JobTarget

Un destino de trabajo, por ejemplo, una base de datos específica o un contenedor de bases de datos que se evalúan durante la ejecución del trabajo.

Nombre	Tipo	Valor predeterminado	Description
databaseName	string		Nombre de la base de datos de destino.
elasticPoolName	string		Nombre del grupo elástico de destino.
membershipType	JobTargetGroupMembershipType	Include	Si el destino está incluido o excluido del grupo.
refreshCredential	string		Identificador de recurso de la credencial que se usa durante la ejecución del trabajo para conectarse al destino y determinar la lista de bases de datos dentro del destino.
serverName	string		Nombre del servidor de destino.
shardMapName	string		Mapa de particiones de destino.
type	JobTargetType		Tipo de destino.

JobTargetGroup

Un grupo de destinos de trabajo.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.members	JobTarget[]	Miembros del grupo de destino.
type	string	Tipo de recurso.

JobTargetGroupMembershipType

Si el destino está incluido o excluido del grupo.

Nombre	Tipo	Description
Exclude	string
Include	string

JobTargetType

Tipo de destino.

Nombre	Tipo	Description
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

Compartir a través de

Job Target Groups - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Create or update a target group with all properties.

Solicitud de ejemplo

Respuesta de muestra

Create or update a target group with minimal properties.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

JobTarget

JobTargetGroup

JobTargetGroupMembershipType

JobTargetType

Recursos adicionales