Targets - List By Watcher

Dienst:

Database Watcher

API-Version:

2025-01-02

Auflisten von Zielressourcen nach Watcher

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Der Name der Datenbanküberwachung.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	TargetListResult	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Targets_ListByWatcher_MaximumSet

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ResourceProvisioningState	Der Bereitstellungsstatus der Warnungsregelressource.
SqlDbElasticPoolTargetProperties	Die Eigenschaften, die für einen Pool für elastische Datenbanken in Azure SQL-Datenbank spezifisch sind.
SqlDbSingleDatabaseTargetProperties	Die Eigenschaften, die für eine Datenbank in Azure SQL-Datenbank spezifisch sind.
SqlMiTargetProperties	Die Eigenschaften, die für Azure SQL Managed Instance-Ziele spezifisch sind.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
Target	Konkrete Proxyressourcentypen können durch Aliasing dieses Typs mithilfe eines bestimmten Eigenschaftstyps erstellt werden.
TargetAuthenticationType	Der Typ der Authentifizierung, die beim Herstellen einer Verbindung mit einem Ziel verwendet werden soll.
TargetListResult	Die Antwort eines Ziellistenvorgangs.
VaultSecret	Die tresorspezifischen Details, die angegeben werden müssen, wenn die SQL-Authentifizierung zum Herstellen einer Verbindung mit einem Ziel verwendet wird.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ResourceProvisioningState

Enumeration

Der Bereitstellungsstatus der Warnungsregelressource.

Wert	Beschreibung
Succeeded	Ressource wurde erstellt.
Failed	Fehler bei der Ressourcenerstellung.
Canceled	Die Ressourcenerstellung wurde abgebrochen.

SqlDbElasticPoolTargetProperties

Objekt

Die Eigenschaften, die für einen Pool für elastische Datenbanken in Azure SQL-Datenbank spezifisch sind.

Name	Typ	Standardwert	Beschreibung
anchorDatabaseResourceId	string (arm-id)		Die Azure-Ressourcen-ID der Ankerdatenbank, die zum Herstellen einer Verbindung mit einem elastischen Pool verwendet wird.
connectionServerName	string maxLength: 200		Der FQDN-Hostname des Servers, der beim Herstellen einer Verbindung mit einem Ziel in der Verbindungszeichenfolge verwendet werden soll. Bei einem logischen Azure SQL-Server in der kommerziellen Azure-Cloud kann der Wert beispielsweise "sql-logical-server-22092780.database.windows.net" sein; für eine von Azure SQL verwaltete Instanz in der kommerziellen Azure-Cloud kann der Wert "sql-mi-39441134.767d5869f605.database.windows.net" sein. Portnummer und Instanzname müssen separat angegeben werden.
provisioningState	ResourceProvisioningState		Der Bereitstellungsstatus der Ressource.
readIntent	boolean	False	Legen Sie auf "true" fest, um ein Replikat mit hoher Verfügbarkeit des angegebenen Ziels (sofern vorhanden) zu überwachen.
sqlEpResourceId	string (arm-id)		Die Azure-Ressourcen-ID eines Azure SQL DB-Flexiblen Poolziels.
targetAuthenticationType	TargetAuthenticationType		Der Typ der Authentifizierung, die beim Herstellen einer Verbindung mit einem Ziel verwendet werden soll.
targetType	string: SqlEp		Diskriminator-Eigenschaft für TargetProperties.
targetVault	VaultSecret		Wenn Sie beim Herstellen einer Verbindung mit Zielen die SQL-Authentifizierung verwenden möchten, geben Sie den Tresor an, in dem der Anmeldename und die geheimen Kennwortschlüssel gespeichert sind.

SqlDbSingleDatabaseTargetProperties

Objekt

Die Eigenschaften, die für eine Datenbank in Azure SQL-Datenbank spezifisch sind.

