Targets - List By Watcher

Servizio:

Database Watcher

Versione API:

2025-01-02

Elencare le risorse di destinazione di Watcher

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}/targets?api-version=2025-01-02

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Nome del watcher del database.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	TargetListResult	Operazione di Azure completata correttamente.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Targets_ListByWatcher_MaximumSet

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.DatabaseWatcher/watchers/databasemo3ej9ih/targets?api-version=2025-01-02

Java

/**
 * Samples for Targets ListByWatcher.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-02/Targets_ListByWatcher_MaximumSet_Gen.json
     */
    /**
     * Sample code: Targets_ListByWatcher_MaximumSet.
     * 
     * @param manager Entry point to DatabaseWatcherManager.
     */
    public static void
        targetsListByWatcherMaximumSet(com.azure.resourcemanager.databasewatcher.DatabaseWatcherManager manager) {
        manager.targets().listByWatcher("apiTest-ddat4p", "databasemo3ej9ih", 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.databasewatcher import DatabaseWatcherMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-databasewatcher
# USAGE
    python targets_list_by_watcher_maximum_set_gen.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DatabaseWatcherMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.targets.list_by_watcher(
        resource_group_name="apiTest-ddat4p",
        watcher_name="databasemo3ej9ih",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-02/Targets_ListByWatcher_MaximumSet_Gen.json
if __name__ == "__main__":
    main()

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

Go

package armdatabasewatcher_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/databasewatcher/armdatabasewatcher"
)

// Generated from example definition: 2025-01-02/Targets_ListByWatcher_MaximumSet_Gen.json
func ExampleTargetsClient_NewListByWatcherPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatabasewatcher.NewClientFactory("49e0fbd3-75e8-44e7-96fd-5b64d9ad818d", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewTargetsClient().NewListByWatcherPager("apiTest-ddat4p", "databasemo3ej9ih", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armdatabasewatcher.TargetsClientListByWatcherResponse{
		// 	TargetListResult: armdatabasewatcher.TargetListResult{
		// 		Value: []*armdatabasewatcher.Target{
		// 			{
		// 				ID: to.Ptr("/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-px9ma7/providers/Microsoft.DatabaseWatcher/watchers/databasemo3d9sgt/targets/monitoringzkndgm"),
		// 				Name: to.Ptr("monitoringzkndgm"),
		// 				Type: to.Ptr("microsoft.databasewatcher/watchers/targets"),
		// 				Properties: &armdatabasewatcher.SQLDbSingleDatabaseTargetProperties{
		// 					TargetType: to.Ptr("SqlDb"),
		// 					TargetAuthenticationType: to.Ptr(armdatabasewatcher.TargetAuthenticationTypeAAD),
		// 					ConnectionServerName: to.Ptr("sqlServero1ihe2"),
		// 					SQLDbResourceID: to.Ptr("/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2"),
		// 					ProvisioningState: to.Ptr(armdatabasewatcher.ResourceProvisioningStateSucceeded),
		// 				},
		// 				SystemData: &armdatabasewatcher.SystemData{
		// 					CreatedBy: to.Ptr("enbpvlpqbwd"),
		// 					CreatedByType: to.Ptr(armdatabasewatcher.CreatedByTypeUser),
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-07-25T15:38:47.092Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("mxp"),
		// 					LastModifiedByType: to.Ptr(armdatabasewatcher.CreatedByTypeUser),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-07-25T15:38:47.092Z"); return t}()),
		// 				},
		// 			},
		// 		},
		// 		NextLink: to.Ptr("https://microsoft.com/a"),
		// 	},
		// }
	}
}

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

JavaScript

const { DatabaseWatcherClient } = require("@azure/arm-databasewatcher");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list Target resources by Watcher
 *
 * @summary list Target resources by Watcher
 * x-ms-original-file: 2025-01-02/Targets_ListByWatcher_MaximumSet_Gen.json
 */
async function targetsListByWatcherMaximumSet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "49e0fbd3-75e8-44e7-96fd-5b64d9ad818d";
  const client = new DatabaseWatcherClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.targets.listByWatcher("apiTest-ddat4p", "databasemo3ej9ih")) {
    resArray.push(item);
  }

  console.log(resArray);
}

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

dotnet

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

// Generated from example definition: 2025-01-02/Targets_ListByWatcher_MaximumSet_Gen.json
// this example is just showing the usage of "Target_ListByWatcher" 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 DatabaseWatcherResource created on azure
// for more information of creating DatabaseWatcherResource, please refer to the document of DatabaseWatcherResource
string subscriptionId = "49e0fbd3-75e8-44e7-96fd-5b64d9ad818d";
string resourceGroupName = "apiTest-ddat4p";
string watcherName = "databasemo3ej9ih";
ResourceIdentifier databaseWatcherResourceId = DatabaseWatcherResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, watcherName);
DatabaseWatcherResource databaseWatcher = client.GetDatabaseWatcherResource(databaseWatcherResourceId);

