Watchers - Get

Szolgáltatás:

Database Watcher

API-verzió:

2025-01-02

Figyelő lekérése

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}?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	Watcher	Az Azure-művelet sikeresen befejeződött.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

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

Watchers_Get_MaximumSet

Mintakérelem

HTTP

GET https://management.azure.com/subscriptions/A76F9850-996B-40B3-94D4-C98110A0EEC9/resourceGroups/rgWatcher/providers/Microsoft.DatabaseWatcher/watchers/myWatcher?api-version=2025-01-02

Java

/**
 * Samples for Watchers GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-02/Watchers_Get_MaximumSet_Gen.json
     */
    /**
     * Sample code: Watchers_Get_MaximumSet.
     * 
     * @param manager Entry point to DatabaseWatcherManager.
     */
    public static void watchersGetMaximumSet(com.azure.resourcemanager.databasewatcher.DatabaseWatcherManager manager) {
        manager.watchers().getByResourceGroupWithResponse("rgWatcher", "myWatcher", 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 watchers_get_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.watchers.get(
        resource_group_name="rgWatcher",
        watcher_name="myWatcher",
    )
    print(response)


# x-ms-original-file: 2025-01-02/Watchers_Get_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/Watchers_Get_MaximumSet_Gen.json
func ExampleWatchersClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatabasewatcher.NewClientFactory("A76F9850-996B-40B3-94D4-C98110A0EEC9", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWatchersClient().Get(ctx, "rgWatcher", "myWatcher", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armdatabasewatcher.WatchersClientGetResponse{
	// 	Watcher: &armdatabasewatcher.Watcher{
	// 		Properties: &armdatabasewatcher.WatcherProperties{
	// 			Status: to.Ptr(armdatabasewatcher.WatcherStatusStarting),
	// 			DefaultAlertRuleIdentityResourceID: to.Ptr("/subscriptions/469DD77C-C8DB-47B7-B9E1-72D29F8C878B/resourceGroups/rgWatcher/providers/Microsoft.ManagedIdentity/userAssignedIdentities/3pmtest"),
	// 			Datastore: &armdatabasewatcher.Datastore{
	// 				AdxClusterResourceID: to.Ptr("/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest/providers/Microsoft.Kusto/clusters/apiTestKusto"),
	// 				KustoClusterURI: to.Ptr("https://kustouri-adx.eastus.kusto.windows.net"),
	// 				KustoClusterDisplayName: to.Ptr("kustoUri-adx"),
	// 				KustoDataIngestionURI: to.Ptr("https://ingest-kustouri-adx.eastus.kusto.windows.net"),
	// 				KustoDatabaseName: to.Ptr("kustoDatabaseName1"),
	// 				KustoManagementURL: to.Ptr("https://portal.azure.com/"),
	// 				KustoOfferingType: to.Ptr(armdatabasewatcher.KustoOfferingTypeAdx),
	// 			},
	// 			ProvisioningState: to.Ptr(armdatabasewatcher.ProvisioningStateSucceeded),
	// 		},
	// 		Identity: &armdatabasewatcher.ManagedServiceIdentityV4{
	// 			UserAssignedIdentities: map[string]*armdatabasewatcher.UserAssignedIdentity{
	// 			},
	// 			PrincipalID: to.Ptr("49e0fbd3-75e8-44e7-96fd-5b64d9ad818d"),
	// 			TenantID: to.Ptr("49e0fbd3-75e8-44e7-96fd-5b64d9ad818d"),
	// 		},
	// 		Tags: map[string]*string{
	// 		},
	// 		Location: to.Ptr("eastus2"),
	// 		ID: to.Ptr("/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/dummyrg/providers/Microsoft.DatabaseWatcher/watchers/myWatcher"),
	// 		Name: to.Ptr("myWatcher"),
	// 		Type: to.Ptr("microsoft.databasewatcher/watchers"),
	// 		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}()),
	// 		},
	// 	},
	// }
}

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 get a Watcher
 *
 * @summary get a Watcher
 * x-ms-original-file: 2025-01-02/Watchers_Get_MaximumSet_Gen.json
 */
async function watchersGetMaximumSet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "A76F9850-996B-40B3-94D4-C98110A0EEC9";
  const client = new DatabaseWatcherClient(credential, subscriptionId);
  const result = await client.watchers.get("rgWatcher", "myWatcher");
  console.log(result);
}

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.Models;
using Azure.ResourceManager.DatabaseWatcher;

// Generated from example definition: 2025-01-02/Watchers_Get_MaximumSet_Gen.json
// this example is just showing the usage of "Watcher_Get" 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 = "A76F9850-996B-40B3-94D4-C98110A0EEC9";
string resourceGroupName = "rgWatcher";
string watcherName = "myWatcher";
ResourceIdentifier databaseWatcherResourceId = DatabaseWatcherResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, watcherName);
DatabaseWatcherResource databaseWatcher = client.GetDatabaseWatcherResource(databaseWatcherResourceId);

// invoke the operation
DatabaseWatcherResource result = await databaseWatcher.GetAsync();

// the variable result 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
DatabaseWatcherData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "properties": {
    "status": "Starting",
    "defaultAlertRuleIdentityResourceId": "/subscriptions/469DD77C-C8DB-47B7-B9E1-72D29F8C878B/resourceGroups/rgWatcher/providers/Microsoft.ManagedIdentity/userAssignedIdentities/3pmtest",
    "datastore": {
      "adxClusterResourceId": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/apiTest/providers/Microsoft.Kusto/clusters/apiTestKusto",
      "kustoClusterUri": "https://kustouri-adx.eastus.kusto.windows.net",
      "kustoClusterDisplayName": "kustoUri-adx",
      "kustoDataIngestionUri": "https://ingest-kustouri-adx.eastus.kusto.windows.net",
      "kustoDatabaseName": "kustoDatabaseName1",
      "kustoManagementUrl": "https://portal.azure.com/",
      "kustoOfferingType": "adx"
    },
    "provisioningState": "Succeeded"
  },
  "identity": {
    "type": "SystemAssignedIdentity",
    "userAssignedIdentities": {},
    "principalId": "49e0fbd3-75e8-44e7-96fd-5b64d9ad818d",
    "tenantId": "49e0fbd3-75e8-44e7-96fd-5b64d9ad818d"
  },
  "tags": {},
  "location": "eastus2",
  "id": "/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/dummyrg/providers/Microsoft.DatabaseWatcher/watchers/myWatcher",
  "name": "myWatcher",
  "type": "microsoft.databasewatcher/watchers",
  "systemData": {
    "createdBy": "enbpvlpqbwd",
    "createdByType": "User",
    "createdAt": "2024-07-25T15:38:47.092Z",
    "lastModifiedBy": "mxp",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-07-25T15:38:47.092Z"
  }
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
DatabaseWatcherProvisioningState	Az erőforráson végrehajtott utolsó kiépítési művelet állapota.
Datastore	Az adattár tulajdonságai.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
KustoOfferingType	A Kusto-ajánlat típusa.
ManagedServiceIdentity	Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)
ManagedServiceIdentityType	A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett).
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UserAssignedIdentity	Felhasználó által hozzárendelt identitástulajdonságok
Watcher	A DatabaseWatcherProviderHub erőforrás.
WatcherStatus	Egy figyelő figyelési gyűjteményének állapota.

