Targets - List By Watcher

Szolgáltatás:

Database Watcher

API-verzió:

2025-01-02

Célerőforrások listázása a Watcher szerint

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Az adatbázis-figyelő neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	TargetListResult	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Targets_ListByWatcher_MaximumSet

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
ResourceProvisioningState	A riasztási szabály erőforrásának kiépítési állapota.
SqlDbElasticPoolTargetProperties	A rugalmas készletre jellemző tulajdonságok Azure SQL Database.
SqlDbSingleDatabaseTargetProperties	A Azure SQL Database adatbázisára jellemző tulajdonságok.
SqlMiTargetProperties	Az Azure SQL Managed Instance célokra jellemző tulajdonságok.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
Target	A konkrét proxyerőforrás-típusok úgy hozhatók létre, hogy ezt a típust egy adott tulajdonságtípus használatával aliasként használják.
TargetAuthenticationType	A célhoz való csatlakozáshoz használandó hitelesítés típusa.
TargetListResult	Egy céllistaművelet válasza.
VaultSecret	A tárolóra vonatkozó részletek, amelyek akkor szükségesek, ha SQL-hitelesítést használnak a célhoz való csatlakozáshoz.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

ResourceProvisioningState

Enumerálás

A riasztási szabály erőforrásának kiépítési állapota.

Érték	Description
Succeeded	Az erőforrás létrejött.
Failed	Az erőforrás létrehozása nem sikerült.
Canceled	Az erőforrás létrehozása megszakadt.

SqlDbElasticPoolTargetProperties

Objektum

A rugalmas készletre jellemző tulajdonságok Azure SQL Database.

Name	Típus	Alapértelmezett érték	Description
anchorDatabaseResourceId	string (arm-id)		A rugalmas készlethez való csatlakozáshoz használt horgonyadatbázis Azure-erőforrás-azonosítója.
connectionServerName	string maxLength: 200		A célhoz való csatlakozáskor a kapcsolati sztringben használni kívánt kiszolgáló teljes tartományneve. Például egy Azure SQL logikai kiszolgáló esetében az Azure kereskedelmi felhőben az érték "sql-logical-server-22092780.database.windows.net"; az Azure-beli kereskedelmi felhőben felügyelt Azure SQL-példányok esetében az érték lehet "sql-mi-39441134.767d5869f605.database.windows.net". A portszámot és a példánynevet külön kell megadni.
provisioningState	ResourceProvisioningState		Az erőforrás kiépítési állapota.
readIntent	boolean	False	Állítsa igaz értékre a megadott cél magas rendelkezésre állású replikája figyeléséhez, ha van ilyen.
sqlEpResourceId	string (arm-id)		Egy rugalmas Azure SQL DB-készlet céljának Azure-erőforrás-azonosítója.
targetAuthenticationType	TargetAuthenticationType		A célhoz való csatlakozáshoz használandó hitelesítés típusa.
targetType	string: SqlEp		A TargetProperties megkülönböztető tulajdonsága.
targetVault	VaultSecret		Ha SQL-hitelesítést szeretne használni a célokhoz való csatlakozáskor, adja meg azt a tárolót, amelyben a bejelentkezési név és a jelszó titkos kulcsai vannak tárolva.

SqlDbSingleDatabaseTargetProperties

Objektum

A Azure SQL Database adatbázisára jellemző tulajdonságok.

Name	Típus	Alapértelmezett érték	Description
connectionServerName	string maxLength: 200		A célhoz való csatlakozáskor a kapcsolati sztringben használni kívánt kiszolgáló teljes tartományneve. Például egy Azure SQL logikai kiszolgáló esetében az Azure kereskedelmi felhőben az érték "sql-logical-server-22092780.database.windows.net"; az Azure-beli kereskedelmi felhőben felügyelt Azure SQL-példányok esetében az érték lehet "sql-mi-39441134.767d5869f605.database.windows.net". A portszámot és a példánynevet külön kell megadni.
provisioningState	ResourceProvisioningState		Az erőforrás kiépítési állapota.
readIntent	boolean	False	Állítsa igaz értékre a megadott cél magas rendelkezésre állású replikája figyeléséhez, ha van ilyen.
sqlDbResourceId	string (arm-id)		Egy Azure SQL DB-adatbázis-cél Azure-erőforrás-azonosítója.
targetAuthenticationType	TargetAuthenticationType		A célhoz való csatlakozáshoz használandó hitelesítés típusa.
targetType	string: SqlDb		A TargetProperties megkülönböztető tulajdonsága.
targetVault	VaultSecret		Ha SQL-hitelesítést szeretne használni a célokhoz való csatlakozáskor, adja meg azt a tárolót, amelyben a bejelentkezési név és a jelszó titkos kulcsai vannak tárolva.