// get the collection of this DatabaseWatcherTargetResource
DatabaseWatcherTargetCollection collection = databaseWatcher.GetDatabaseWatcherTargets();

// invoke the operation and iterate over the result
await foreach (DatabaseWatcherTargetResource 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
    DatabaseWatcherTargetData 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": [
    {
      "id": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-px9ma7/providers/Microsoft.DatabaseWatcher/watchers/databasemo3d9sgt/targets/monitoringzkndgm",
      "name": "monitoringzkndgm",
      "type": "microsoft.databasewatcher/watchers/targets",
      "properties": {
        "targetType": "SqlDb",
        "targetAuthenticationType": "Aad",
        "connectionServerName": "sqlServero1ihe2",
        "sqlDbResourceId": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest-ddat4p/providers/Microsoft.Sql/servers/m1/databases/m2",
        "provisioningState": "Succeeded"
      },
      "systemData": {
        "createdBy": "enbpvlpqbwd",
        "createdByType": "User",
        "createdAt": "2024-07-25T15:38:47.092Z",
        "lastModifiedBy": "mxp",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2024-07-25T15:38:47.092Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

Definizioni

Nome	Descrizione
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ResourceProvisioningState	Stato di provisioning della risorsa regola di avviso.
SqlDbElasticPoolTargetProperties	Proprietà specifiche di un pool elastico nel database SQL di Azure.
SqlDbSingleDatabaseTargetProperties	Proprietà specifiche di un database nel database SQL di Azure.
SqlMiTargetProperties	Le proprietà specifiche delle destinazioni di Istanza gestita di SQL di Azure.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
Target	È possibile creare tipi di risorse proxy concreti eseguendo l'aliasing di questo tipo usando un tipo di proprietà specifico.
TargetAuthenticationType	Tipo di autenticazione da usare per la connessione a una destinazione.
TargetListResult	Risposta di un'operazione elenco di destinazione.
VaultSecret	I dettagli specifici dell'insieme di credenziali sono necessari se si usa l'autenticazione SQL per connettersi a una destinazione.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

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.

ResourceProvisioningState

Enumerazione

Stato di provisioning della risorsa regola di avviso.

Valore	Descrizione
Succeeded	La risorsa è stata creata.
Failed	Creazione della risorsa non riuscita.
Canceled	La creazione della risorsa è stata annullata.

SqlDbElasticPoolTargetProperties

Object

Proprietà specifiche di un pool elastico nel database SQL di Azure.

Nome	Tipo	Valore predefinito	Descrizione
anchorDatabaseResourceId	string (arm-id)		ID risorsa di Azure del database di ancoraggio usato per connettersi a un pool elastico.
connectionServerName	string maxLength: 200		Nome host FQDN del server da usare nella stringa di connessione durante la connessione a una destinazione. Ad esempio, per un server logico SQL di Azure nel cloud commerciale di Azure, il valore potrebbe essere "sql-logical-server-22092780.database.windows.net". per un'istanza gestita di SQL di Azure nel cloud commerciale di Azure, il valore potrebbe essere "sql-mi-39441134.767d5869f605.database.windows.net". Il numero di porta e il nome dell'istanza devono essere specificati separatamente.
provisioningState	ResourceProvisioningState		Stato di provisioning della risorsa.
readIntent	boolean	False	Impostare su true per monitorare una replica a disponibilità elevata della destinazione specificata, se disponibile.
sqlEpResourceId	string (arm-id)		ID risorsa di Azure di una destinazione del pool elastico del database SQL di Azure.
targetAuthenticationType	TargetAuthenticationType		Tipo di autenticazione da usare per la connessione a una destinazione.
targetType	string: SqlEp		Proprietà discriminatoria per TargetProperties.
targetVault	VaultSecret		Per usare l'autenticazione SQL per la connessione alle destinazioni, specificare l'insieme di credenziali in cui vengono archiviati i segreti relativi al nome di accesso e alla password.

SqlDbSingleDatabaseTargetProperties

Object

Proprietà specifiche di un database nel database SQL di Azure.

Nome	Tipo	Valore predefinito	Descrizione
connectionServerName	string maxLength: 200		Nome host FQDN del server da usare nella stringa di connessione durante la connessione a una destinazione. Ad esempio, per un server logico SQL di Azure nel cloud commerciale di Azure, il valore potrebbe essere "sql-logical-server-22092780.database.windows.net". per un'istanza gestita di SQL di Azure nel cloud commerciale di Azure, il valore potrebbe essere "sql-mi-39441134.767d5869f605.database.windows.net". Il numero di porta e il nome dell'istanza devono essere specificati separatamente.
provisioningState	ResourceProvisioningState		Stato di provisioning della risorsa.
readIntent	boolean	False	Impostare su true per monitorare una replica a disponibilità elevata della destinazione specificata, se disponibile.
sqlDbResourceId	string (arm-id)		ID risorsa di Azure di una destinazione del database SQL di Azure.
targetAuthenticationType	TargetAuthenticationType		Tipo di autenticazione da usare per la connessione a una destinazione.
targetType	string: SqlDb		Proprietà discriminatoria per TargetProperties.
targetVault	VaultSecret		Per usare l'autenticazione SQL per la connessione alle destinazioni, specificare l'insieme di credenziali in cui vengono archiviati i segreti relativi al nome di accesso e alla password.

SqlMiTargetProperties

Object

Le proprietà specifiche delle destinazioni di Istanza gestita di SQL di Azure.

Nome	Tipo	Valore predefinito	Descrizione
connectionServerName	string maxLength: 200		Nome host FQDN del server da usare nella stringa di connessione durante la connessione a una destinazione. Ad esempio, per un server logico SQL di Azure nel cloud commerciale di Azure, il valore potrebbe essere "sql-logical-server-22092780.database.windows.net". per un'istanza gestita di SQL di Azure nel cloud commerciale di Azure, il valore potrebbe essere "sql-mi-39441134.767d5869f605.database.windows.net". Il numero di porta e il nome dell'istanza devono essere specificati separatamente.
connectionTcpPort	integer (int32)	1433	Numero di porta TCP da usare facoltativamente nella stringa di connessione per la connessione a una destinazione di Istanza gestita di SQL di Azure.
provisioningState	ResourceProvisioningState		Stato di provisioning della risorsa.
readIntent	boolean	False	Impostare su true per monitorare una replica a disponibilità elevata della destinazione specificata, se disponibile.
sqlMiResourceId	string (arm-id)		ID risorsa di Azure di una destinazione di Istanza gestita di SQL di Azure.
targetAuthenticationType	TargetAuthenticationType		Tipo di autenticazione da usare per la connessione a una destinazione.
targetType	string: SqlMi		Proprietà discriminatoria per TargetProperties.
targetVault	VaultSecret		Per usare l'autenticazione SQL per la connessione alle destinazioni, specificare l'insieme di credenziali in cui vengono archiviati i segreti relativi al nome di accesso e alla password.

systemData

Object

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Target

Object

È possibile creare tipi di risorse proxy concreti eseguendo l'aliasing di questo tipo usando un tipo di proprietà specifico.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Proprietà specifiche della risorsa.
systemData	systemData	Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

TargetAuthenticationType

Enumerazione

Tipo di autenticazione da usare per la connessione a una destinazione.

Valore	Descrizione
Aad	Autenticazione di Azure Active Directory.
Sql	Autenticazione della password SQL.

TargetListResult

Object

Risposta di un'operazione elenco di destinazione.

Nome	Tipo	Descrizione
nextLink	string (uri)	Collegamento alla pagina successiva di elementi
value	Target[]	Elementi di destinazione in questa pagina

VaultSecret

Object

I dettagli specifici dell'insieme di credenziali sono necessari se si usa l'autenticazione SQL per connettersi a una destinazione.

Nome	Tipo	Descrizione
akvResourceId	string (arm-id)	ID risorsa di Azure dell'istanza di Key Vault che archivia i segreti di autenticazione del database.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	Percorso del segreto dell'insieme di credenziali delle chiavi che archivia la password per l'autenticazione in una destinazione.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	Percorso del segreto dell'insieme di credenziali delle chiavi che archivia il nome di accesso (noto anche come nome utente, nome account) per l'autenticazione in una destinazione.