Job Target Groups - List By Agent

Riferimento

Servizio:: SQL Database

Versione API:: 2023-08-01

Ottiene tutti i gruppi di destinazione in un agente.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups?api-version=2023-08-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
jobAgentName	path	True	string	Nome dell'agente di processo.
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
serverName	path	True	string	Nome del server.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare per la richiesta.

Risposte

Nome	Tipo	Descrizione
200 OK	JobTargetGroupListResult	È stato recuperato correttamente l'elenco dei gruppi di destinazione.
Other Status Codes	ErrorResponse	Risposte di errore: 400 ManagedInstanceStoppingOrStopped - Operazione in conflitto inviata mentre l'istanza è in stato di arresto/arresto 400 ManagedInstanceStarting - Operazione in conflitto inviata mentre l'istanza è in stato di avvio 404 JobAgentNotFound- L'agente di processo specificato non esiste nel server logico specificato. 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati. 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato

Nome

Tipo

Descrizione

200 OK

JobTargetGroupListResult

È stato recuperato correttamente l'elenco dei gruppi di destinazione.

Other Status Codes

ErrorResponse

Risposte di errore:

400 ManagedInstanceStoppingOrStopped - Operazione in conflitto inviata mentre l'istanza è in stato di arresto/arresto
400 ManagedInstanceStarting - Operazione in conflitto inviata mentre l'istanza è in stato di avvio
404 JobAgentNotFound- L'agente di processo specificato non esiste nel server logico specificato.
404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati.
404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato

Esempio

Get all target groups in an agent.

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ListJobTargetGroups.json
// this example is just showing the usage of "JobTargetGroups_ListByAgent" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerJobAgentResource created on azure
// for more information of creating SqlServerJobAgentResource, please refer to the document of SqlServerJobAgentResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "group1";
string serverName = "server1";
string jobAgentName = "agent1";
ResourceIdentifier sqlServerJobAgentResourceId = SqlServerJobAgentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, jobAgentName);
SqlServerJobAgentResource sqlServerJobAgent = client.GetSqlServerJobAgentResource(sqlServerJobAgentResourceId);

// get the collection of this SqlServerJobTargetGroupResource
SqlServerJobTargetGroupCollection collection = sqlServerJobAgent.GetSqlServerJobTargetGroups();

// invoke the operation and iterate over the result
await foreach (SqlServerJobTargetGroupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlServerJobTargetGroupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

Risposta di esempio

Codice di stato:: 200

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

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
JobTarget	Destinazione di un processo, ad esempio un database specifico o un contenitore di database che viene valutato durante l'esecuzione del processo.
JobTargetGroup	Gruppo di destinazioni di processo.
JobTargetGroupListResult	Elenco di gruppi di destinazione.
JobTargetGroupMembershipType	Indica se la destinazione è inclusa o esclusa dal gruppo.
JobTargetType	Tipo di destinazione.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

JobTarget

Object

Destinazione di un processo, ad esempio un database specifico o un contenitore di database che viene valutato durante l'esecuzione del processo.

Nome	Tipo	Valore predefinito	Descrizione
databaseName	string		Nome del database di destinazione.
elasticPoolName	string		Nome del pool elastico di destinazione.
membershipType	JobTargetGroupMembershipType	Include	Indica se la destinazione è inclusa o esclusa dal gruppo.
refreshCredential	string		ID risorsa delle credenziali usate durante l'esecuzione del processo per connettersi alla destinazione e determinare l'elenco di database all'interno della destinazione.
serverName	string		Nome del server di destinazione.
shardMapName	string		Mappa partizioni di destinazione.
type	JobTargetType		Tipo di destinazione.

JobTargetGroup

Object

Gruppo di destinazioni di processo.

Nome	Tipo	Descrizione
id	string	ID risorsa.
name	string	Nome risorsa.
properties.members	JobTarget[]	Membri del gruppo di destinazione.
type	string	Tipo di risorsa.

JobTargetGroupListResult

Object

Elenco di gruppi di destinazione.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per recuperare la pagina successiva dei risultati.
value	JobTargetGroup[]	Matrice di risultati.

JobTargetGroupMembershipType

Enumerazione

Indica se la destinazione è inclusa o esclusa dal gruppo.

Valore	Descrizione
Exclude
Include

JobTargetType

Enumerazione

Tipo di destinazione.

Valore	Descrizione
SqlDatabase
SqlElasticPool
SqlServer
SqlShardMap
TargetGroup

Condividi tramite

Job Target Groups - List By Agent

Parametri dell'URI

Risposte

Esempio

Get all target groups in an agent.

Esempio di richiesta

Risposta di esempio

Definizioni

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

JobTarget

JobTargetGroup

JobTargetGroupListResult

JobTargetGroupMembershipType

JobTargetType