Targets - List By Watcher

서비스:

Database Watcher

API 버전:

2025-01-02

Watcher별 대상 리소스 나열

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	데이터베이스 감시자 이름입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	TargetListResult	Azure 작업이 성공적으로 완료되었습니다.
Other Status Codes	ErrorResponse	예기치 않은 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

Targets_ListByWatcher_MaximumSet

샘플 요청

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

샘플 응답

상태 코드:

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

정의

Name	Description
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
ResourceProvisioningState	경고 규칙 리소스의 프로비전 상태입니다.
SqlDbElasticPoolTargetProperties	Azure SQL Database의 탄력적 풀과 관련된 속성입니다.
SqlDbSingleDatabaseTargetProperties	Azure SQL Database의 데이터베이스와 관련된 속성입니다.
SqlMiTargetProperties	Azure SQL Managed Instance 대상과 관련된 속성입니다.
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
Target	특정 속성 형식을 사용하여 이 형식의 별칭을 지정하여 구체적인 프록시 리소스 유형을 만들 수 있습니다.
TargetAuthenticationType	대상에 연결할 때 사용할 인증 유형입니다.
TargetListResult	대상 목록 작업의 응답입니다.
VaultSecret	SQL 인증을 사용하여 대상에 연결하는 경우 필요한 자격 증명 모음 관련 세부 정보입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

ResourceProvisioningState

열거형

경고 규칙 리소스의 프로비전 상태입니다.

값	Description
Succeeded	리소스가 만들어졌습니다.
Failed	리소스를 만들지 못했습니다.
Canceled	리소스 만들기가 취소되었습니다.

SqlDbElasticPoolTargetProperties

Object

Azure SQL Database의 탄력적 풀과 관련된 속성입니다.

Name	형식	Default value	Description
anchorDatabaseResourceId	string (arm-id)		탄력적 풀에 연결하는 데 사용되는 앵커 데이터베이스의 Azure 리소스 ID입니다.
connectionServerName	string maxLength: 200		대상에 연결할 때 연결 문자열에 사용할 서버의 FQDN 호스트 이름입니다. 예를 들어 Azure 상용 클라우드의 Azure SQL 논리 서버의 경우 값은 'sql-logical-server-22092780.database.windows.net'일 수 있습니다. Azure 상용 클라우드의 Azure SQL 관리형 인스턴스의 경우 값은 'sql-mi-39441134.767d5869f605.database.windows.net'일 수 있습니다. 포트 번호와 인스턴스 이름은 별도로 지정해야 합니다.
provisioningState	ResourceProvisioningState		리소스의 프로비전 상태입니다.
readIntent	boolean	False	지정된 대상의 고가용성 복제본(있는 경우)을 모니터링하려면 true로 설정합니다.
sqlEpResourceId	string (arm-id)		Azure SQL DB 탄력적 풀 대상의 Azure 리소스 ID입니다.
targetAuthenticationType	TargetAuthenticationType		대상에 연결할 때 사용할 인증 유형입니다.
targetType	string: SqlEp		TargetProperties에 대한 판별자 속성입니다.
targetVault	VaultSecret		대상에 연결할 때 SQL 인증을 사용하려면 로그인 이름 및 암호 비밀이 저장되는 자격 증명 모음을 지정합니다.

SqlDbSingleDatabaseTargetProperties

Object

Azure SQL Database의 데이터베이스와 관련된 속성입니다.

