Targets - List By Watcher

Servicio:

Database Watcher

Versión de la API:

2025-01-02

Enumerar los recursos de destino de Watcher

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Nombre del monitor de base de datos.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	TargetListResult	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Targets_ListByWatcher_MaximumSet

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ResourceProvisioningState	Estado de aprovisionamiento del recurso de regla de alertas.
SqlDbElasticPoolTargetProperties	Las propiedades específicas de un grupo elástico en Azure SQL Database.
SqlDbSingleDatabaseTargetProperties	Propiedades específicas de una base de datos en Azure SQL Database.
SqlMiTargetProperties	Las propiedades específicas de los destinos de Azure SQL Managed Instance.
systemData	Metadatos relativos a la creación y última modificación del recurso.
Target	Los tipos de recursos de proxy concretos se pueden crear mediante el alias de este tipo mediante un tipo de propiedad específico.
TargetAuthenticationType	Tipo de autenticación que se va a usar al conectarse a un destino.
TargetListResult	Respuesta de una operación de lista de destino.
VaultSecret	Detalles específicos del almacén necesarios si se usa la autenticación de SQL para conectarse a un destino.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ResourceProvisioningState

Enumeración

Estado de aprovisionamiento del recurso de regla de alertas.

Valor	Description
Succeeded	Se ha creado el recurso.
Failed	Error en la creación de recursos.
Canceled	Se canceló la creación de recursos.

SqlDbElasticPoolTargetProperties

Object

Las propiedades específicas de un grupo elástico en Azure SQL Database.

Nombre	Tipo	Valor predeterminado	Description
anchorDatabaseResourceId	string (arm-id)		Identificador de recurso de Azure de la base de datos de delimitador que se usa para conectarse a un grupo elástico.
connectionServerName	string maxLength: 200		Nombre de host FQDN del servidor que se va a usar en la cadena de conexión al conectarse a un destino. Por ejemplo, para un servidor lógico de Azure SQL en la nube comercial de Azure, el valor podría ser "sql-logical-server-22092780.database.windows.net"; para una instancia administrada de Azure SQL en la nube comercial de Azure, el valor podría ser "sql-mi-39441134.767d5869f605.database.windows.net". El número de puerto y el nombre de instancia deben especificarse por separado.
provisioningState	ResourceProvisioningState		Estado de aprovisionamiento del recurso.
readIntent	boolean	False	Establézcalo en true para supervisar una réplica de alta disponibilidad del destino especificado, si existe.
sqlEpResourceId	string (arm-id)		Identificador de recurso de Azure de un destino de grupo elástico de Azure SQL DB.
targetAuthenticationType	TargetAuthenticationType		Tipo de autenticación que se va a usar al conectarse a un destino.
targetType	string: SqlEp		Propiedad Discriminadora para TargetProperties.
targetVault	VaultSecret		Para usar la autenticación de SQL al conectarse a destinos, especifique el almacén donde se almacenan el nombre de inicio de sesión y los secretos de contraseña.

SqlDbSingleDatabaseTargetProperties

Object

Propiedades específicas de una base de datos en Azure SQL Database.

Nombre	Tipo	Valor predeterminado	Description
connectionServerName	string maxLength: 200		Nombre de host FQDN del servidor que se va a usar en la cadena de conexión al conectarse a un destino. Por ejemplo, para un servidor lógico de Azure SQL en la nube comercial de Azure, el valor podría ser "sql-logical-server-22092780.database.windows.net"; para una instancia administrada de Azure SQL en la nube comercial de Azure, el valor podría ser "sql-mi-39441134.767d5869f605.database.windows.net". El número de puerto y el nombre de instancia deben especificarse por separado.
provisioningState	ResourceProvisioningState		Estado de aprovisionamiento del recurso.
readIntent	boolean	False	Establézcalo en true para supervisar una réplica de alta disponibilidad del destino especificado, si existe.
sqlDbResourceId	string (arm-id)		Identificador de recurso de Azure de un destino de base de datos de Azure SQL DB.
targetAuthenticationType	TargetAuthenticationType		Tipo de autenticación que se va a usar al conectarse a un destino.
targetType	string: SqlDb		Propiedad Discriminadora para TargetProperties.
targetVault	VaultSecret		Para usar la autenticación de SQL al conectarse a destinos, especifique el almacén donde se almacenan el nombre de inicio de sesión y los secretos de contraseña.

SqlMiTargetProperties

Object

Las propiedades específicas de los destinos de Azure SQL Managed Instance.

Nombre	Tipo	Valor predeterminado	Description
connectionServerName	string maxLength: 200		Nombre de host FQDN del servidor que se va a usar en la cadena de conexión al conectarse a un destino. Por ejemplo, para un servidor lógico de Azure SQL en la nube comercial de Azure, el valor podría ser "sql-logical-server-22092780.database.windows.net"; para una instancia administrada de Azure SQL en la nube comercial de Azure, el valor podría ser "sql-mi-39441134.767d5869f605.database.windows.net". El número de puerto y el nombre de instancia deben especificarse por separado.
connectionTcpPort	integer (int32)	1433	Número de puerto TCP que se usará opcionalmente en la cadena de conexión al conectarse a un destino de Instancia administrada de Azure SQL.
provisioningState	ResourceProvisioningState		Estado de aprovisionamiento del recurso.
readIntent	boolean	False	Establézcalo en true para supervisar una réplica de alta disponibilidad del destino especificado, si existe.
sqlMiResourceId	string (arm-id)		Identificador de recurso de Azure de un destino de Instancia administrada de Azure SQL.
targetAuthenticationType	TargetAuthenticationType		Tipo de autenticación que se va a usar al conectarse a un destino.
targetType	string: SqlMi		Propiedad Discriminadora para TargetProperties.
targetVault	VaultSecret		Para usar la autenticación de SQL al conectarse a destinos, especifique el almacén donde se almacenan el nombre de inicio de sesión y los secretos de contraseña.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Target

Object

Los tipos de recursos de proxy concretos se pueden crear mediante el alias de este tipo mediante un tipo de propiedad específico.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Propiedades específicas del recurso para este recurso.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

TargetAuthenticationType

Enumeración

Tipo de autenticación que se va a usar al conectarse a un destino.

Valor	Description
Aad	Autenticación de Azure Active Directory.
Sql	Autenticación con contraseña de SQL.

TargetListResult

Object

Respuesta de una operación de lista de destino.

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente de elementos
value	Target[]	Elementos de destino de esta página

VaultSecret

Object

Detalles específicos del almacén necesarios si se usa la autenticación de SQL para conectarse a un destino.

Nombre	Tipo	Description
akvResourceId	string (arm-id)	Identificador de recurso de Azure de la instancia de Key Vault que almacena secretos de autenticación de base de datos.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	Ruta de acceso al secreto de Key Vault que almacena la contraseña para la autenticación en un destino.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	Ruta de acceso al secreto de Key Vault que almacena el nombre de inicio de sesión (también conocido como nombre de usuario, también conocido como nombre de cuenta) para la autenticación en un destino.