Targets - List By Watcher

Layanan:

Database Watcher

Versi API:

2025-01-02

Mencantumkan sumber daya Target menurut Watcher

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Nama pengamat database.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	TargetListResult	Operasi Azure berhasil diselesaikan.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Targets_ListByWatcher_MaximumSet

Permintaan sampel

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ResourceProvisioningState	Status provisi sumber daya aturan pemberitahuan.
SqlDbElasticPoolTargetProperties	Properti khusus untuk kumpulan elastis di Azure SQL Database.
SqlDbSingleDatabaseTargetProperties	Properti khusus untuk database di Azure SQL Database.
SqlMiTargetProperties	Properti khusus untuk target Azure SQL Managed Instance.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Target	Jenis sumber daya proksi konkret dapat dibuat dengan alias jenis ini menggunakan jenis properti tertentu.
TargetAuthenticationType	Jenis autentikasi yang akan digunakan saat menyambungkan ke target.
TargetListResult	Respons operasi daftar Target.
VaultSecret	Detail spesifik vault diperlukan jika menggunakan autentikasi SQL untuk menyambungkan ke target.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ResourceProvisioningState

Enumeration

Status provisi sumber daya aturan pemberitahuan.

Nilai	Deskripsi
Succeeded	Sumber daya telah dibuat.
Failed	Pembuatan sumber daya gagal.
Canceled	Pembuatan sumber daya dibatalkan.

SqlDbElasticPoolTargetProperties

Objek

Properti khusus untuk kumpulan elastis di Azure SQL Database.

Nama	Jenis	Nilai default	Deskripsi
anchorDatabaseResourceId	string (arm-id)		ID sumber daya Azure dari database jangkar yang digunakan untuk menyambungkan ke kumpulan elastis.
connectionServerName	string maxLength: 200		Nama host FQDN server untuk digunakan dalam string koneksi saat menyambungkan ke target. Misalnya, untuk server logis Azure SQL di cloud komersial Azure, nilainya mungkin 'sql-logical-server-22092780.database.windows.net'; untuk instans terkelola Azure SQL di cloud komersial Azure, nilainya mungkin 'sql-mi-39441134.767d5869f605.database.windows.net'. Nomor port dan nama instans harus ditentukan secara terpisah.
provisioningState	ResourceProvisioningState		Status provisi sumber daya.
readIntent	boolean	False	Atur ke true untuk memantau replika ketersediaan tinggi dari target yang ditentukan, jika ada.
sqlEpResourceId	string (arm-id)		ID sumber daya Azure dari target kumpulan elastis Azure SQL DB.
targetAuthenticationType	TargetAuthenticationType		Jenis autentikasi yang akan digunakan saat menyambungkan ke target.
targetType	string: SqlEp		Properti diskriminator untuk TargetProperties.
targetVault	VaultSecret		Untuk menggunakan autentikasi SQL saat menyambungkan ke target, tentukan vault tempat nama masuk dan rahasia kata sandi disimpan.

SqlDbSingleDatabaseTargetProperties

Objek

Properti khusus untuk database di Azure SQL Database.

Nama	Jenis	Nilai default	Deskripsi
connectionServerName	string maxLength: 200		Nama host FQDN server untuk digunakan dalam string koneksi saat menyambungkan ke target. Misalnya, untuk server logis Azure SQL di cloud komersial Azure, nilainya mungkin 'sql-logical-server-22092780.database.windows.net'; untuk instans terkelola Azure SQL di cloud komersial Azure, nilainya mungkin 'sql-mi-39441134.767d5869f605.database.windows.net'. Nomor port dan nama instans harus ditentukan secara terpisah.
provisioningState	ResourceProvisioningState		Status provisi sumber daya.
readIntent	boolean	False	Atur ke true untuk memantau replika ketersediaan tinggi dari target yang ditentukan, jika ada.
sqlDbResourceId	string (arm-id)		ID sumber daya Azure dari target database Azure SQL DB.
targetAuthenticationType	TargetAuthenticationType		Jenis autentikasi yang akan digunakan saat menyambungkan ke target.
targetType	string: SqlDb		Properti diskriminator untuk TargetProperties.
targetVault	VaultSecret		Untuk menggunakan autentikasi SQL saat menyambungkan ke target, tentukan vault tempat nama masuk dan rahasia kata sandi disimpan.

SqlMiTargetProperties

Objek

Properti khusus untuk target Azure SQL Managed Instance.

Nama	Jenis	Nilai default	Deskripsi
connectionServerName	string maxLength: 200		Nama host FQDN server untuk digunakan dalam string koneksi saat menyambungkan ke target. Misalnya, untuk server logis Azure SQL di cloud komersial Azure, nilainya mungkin 'sql-logical-server-22092780.database.windows.net'; untuk instans terkelola Azure SQL di cloud komersial Azure, nilainya mungkin 'sql-mi-39441134.767d5869f605.database.windows.net'. Nomor port dan nama instans harus ditentukan secara terpisah.
connectionTcpPort	integer (int32)	1433	Nomor port TCP untuk digunakan secara opsional dalam string koneksi saat menyambungkan ke target Azure SQL Managed Instance.
provisioningState	ResourceProvisioningState		Status provisi sumber daya.
readIntent	boolean	False	Atur ke true untuk memantau replika ketersediaan tinggi dari target yang ditentukan, jika ada.
sqlMiResourceId	string (arm-id)		ID sumber daya Azure dari target Azure SQL Managed Instance.
targetAuthenticationType	TargetAuthenticationType		Jenis autentikasi yang akan digunakan saat menyambungkan ke target.
targetType	string: SqlMi		Properti diskriminator untuk TargetProperties.
targetVault	VaultSecret		Untuk menggunakan autentikasi SQL saat menyambungkan ke target, tentukan vault tempat nama masuk dan rahasia kata sandi disimpan.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

Target

Objek

Jenis sumber daya proksi konkret dapat dibuat dengan alias jenis ini menggunakan jenis properti tertentu.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Properti khusus sumber daya untuk sumber daya ini.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

TargetAuthenticationType

Enumeration

Jenis autentikasi yang akan digunakan saat menyambungkan ke target.

Nilai	Deskripsi
Aad	Autentikasi Azure Active Directory.
Sql	Autentikasi kata sandi SQL.

TargetListResult

Objek

Respons operasi daftar Target.

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	Target[]	Item Target di halaman ini

VaultSecret

Objek

Detail spesifik vault diperlukan jika menggunakan autentikasi SQL untuk menyambungkan ke target.

Nama	Jenis	Deskripsi
akvResourceId	string (arm-id)	ID sumber daya Azure dari instans Key Vault yang menyimpan rahasia autentikasi database.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	Jalur ke rahasia Key Vault yang menyimpan kata sandi untuk autentikasi ke target.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	Jalur ke rahasia Key Vault yang menyimpan nama login (alias nama pengguna, alias nama akun) untuk autentikasi ke target.