Targets - List By Watcher

Служба:: Database Watcher

Версия API:: 2025-01-02

Вывод списка целевых ресурсов наблюдателем

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть 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, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	TargetListResult	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Targets_ListByWatcher_MaximumSet

Образец запроса

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

Пример ответа

Код состояния:: 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"
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ResourceProvisioningState	Состояние подготовки ресурса правила генерации оповещений.
SqlDbElasticPoolTargetProperties	Свойства, относящиеся к эластичному пулу в Базе данных SQL Azure.
SqlDbSingleDatabaseTargetProperties	Свойства, относящиеся к базе данных в Базе данных SQL Azure.
SqlMiTargetProperties	Свойства, относящиеся к целевым объектам Управляемого экземпляра SQL Azure.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
Target	Конкретные типы ресурсов прокси-сервера можно создать путем псевдонима этого типа с помощью определенного типа свойства.
TargetAuthenticationType	Тип проверки подлинности, используемый при подключении к целевому объекту.
TargetListResult	Ответ операции списка целевых объектов.
VaultSecret	Сведения о хранилище, необходимые при использовании проверки подлинности SQL для подключения к целевому объекту.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ResourceProvisioningState

Перечисление

Состояние подготовки ресурса правила генерации оповещений.

Значение	Описание
Succeeded	Ресурс создан.
Failed	Не удалось создать ресурс.
Canceled	Создание ресурсов было отменено.

SqlDbElasticPoolTargetProperties

Object

Свойства, относящиеся к эластичному пулу в Базе данных SQL Azure.

Имя	Тип	Default value	Описание
anchorDatabaseResourceId	string (arm-id)		Идентификатор ресурса Azure базы данных привязки, используемой для подключения к эластичному пулу.
connectionServerName	string maxLength: 200		Полное доменное имя сервера, используемое в строке подключения при подключении к целевому объекту. Например, для логического сервера SQL Azure в коммерческом облаке Azure значение может иметь значение sql-logical-server-22092780.database.windows.net; для управляемого экземпляра SQL Azure в коммерческом облаке Azure значение может быть "sql-mi-39441134.767d5869f605.database.windows.net". Номер порта и имя экземпляра должны быть указаны отдельно.
provisioningState	ResourceProvisioningState		Состояние подготовки ресурса.
readIntent	boolean	False	Установите значение true для отслеживания реплики высокого уровня доступности указанного целевого объекта, если таковой имеется.
sqlEpResourceId	string (arm-id)		Идентификатор ресурса Azure целевого объекта эластичного пула базы данных SQL Azure.
targetAuthenticationType	TargetAuthenticationType		Тип проверки подлинности, используемый при подключении к целевому объекту.
targetType	string: SqlEp		Дискриминационное свойство targetProperties.
targetVault	VaultSecret		Чтобы использовать проверку подлинности SQL при подключении к целевым объектам, укажите хранилище, в котором хранятся имена входа и секреты паролей.

SqlDbSingleDatabaseTargetProperties

Object

Свойства, относящиеся к базе данных в Базе данных SQL Azure.

Имя	Тип	Default value	Описание
connectionServerName	string maxLength: 200		Полное доменное имя сервера, используемое в строке подключения при подключении к целевому объекту. Например, для логического сервера SQL Azure в коммерческом облаке Azure значение может иметь значение sql-logical-server-22092780.database.windows.net; для управляемого экземпляра SQL Azure в коммерческом облаке Azure значение может быть "sql-mi-39441134.767d5869f605.database.windows.net". Номер порта и имя экземпляра должны быть указаны отдельно.
provisioningState	ResourceProvisioningState		Состояние подготовки ресурса.
readIntent	boolean	False	Установите значение true для отслеживания реплики высокого уровня доступности указанного целевого объекта, если таковой имеется.
sqlDbResourceId	string (arm-id)		Идентификатор ресурса Azure целевого объекта базы данных SQL Azure.
targetAuthenticationType	TargetAuthenticationType		Тип проверки подлинности, используемый при подключении к целевому объекту.
targetType	string: SqlDb		Дискриминационное свойство targetProperties.
targetVault	VaultSecret		Чтобы использовать проверку подлинности SQL при подключении к целевым объектам, укажите хранилище, в котором хранятся имена входа и секреты паролей.

SqlMiTargetProperties

Object

Свойства, относящиеся к целевым объектам Управляемого экземпляра SQL Azure.

Имя	Тип	Default value	Описание
connectionServerName	string maxLength: 200		Полное доменное имя сервера, используемое в строке подключения при подключении к целевому объекту. Например, для логического сервера SQL Azure в коммерческом облаке Azure значение может иметь значение sql-logical-server-22092780.database.windows.net; для управляемого экземпляра SQL Azure в коммерческом облаке Azure значение может быть "sql-mi-39441134.767d5869f605.database.windows.net". Номер порта и имя экземпляра должны быть указаны отдельно.
connectionTcpPort	integer (int32)	1433	Номер TCP-порта, который при необходимости используется в строке подключения при подключении к целевому объекту управляемого экземпляра SQL Azure.
provisioningState	ResourceProvisioningState		Состояние подготовки ресурса.
readIntent	boolean	False	Установите значение true для отслеживания реплики высокого уровня доступности указанного целевого объекта, если таковой имеется.
sqlMiResourceId	string (arm-id)		Идентификатор ресурса Azure целевого объекта Управляемого экземпляра SQL Azure.
targetAuthenticationType	TargetAuthenticationType		Тип проверки подлинности, используемый при подключении к целевому объекту.
targetType	string: SqlMi		Дискриминационное свойство targetProperties.
targetVault	VaultSecret		Чтобы использовать проверку подлинности SQL при подключении к целевым объектам, укажите хранилище, в котором хранятся имена входа и секреты паролей.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Target

Object

Конкретные типы ресурсов прокси-сервера можно создать путем псевдонима этого типа с помощью определенного типа свойства.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Свойства, относящиеся к ресурсу, для этого ресурса.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

TargetAuthenticationType

Перечисление

Тип проверки подлинности, используемый при подключении к целевому объекту.

Значение	Описание
Aad	Проверка подлинности Azure Active Directory.
Sql	Проверка подлинности паролей SQL.

TargetListResult

Object

Ответ операции списка целевых объектов.

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	Target[]	Целевые элементы на этой странице

VaultSecret

Object

Сведения о хранилище, необходимые при использовании проверки подлинности SQL для подключения к целевому объекту.

Имя	Тип	Описание
akvResourceId	string (arm-id)	Идентификатор ресурса Azure экземпляра Key Vault, в котором хранятся секреты проверки подлинности базы данных.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	Путь к секрету Key Vault, в котором хранится пароль для проверки подлинности в целевом объекте.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	Путь к секрету Key Vault, в котором хранится имя входа (имя пользователя, имя учетной записи aka) для проверки подлинности в целевом объекте.