SqlMiTargetProperties

Objektum

Az Azure SQL Managed Instance célokra jellemző tulajdonságok.

Name	Típus	Alapértelmezett érték	Description
connectionServerName	string maxLength: 200		A célhoz való csatlakozáskor a kapcsolati sztringben használni kívánt kiszolgáló teljes tartományneve. Például egy Azure SQL logikai kiszolgáló esetében az Azure kereskedelmi felhőben az érték "sql-logical-server-22092780.database.windows.net"; az Azure-beli kereskedelmi felhőben felügyelt Azure SQL-példányok esetében az érték lehet "sql-mi-39441134.767d5869f605.database.windows.net". A portszámot és a példánynevet külön kell megadni.
connectionTcpPort	integer (int32)	1433	A kapcsolati sztringben opcionálisan használni kívánt TCP-portszám felügyelt Azure SQL-példány céljához való csatlakozáskor.
provisioningState	ResourceProvisioningState		Az erőforrás kiépítési állapota.
readIntent	boolean	False	Állítsa igaz értékre a megadott cél magas rendelkezésre állású replikája figyeléséhez, ha van ilyen.
sqlMiResourceId	string (arm-id)		Egy Felügyelt Azure SQL-példány-cél Azure-erőforrásazonosítója.
targetAuthenticationType	TargetAuthenticationType		A célhoz való csatlakozáshoz használandó hitelesítés típusa.
targetType	string: SqlMi		A TargetProperties megkülönböztető tulajdonsága.
targetVault	VaultSecret		Ha SQL-hitelesítést szeretne használni a célokhoz való csatlakozáskor, adja meg azt a tárolót, amelyben a bejelentkezési név és a jelszó titkos kulcsai vannak tárolva.

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

Target

Objektum

A konkrét proxyerőforrás-típusok úgy hozhatók létre, hogy ezt a típust egy adott tulajdonságtípus használatával aliasként használják.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties	TargetProperties: SqlDbElasticPoolTargetProperties SqlDbSingleDatabaseTargetProperties SqlMiTargetProperties	Az erőforrás erőforrás-specifikus tulajdonságai.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

TargetAuthenticationType

Enumerálás

A célhoz való csatlakozáshoz használandó hitelesítés típusa.

Érték	Description
Aad	Az Azure Active Directory-hitelesítés.
Sql	Az SQL-jelszó hitelesítése.

TargetListResult

Objektum

Egy céllistaművelet válasza.

Name	Típus	Description
nextLink	string (uri)	Az elemek következő oldalára mutató hivatkozás
value	Target[]	A célelemek ezen a lapon

VaultSecret

Objektum

A tárolóra vonatkozó részletek, amelyek akkor szükségesek, ha SQL-hitelesítést használnak a célhoz való csatlakozáshoz.

Name	Típus	Description
akvResourceId	string (arm-id)	Az adatbázis-hitelesítési titkos kulcsokat tároló Key Vault-példány Azure-erőforrás-azonosítója.
akvTargetPassword	string pattern: ^[a-zA-Z0-9-]{1,127}$	A kulcstartó titkos kulcsának elérési útja, amely a célhoz való hitelesítéshez tárolja a jelszót.
akvTargetUser	string pattern: ^[a-zA-Z0-9-]{1,127}$	A kulcstartó titkos kulcsának elérési útja, amely a bejelentkezési nevet (más néven felhasználónév, más néven fióknév) tárolja a célhoz való hitelesítéshez.