createdByType

Enumerálás

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

Érték	Description
Application
Key
ManagedIdentity
User

DatabaseWatcherProvisioningState

Enumerálás

Az erőforráson végrehajtott utolsó kiépítési művelet állapota.

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

Datastore

Objektum

Az adattár tulajdonságai.

Name	Típus	Description
adxClusterResourceId	string (arm-id)	Egy Azure Data Explorer-fürt Azure-erőforrás-azonosítója.
kustoClusterDisplayName	string	A Kusto-fürt megjelenítendő neve.
kustoClusterUri	string	A Kusto-fürt URI-ja.
kustoDataIngestionUri	string	A Kusto-adatbetöltési URI.
kustoDatabaseName	string	Egy Kusto-adatbázis neve.
kustoManagementUrl	string	A Kusto felügyeleti URL-címe.
kustoOfferingType	KustoOfferingType	A Kusto-ajánlat típusa.

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.

KustoOfferingType

Enumerálás

A Kusto-ajánlat típusa.

Érték	Description
adx	Az Azure Data Explorer-fürt Kusto ajánlata.
fabric	A Fabric Real-Time Analytics Kusto ajánlata.
free	Az ingyenes Azure Data Explorer-fürt Kusto-ajánlata.

ManagedServiceIdentity

Objektum

Felügyeltszolgáltatás-identitás (rendszer által hozzárendelt és/vagy felhasználó által hozzárendelt identitások)

Name	Típus	Description
principalId	string (uuid)	A rendszer által hozzárendelt identitás szolgáltatásnév-azonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
tenantId	string (uuid)	A rendszer által hozzárendelt identitás bérlőazonosítója. Ez a tulajdonság csak a rendszer által hozzárendelt identitáshoz lesz megadva.
type	ManagedServiceIdentityType	A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned identitások Az erőforráshoz társított felhasználó által hozzárendelt identitások készlete. A userAssignedIdentities szótárkulcsok arm-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. A szótár értékei lehetnek üres objektumok ({}) a kérelmekben.

ManagedServiceIdentityType

Enumerálás

A felügyelt szolgáltatás identitásának típusa (ahol a SystemAssigned és a UserAssigned típus is engedélyezett).

Érték	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

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.

UserAssignedIdentity

Objektum

Felhasználó által hozzárendelt identitástulajdonságok

Name	Típus	Description
clientId	string (uuid)	A hozzárendelt identitás ügyfélazonosítója.
principalId	string (uuid)	A hozzárendelt identitás egyszerű azonosítója.

Watcher

Objektum

A DatabaseWatcherProviderHub erőforrás.

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}"
identity	ManagedServiceIdentity	Az erőforráshoz rendelt felügyeltszolgáltatás-identitások.
location	string	Az a földrajzi hely, ahol az erőforrás él
name	string	Az erőforrás neve
properties.datastore	Datastore	Az összegyűjtött figyelési adatok adattára.
properties.defaultAlertRuleIdentityResourceId	string (arm-id)	Egy felhasználó által hozzárendelt felügyelt identitás erőforrás-azonosítója, amely egy új riasztási szabályhoz lesz hozzárendelve.
properties.provisioningState	DatabaseWatcherProvisioningState	Az erőforrás-figyelő kiépítési állapota.
properties.status	WatcherStatus	A figyelő figyelési gyűjteményének állapota.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
tags	object	Erőforráscímkék.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

WatcherStatus

Enumerálás

Egy figyelő figyelési gyűjteményének állapota.

Érték	Description
Deleting	Azt jelzi, hogy a figyelő törlési állapotban van.
Running	Azt jelzi, hogy a figyelő futó állapotban van.
Starting	Azt jelzi, hogy a figyelő kezdő állapotban van.
Stopped	Azt jelzi, hogy a figyelő leállt állapotban van.
Stopping	Azt jelzi, hogy a figyelő leállási állapotban van.