Name	형식	Default value	Description
connectionServerName	string maxLength: 200		대상에 연결할 때 연결 문자열에 사용할 서버의 FQDN 호스트 이름입니다. 예를 들어 Azure 상용 클라우드의 Azure SQL 논리 서버의 경우 값은 'sql-logical-server-22092780.database.windows.net'일 수 있습니다. Azure 상용 클라우드의 Azure SQL 관리형 인스턴스의 경우 값은 'sql-mi-39441134.767d5869f605.database.windows.net'일 수 있습니다. 포트 번호와 인스턴스 이름은 별도로 지정해야 합니다.
provisioningState	ResourceProvisioningState		리소스의 프로비전 상태입니다.
readIntent	boolean	False	지정된 대상의 고가용성 복제본(있는 경우)을 모니터링하려면 true로 설정합니다.
sqlDbResourceId	string (arm-id)		Azure SQL DB 데이터베이스 대상의 Azure 리소스 ID입니다.
targetAuthenticationType	TargetAuthenticationType		대상에 연결할 때 사용할 인증 유형입니다.
targetType	string: SqlDb		TargetProperties에 대한 판별자 속성입니다.
targetVault	VaultSecret		대상에 연결할 때 SQL 인증을 사용하려면 로그인 이름 및 암호 비밀이 저장되는 자격 증명 모음을 지정합니다.

SqlMiTargetProperties

Object

Azure SQL Managed Instance 대상과 관련된 속성입니다.

Name	형식	Default value	Description
connectionServerName	string maxLength: 200		대상에 연결할 때 연결 문자열에 사용할 서버의 FQDN 호스트 이름입니다. 예를 들어 Azure 상용 클라우드의 Azure SQL 논리 서버의 경우 값은 'sql-logical-server-22092780.database.windows.net'일 수 있습니다. Azure 상용 클라우드의 Azure SQL 관리형 인스턴스의 경우 값은 'sql-mi-39441134.767d5869f605.database.windows.net'일 수 있습니다. 포트 번호와 인스턴스 이름은 별도로 지정해야 합니다.
connectionTcpPort	integer (int32)	1433	Azure SQL Managed Instance 대상에 연결할 때 연결 문자열에서 선택적으로 사용할 TCP 포트 번호입니다.
provisioningState	ResourceProvisioningState		리소스의 프로비전 상태입니다.
readIntent	boolean	False	지정된 대상의 고가용성 복제본(있는 경우)을 모니터링하려면 true로 설정합니다.
sqlMiResourceId	string (arm-id)		Azure SQL Managed Instance 대상의 Azure 리소스 ID입니다.
targetAuthenticationType	TargetAuthenticationType		대상에 연결할 때 사용할 인증 유형입니다.
targetType	string: SqlMi		TargetProperties에 대한 판별자 속성입니다.
targetVault	VaultSecret		대상에 연결할 때 SQL 인증을 사용하려면 로그인 이름 및 암호 비밀이 저장되는 자격 증명 모음을 지정합니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

Target

Object

특정 속성 형식을 사용하여 이 형식의 별칭을 지정하여 구체적인 프록시 리소스 유형을 만들 수 있습니다.

Name	형식	Description
id	string (arm-id)	리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	리소스의 이름
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	이 리소스에 대한 리소스별 속성입니다.
systemData	systemData	createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

TargetAuthenticationType

열거형

대상에 연결할 때 사용할 인증 유형입니다.

값	Description
Aad	Azure Active Directory 인증입니다.
Sql	SQL 암호 인증입니다.

TargetListResult

Object

대상 목록 작업의 응답입니다.

Name	형식	Description
nextLink	string (uri)	항목의 다음 페이지에 대한 링크
value	Target[]	이 페이지의 대상 항목

VaultSecret

Object

SQL 인증을 사용하여 대상에 연결하는 경우 필요한 자격 증명 모음 관련 세부 정보입니다.

Name	형식	Description
akvResourceId	string (arm-id)	데이터베이스 인증 비밀을 저장하는 Key Vault 인스턴스의 Azure 리소스 ID입니다.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	대상에 대한 인증을 위해 암호를 저장하는 Key Vault 비밀의 경로입니다.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	대상에 대한 인증을 위해 로그인 이름(즉, 사용자 이름, 계정 이름)을 저장하는 Key Vault 비밀의 경로입니다.