Name	Typ	Standardwert	Beschreibung
connectionServerName	string maxLength: 200		Der FQDN-Hostname des Servers, der beim Herstellen einer Verbindung mit einem Ziel in der Verbindungszeichenfolge verwendet werden soll. Bei einem logischen Azure SQL-Server in der kommerziellen Azure-Cloud kann der Wert beispielsweise "sql-logical-server-22092780.database.windows.net" sein; für eine von Azure SQL verwaltete Instanz in der kommerziellen Azure-Cloud kann der Wert "sql-mi-39441134.767d5869f605.database.windows.net" sein. Portnummer und Instanzname müssen separat angegeben werden.
provisioningState	ResourceProvisioningState		Der Bereitstellungsstatus der Ressource.
readIntent	boolean	False	Legen Sie auf "true" fest, um ein Replikat mit hoher Verfügbarkeit des angegebenen Ziels (sofern vorhanden) zu überwachen.
sqlDbResourceId	string (arm-id)		Die Azure-Ressourcen-ID eines Azure SQL DB-Datenbankziels.
targetAuthenticationType	TargetAuthenticationType		Der Typ der Authentifizierung, die beim Herstellen einer Verbindung mit einem Ziel verwendet werden soll.
targetType	string: SqlDb		Diskriminator-Eigenschaft für TargetProperties.
targetVault	VaultSecret		Wenn Sie beim Herstellen einer Verbindung mit Zielen die SQL-Authentifizierung verwenden möchten, geben Sie den Tresor an, in dem der Anmeldename und die geheimen Kennwortschlüssel gespeichert sind.

SqlMiTargetProperties

Objekt

Die Eigenschaften, die für Azure SQL Managed Instance-Ziele spezifisch sind.

Name	Typ	Standardwert	Beschreibung
connectionServerName	string maxLength: 200		Der FQDN-Hostname des Servers, der beim Herstellen einer Verbindung mit einem Ziel in der Verbindungszeichenfolge verwendet werden soll. Bei einem logischen Azure SQL-Server in der kommerziellen Azure-Cloud kann der Wert beispielsweise "sql-logical-server-22092780.database.windows.net" sein; für eine von Azure SQL verwaltete Instanz in der kommerziellen Azure-Cloud kann der Wert "sql-mi-39441134.767d5869f605.database.windows.net" sein. Portnummer und Instanzname müssen separat angegeben werden.
connectionTcpPort	integer (int32)	1433	Die TCP-Portnummer, die optional in der Verbindungszeichenfolge beim Herstellen einer Verbindung mit einem Azure SQL Managed Instance-Ziel verwendet werden soll.
provisioningState	ResourceProvisioningState		Der Bereitstellungsstatus der Ressource.
readIntent	boolean	False	Legen Sie auf "true" fest, um ein Replikat mit hoher Verfügbarkeit des angegebenen Ziels (sofern vorhanden) zu überwachen.
sqlMiResourceId	string (arm-id)		Die Azure-Ressourcen-ID eines Azure SQL Managed Instance-Ziels.
targetAuthenticationType	TargetAuthenticationType		Der Typ der Authentifizierung, die beim Herstellen einer Verbindung mit einem Ziel verwendet werden soll.
targetType	string: SqlMi		Diskriminator-Eigenschaft für TargetProperties.
targetVault	VaultSecret		Wenn Sie beim Herstellen einer Verbindung mit Zielen die SQL-Authentifizierung verwenden möchten, geben Sie den Tresor an, in dem der Anmeldename und die geheimen Kennwortschlüssel gespeichert sind.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Target

Objekt

Konkrete Proxyressourcentypen können durch Aliasing dieses Typs mithilfe eines bestimmten Eigenschaftstyps erstellt werden.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Die ressourcenspezifischen Eigenschaften für diese Ressource.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

TargetAuthenticationType

Enumeration

Der Typ der Authentifizierung, die beim Herstellen einer Verbindung mit einem Ziel verwendet werden soll.

Wert	Beschreibung
Aad	Die Azure Active Directory-Authentifizierung.
Sql	Die SQL-Kennwortauthentifizierung.

TargetListResult

Objekt

Die Antwort eines Ziellistenvorgangs.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	Target[]	Die Zielelemente auf dieser Seite

VaultSecret

Objekt

Die tresorspezifischen Details, die angegeben werden müssen, wenn die SQL-Authentifizierung zum Herstellen einer Verbindung mit einem Ziel verwendet wird.

Name	Typ	Beschreibung
akvResourceId	string (arm-id)	Die Azure-Ressourcen-ID der Key Vault-Instanz, die geheime Datenbankauthentifizierungsschlüssel speichert.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	Der Pfad zum Schlüsseltresor-Schlüssel, der das Kennwort für die Authentifizierung für ein Ziel speichert.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	Der Pfad zum geheimen Schlüsseltresor, der den Anmeldenamen (auch als Benutzername bezeichnet) für die Authentifizierung an ein Ziel speichert.