Targets - List By Watcher

Service:

Database Watcher

Version d'API:

2025-01-02

Répertorier les ressources cibles par Watcher

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Nom de l’observateur de base de données.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	TargetListResult	L’opération Azure s’est terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Targets_ListByWatcher_MaximumSet

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ResourceProvisioningState	État d’approvisionnement de la ressource de règle d’alerte.
SqlDbElasticPoolTargetProperties	Propriétés spécifiques à un pool élastique dans Azure SQL Database.
SqlDbSingleDatabaseTargetProperties	Propriétés spécifiques à une base de données dans Azure SQL Database.
SqlMiTargetProperties	Propriétés spécifiques aux cibles Azure SQL Managed Instance.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
Target	Les types de ressources proxy concrets peuvent être créés en alias ce type à l’aide d’un type de propriété spécifique.
TargetAuthenticationType	Type d’authentification à utiliser lors de la connexion à une cible.
TargetListResult	Réponse d’une opération de liste cible.
VaultSecret	Détails spécifiques au coffre requis si vous utilisez l’authentification SQL pour vous connecter à une cible.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ResourceProvisioningState

Énumération

État d’approvisionnement de la ressource de règle d’alerte.

Valeur	Description
Succeeded	La ressource a été créée.
Failed	Échec de la création de ressources.
Canceled	La création de ressources a été annulée.

SqlDbElasticPoolTargetProperties

Object

Propriétés spécifiques à un pool élastique dans Azure SQL Database.

Nom	Type	Valeur par défaut	Description
anchorDatabaseResourceId	string (arm-id)		ID de ressource Azure de la base de données d’ancrage utilisée pour se connecter à un pool élastique.
connectionServerName	string maxLength: 200		Nom d’hôte du nom de domaine complet du serveur à utiliser dans la chaîne de connexion lors de la connexion à une cible. Par exemple, pour un serveur logique Azure SQL dans le cloud commercial Azure, la valeur peut être « sql-logical-server-22092780.database.windows.net » ; pour une instance managée Azure SQL dans le cloud commercial Azure, la valeur peut être « sql-mi-39441134.767d5869f605.database.windows.net ». Le numéro de port et le nom de l’instance doivent être spécifiés séparément.
provisioningState	ResourceProvisioningState		État d’approvisionnement de la ressource.
readIntent	boolean	False	Définissez la valeur true pour surveiller un réplica à haute disponibilité de la cible spécifiée, le cas échéant.
sqlEpResourceId	string (arm-id)		ID de ressource Azure d’une cible de pool élastique Azure SQL DB.
targetAuthenticationType	TargetAuthenticationType		Type d’authentification à utiliser lors de la connexion à une cible.
targetType	string: SqlEp		Propriété discriminator pour TargetProperties.
targetVault	VaultSecret		Pour utiliser l’authentification SQL lors de la connexion à des cibles, spécifiez le coffre où sont stockés le nom de connexion et les secrets de mot de passe.

SqlDbSingleDatabaseTargetProperties

Object

Propriétés spécifiques à une base de données dans Azure SQL Database.

Nom	Type	Valeur par défaut	Description
connectionServerName	string maxLength: 200		Nom d’hôte du nom de domaine complet du serveur à utiliser dans la chaîne de connexion lors de la connexion à une cible. Par exemple, pour un serveur logique Azure SQL dans le cloud commercial Azure, la valeur peut être « sql-logical-server-22092780.database.windows.net » ; pour une instance managée Azure SQL dans le cloud commercial Azure, la valeur peut être « sql-mi-39441134.767d5869f605.database.windows.net ». Le numéro de port et le nom de l’instance doivent être spécifiés séparément.
provisioningState	ResourceProvisioningState		État d’approvisionnement de la ressource.
readIntent	boolean	False	Définissez la valeur true pour surveiller un réplica à haute disponibilité de la cible spécifiée, le cas échéant.
sqlDbResourceId	string (arm-id)		ID de ressource Azure d’une cible de base de données Azure SQL DB.
targetAuthenticationType	TargetAuthenticationType		Type d’authentification à utiliser lors de la connexion à une cible.
targetType	string: SqlDb		Propriété discriminator pour TargetProperties.
targetVault	VaultSecret		Pour utiliser l’authentification SQL lors de la connexion à des cibles, spécifiez le coffre où sont stockés le nom de connexion et les secrets de mot de passe.

SqlMiTargetProperties

Object

Propriétés spécifiques aux cibles Azure SQL Managed Instance.

Nom	Type	Valeur par défaut	Description
connectionServerName	string maxLength: 200		Nom d’hôte du nom de domaine complet du serveur à utiliser dans la chaîne de connexion lors de la connexion à une cible. Par exemple, pour un serveur logique Azure SQL dans le cloud commercial Azure, la valeur peut être « sql-logical-server-22092780.database.windows.net » ; pour une instance managée Azure SQL dans le cloud commercial Azure, la valeur peut être « sql-mi-39441134.767d5869f605.database.windows.net ». Le numéro de port et le nom de l’instance doivent être spécifiés séparément.
connectionTcpPort	integer (int32)	1433	Numéro de port TCP à utiliser éventuellement dans la chaîne de connexion lors de la connexion à une cible Azure SQL Managed Instance.
provisioningState	ResourceProvisioningState		État d’approvisionnement de la ressource.
readIntent	boolean	False	Définissez la valeur true pour surveiller un réplica à haute disponibilité de la cible spécifiée, le cas échéant.
sqlMiResourceId	string (arm-id)		ID de ressource Azure d’une cible Azure SQL Managed Instance.
targetAuthenticationType	TargetAuthenticationType		Type d’authentification à utiliser lors de la connexion à une cible.
targetType	string: SqlMi		Propriété discriminator pour TargetProperties.
targetVault	VaultSecret		Pour utiliser l’authentification SQL lors de la connexion à des cibles, spécifiez le coffre où sont stockés le nom de connexion et les secrets de mot de passe.

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Target

Object

Les types de ressources proxy concrets peuvent être créés en alias ce type à l’aide d’un type de propriété spécifique.

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Propriétés spécifiques à la ressource pour cette ressource.
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

TargetAuthenticationType

Énumération

Type d’authentification à utiliser lors de la connexion à une cible.

Valeur	Description
Aad	Authentification Azure Active Directory.
Sql	Authentification par mot de passe SQL.

TargetListResult

Object

Réponse d’une opération de liste cible.

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	Target[]	Éléments cibles de cette page

VaultSecret

Object

Détails spécifiques au coffre requis si vous utilisez l’authentification SQL pour vous connecter à une cible.

Nom	Type	Description
akvResourceId	string (arm-id)	ID de ressource Azure de l’instance Key Vault stockant les secrets d’authentification de base de données.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	Chemin d’accès au secret Key Vault stockant le mot de passe pour l’authentification auprès d’une cible.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	Chemin d’accès au secret Key Vault stockant le nom de connexion (nom d’utilisateur, nom d’utilisateur ou nom de compte) pour l’authentification auprès d’une cible.