Targets - List By Watcher

Serviço:

Database Watcher

Versão da API:

2025-01-02

Listar recursos de destino por observador

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	O nome do inspetor do banco de dados.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	TargetListResult	Operação do Azure concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Targets_ListByWatcher_MaximumSet

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ResourceProvisioningState	O estado de provisionamento do recurso de regra de alerta.
SqlDbElasticPoolTargetProperties	As propriedades específicas de um pool elástico no Banco de Dados SQL do Azure.
SqlDbSingleDatabaseTargetProperties	As propriedades específicas de um banco de dados no Banco de Dados SQL do Azure.
SqlMiTargetProperties	As propriedades específicas dos destinos da Instância Gerenciada SQL do Azure.
systemData	Metadados referentes à criação e última modificação do recurso.
Target	Tipos de recursos de proxy concretos podem ser criados aliando esse tipo usando um tipo de propriedade específico.
TargetAuthenticationType	O tipo de autenticação a ser usado ao se conectar a um destino.
TargetListResult	A resposta de uma operação de lista de destino.
VaultSecret	Os detalhes específicos do cofre necessários se estiver usando a autenticação SQL para se conectar a um destino.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ResourceProvisioningState

Enumeração

O estado de provisionamento do recurso de regra de alerta.

Valor	Description
Succeeded	O recurso foi criado.
Failed	Falha na criação de recursos.
Canceled	A criação de recursos foi cancelada.

SqlDbElasticPoolTargetProperties

Object

As propriedades específicas de um pool elástico no Banco de Dados SQL do Azure.

Name	Tipo	Default value	Description
anchorDatabaseResourceId	string (arm-id)		A ID de recurso do Azure do banco de dados âncora usado para se conectar a um pool elástico.
connectionServerName	string maxLength: 200		O nome do host FQDN do servidor a ser usado na cadeia de conexão ao se conectar a um destino. Por exemplo, para um servidor lógico SQL do Azure na nuvem comercial do Azure, o valor pode ser 'sql-logical-server-22092780.database.windows.net'; para uma instância gerenciada SQL do Azure na nuvem comercial do Azure, o valor pode ser 'sql-mi-39441134.767d5869f605.database.windows.net'. O número da porta e o nome da instância devem ser especificados separadamente.
provisioningState	ResourceProvisioningState		O estado de provisionamento do recurso.
readIntent	boolean	False	Defina como true para monitorar uma réplica de alta disponibilidade do destino especificado, se houver.
sqlEpResourceId	string (arm-id)		A ID de recurso do Azure de um destino de pool elástico do Banco de Dados SQL do Azure.
targetAuthenticationType	TargetAuthenticationType		O tipo de autenticação a ser usado ao se conectar a um destino.
targetType	string: SqlEp		Propriedade Discriminator para TargetProperties.
targetVault	VaultSecret		Para usar a autenticação SQL ao se conectar a destinos, especifique o cofre onde o nome de logon e os segredos de senha são armazenados.

SqlDbSingleDatabaseTargetProperties

Object

As propriedades específicas de um banco de dados no Banco de Dados SQL do Azure.

Name	Tipo	Default value	Description
connectionServerName	string maxLength: 200		O nome do host FQDN do servidor a ser usado na cadeia de conexão ao se conectar a um destino. Por exemplo, para um servidor lógico SQL do Azure na nuvem comercial do Azure, o valor pode ser 'sql-logical-server-22092780.database.windows.net'; para uma instância gerenciada SQL do Azure na nuvem comercial do Azure, o valor pode ser 'sql-mi-39441134.767d5869f605.database.windows.net'. O número da porta e o nome da instância devem ser especificados separadamente.
provisioningState	ResourceProvisioningState		O estado de provisionamento do recurso.
readIntent	boolean	False	Defina como true para monitorar uma réplica de alta disponibilidade do destino especificado, se houver.
sqlDbResourceId	string (arm-id)		A ID de recurso do Azure de um destino de banco de dados do Banco de Dados SQL do Azure.
targetAuthenticationType	TargetAuthenticationType		O tipo de autenticação a ser usado ao se conectar a um destino.
targetType	string: SqlDb		Propriedade Discriminator para TargetProperties.
targetVault	VaultSecret		Para usar a autenticação SQL ao se conectar a destinos, especifique o cofre onde o nome de logon e os segredos de senha são armazenados.

SqlMiTargetProperties

Object

As propriedades específicas dos destinos da Instância Gerenciada SQL do Azure.

Name	Tipo	Default value	Description
connectionServerName	string maxLength: 200		O nome do host FQDN do servidor a ser usado na cadeia de conexão ao se conectar a um destino. Por exemplo, para um servidor lógico SQL do Azure na nuvem comercial do Azure, o valor pode ser 'sql-logical-server-22092780.database.windows.net'; para uma instância gerenciada SQL do Azure na nuvem comercial do Azure, o valor pode ser 'sql-mi-39441134.767d5869f605.database.windows.net'. O número da porta e o nome da instância devem ser especificados separadamente.
connectionTcpPort	integer (int32)	1433	O número da porta TCP a ser usado opcionalmente na cadeia de conexão ao se conectar a um destino da Instância Gerenciada SQL do Azure.
provisioningState	ResourceProvisioningState		O estado de provisionamento do recurso.
readIntent	boolean	False	Defina como true para monitorar uma réplica de alta disponibilidade do destino especificado, se houver.
sqlMiResourceId	string (arm-id)		A ID de recurso do Azure de um destino de Instância Gerenciada SQL do Azure.
targetAuthenticationType	TargetAuthenticationType		O tipo de autenticação a ser usado ao se conectar a um destino.
targetType	string: SqlMi		Propriedade Discriminator para TargetProperties.
targetVault	VaultSecret		Para usar a autenticação SQL ao se conectar a destinos, especifique o cofre onde o nome de logon e os segredos de senha são armazenados.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Target

Object

Tipos de recursos de proxy concretos podem ser criados aliando esse tipo usando um tipo de propriedade específico.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	As propriedades específicas do recurso para este recurso.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

TargetAuthenticationType

Enumeração

O tipo de autenticação a ser usado ao se conectar a um destino.

Valor	Description
Aad	A autenticação do Azure Ative Directory.
Sql	A autenticação de senha SQL.

TargetListResult

Object

A resposta de uma operação de lista de destino.

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	Target[]	Os itens de destino nesta página

VaultSecret

Object

Os detalhes específicos do cofre necessários se estiver usando a autenticação SQL para se conectar a um destino.

Name	Tipo	Description
akvResourceId	string (arm-id)	A ID de recurso do Azure da instância do Cofre da Chave que armazena segredos de autenticação de banco de dados.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	O caminho para o segredo do Cofre de Chaves que armazena a senha para autenticação em um destino.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	O caminho para o segredo do Cofre da Chave que armazena o nome de login (também conhecido como nome de usuário, também conhecido como nome de conta) para autenticação em um destino.