Targets - List By Watcher

Usługa:: Database Watcher

Wersja interfejsu API:: 2025-01-02

Wyświetlanie listy zasobów docelowych według obserwatora

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Nazwa obserwatora bazy danych.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TargetListResult	Operacja platformy Azure została ukończona pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Targets_ListByWatcher_MaximumSet

Przykładowe żądanie

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


/**
 * 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

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

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

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ResourceProvisioningState	Stan aprowizacji zasobu reguły alertu.
SqlDbElasticPoolTargetProperties	Właściwości specyficzne dla elastycznej puli w Azure SQL Database.
SqlDbSingleDatabaseTargetProperties	Właściwości specyficzne dla bazy danych w Azure SQL Database.
SqlMiTargetProperties	Właściwości specyficzne dla obiektów docelowych Azure SQL Managed Instance.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
Target	Konkretne typy zasobów serwera proxy można utworzyć, aliasując ten typ przy użyciu określonego typu właściwości.
TargetAuthenticationType	Typ uwierzytelniania do użycia podczas nawiązywania połączenia z obiektem docelowym.
TargetListResult	Odpowiedź operacji listy docelowej.
VaultSecret	Szczegółowe informacje dotyczące magazynu wymagane w przypadku używania uwierzytelniania SQL do nawiązania połączenia z obiektem docelowym.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ResourceProvisioningState

Wyliczanie

Stan aprowizacji zasobu reguły alertu.

Wartość	Opis
Succeeded	Zasób został utworzony.
Failed	Tworzenie zasobu nie powiodło się.
Canceled	Tworzenie zasobów zostało anulowane.

SqlDbElasticPoolTargetProperties

Objekt

Właściwości specyficzne dla elastycznej puli w Azure SQL Database.

Nazwa	Typ	Domyślna wartość	Opis
anchorDatabaseResourceId	string (arm-id)		Identyfikator zasobu platformy Azure bazy danych kotwicy używanej do nawiązywania połączenia z pulą elastyczną.
connectionServerName	string maxLength: 200		Nazwa hosta FQDN serwera do użycia w parametrach połączenia podczas nawiązywania połączenia z obiektem docelowym. Na przykład w przypadku serwera logicznego Azure SQL w chmurze komercyjnej platformy Azure wartość może być "sql-logical-server-22092780.database.windows.net".; w przypadku wystąpienia zarządzanego usługi Azure SQL w chmurze komercyjnej platformy Azure wartość może być "sql-mi-39441134.767d5869f605.database.windows.net". Numer portu i nazwa wystąpienia muszą być określone oddzielnie.
provisioningState	ResourceProvisioningState		Stan aprowizacji zasobu.
readIntent	boolean	False	Ustaw wartość true, aby monitorować replikę o wysokiej dostępności określonego obiektu docelowego, jeśli istnieje.
sqlEpResourceId	string (arm-id)		Identyfikator zasobu platformy Azure docelowego puli elastycznej usługi Azure SQL DB.
targetAuthenticationType	TargetAuthenticationType		Typ uwierzytelniania do użycia podczas nawiązywania połączenia z obiektem docelowym.
targetType	string: SqlEp		Właściwość dyskryminująca właściwości TargetProperties.
targetVault	VaultSecret		Aby użyć uwierzytelniania SQL podczas nawiązywania połączenia z obiektami docelowymi, określ magazyn, w którym są przechowywane nazwy logowania i wpisy tajne haseł.

SqlDbSingleDatabaseTargetProperties

Objekt

Właściwości specyficzne dla bazy danych w Azure SQL Database.

Nazwa	Typ	Domyślna wartość	Opis
connectionServerName	string maxLength: 200		Nazwa hosta FQDN serwera do użycia w parametrach połączenia podczas nawiązywania połączenia z obiektem docelowym. Na przykład w przypadku serwera logicznego Azure SQL w chmurze komercyjnej platformy Azure wartość może być "sql-logical-server-22092780.database.windows.net".; w przypadku wystąpienia zarządzanego usługi Azure SQL w chmurze komercyjnej platformy Azure wartość może być "sql-mi-39441134.767d5869f605.database.windows.net". Numer portu i nazwa wystąpienia muszą być określone oddzielnie.
provisioningState	ResourceProvisioningState		Stan aprowizacji zasobu.
readIntent	boolean	False	Ustaw wartość true, aby monitorować replikę o wysokiej dostępności określonego obiektu docelowego, jeśli istnieje.
sqlDbResourceId	string (arm-id)		Identyfikator zasobu platformy Azure docelowego bazy danych Azure SQL DB.
targetAuthenticationType	TargetAuthenticationType		Typ uwierzytelniania do użycia podczas nawiązywania połączenia z obiektem docelowym.
targetType	string: SqlDb		Właściwość dyskryminująca właściwości TargetProperties.
targetVault	VaultSecret		Aby użyć uwierzytelniania SQL podczas nawiązywania połączenia z obiektami docelowymi, określ magazyn, w którym są przechowywane nazwy logowania i wpisy tajne haseł.

SqlMiTargetProperties

Objekt

Właściwości specyficzne dla obiektów docelowych Azure SQL Managed Instance.

Nazwa	Typ	Domyślna wartość	Opis
connectionServerName	string maxLength: 200		Nazwa hosta FQDN serwera do użycia w parametrach połączenia podczas nawiązywania połączenia z obiektem docelowym. Na przykład w przypadku serwera logicznego Azure SQL w chmurze komercyjnej platformy Azure wartość może być "sql-logical-server-22092780.database.windows.net".; w przypadku wystąpienia zarządzanego usługi Azure SQL w chmurze komercyjnej platformy Azure wartość może być "sql-mi-39441134.767d5869f605.database.windows.net". Numer portu i nazwa wystąpienia muszą być określone oddzielnie.
connectionTcpPort	integer (int32)	1433	Numer portu TCP do opcjonalnego użycia w parametrach połączenia podczas nawiązywania połączenia z docelowym wystąpieniem zarządzanym usługi Azure SQL.
provisioningState	ResourceProvisioningState		Stan aprowizacji zasobu.
readIntent	boolean	False	Ustaw wartość true, aby monitorować replikę o wysokiej dostępności określonego obiektu docelowego, jeśli istnieje.
sqlMiResourceId	string (arm-id)		Identyfikator zasobu platformy Azure docelowego wystąpienia zarządzanego Azure SQL.
targetAuthenticationType	TargetAuthenticationType		Typ uwierzytelniania do użycia podczas nawiązywania połączenia z obiektem docelowym.
targetType	string: SqlMi		Właściwość dyskryminująca właściwości TargetProperties.
targetVault	VaultSecret		Aby użyć uwierzytelniania SQL podczas nawiązywania połączenia z obiektami docelowymi, określ magazyn, w którym są przechowywane nazwy logowania i wpisy tajne haseł.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Target

Objekt

Konkretne typy zasobów serwera proxy można utworzyć, aliasując ten typ przy użyciu określonego typu właściwości.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Właściwości specyficzne dla zasobu dla tego zasobu.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

TargetAuthenticationType

Wyliczanie

Typ uwierzytelniania do użycia podczas nawiązywania połączenia z obiektem docelowym.

Wartość	Opis
Aad	Uwierzytelnianie usługi Azure Active Directory.
Sql	Uwierzytelnianie hasłem SQL.

TargetListResult

Objekt

Odpowiedź operacji listy docelowej.

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	Target[]	Elementy docelowe na tej stronie

VaultSecret

Objekt

Szczegółowe informacje dotyczące magazynu wymagane w przypadku używania uwierzytelniania SQL do nawiązania połączenia z obiektem docelowym.

Nazwa	Typ	Opis
akvResourceId	string (arm-id)	Identyfikator zasobu platformy Azure wystąpienia usługi Key Vault przechowujące wpisy tajne uwierzytelniania bazy danych.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	Ścieżka do wpisu tajnego usługi Key Vault przechowująca hasło do uwierzytelniania w obiekcie docelowym.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	Ścieżka do wpisu tajnego usługi Key Vault przechowująca nazwę logowania (czyli nazwę użytkownika, czyli nazwę konta) na potrzeby uwierzytelniania w lokalizacji docelowej.