Watchers - Get

Servicio:

Database Watcher

Versión de la API:

2025-01-02

Obtener un monitor

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
watcherName	path	True	string pattern: ^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$	Nombre del monitor de base de datos.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	Watcher	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Watchers_Get_MaximumSet

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
DatabaseWatcherProvisioningState	Estado de la última operación de aprovisionamiento realizada en el recurso.
Datastore	Propiedades de un almacén de datos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
KustoOfferingType	Tipo de oferta de Kusto.
ManagedServiceIdentity	Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)
ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
systemData	Metadatos relativos a la creación y última modificación del recurso.
UserAssignedIdentity	Propiedades de identidad asignadas por el usuario
Watcher	El recurso DatabaseWatcherProviderHub.
WatcherStatus	Estado de la colección de supervisión de un monitor.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DatabaseWatcherProvisioningState

Enumeración

Estado de la última operación de aprovisionamiento realizada en el recurso.

Valor	Description
Canceled	Se canceló la creación de recursos.
Failed	Error en la creación de recursos.
Succeeded	Se ha creado el recurso.

Datastore

Object

Propiedades de un almacén de datos.

Nombre	Tipo	Description
adxClusterResourceId	string (arm-id)	Identificador de recurso de Azure de un clúster de Azure Data Explorer.
kustoClusterDisplayName	string	Nombre para mostrar del clúster de Kusto.
kustoClusterUri	string	Identificador URI del clúster de Kusto.
kustoDataIngestionUri	string	Identificador URI de ingesta de datos de Kusto.
kustoDatabaseName	string	Nombre de una base de datos de Kusto.
kustoManagementUrl	string	Dirección URL de administración de Kusto.
kustoOfferingType	KustoOfferingType	Tipo de una oferta de Kusto.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

KustoOfferingType

Enumeración

Tipo de oferta de Kusto.

Valor	Description
adx	Oferta de Kusto del clúster de Azure Data Explorer.
fabric	Oferta de Kusto de Fabric Real-Time Analytics.
free	La oferta gratuita de Kusto del clúster de Azure Data Explorer.

ManagedServiceIdentity

Object

Identidad de servicio administrada (identidades asignadas por el sistema o asignadas por el usuario)

Nombre	Tipo	Description
principalId	string (uuid)	Identificador de entidad de servicio de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
tenantId	string (uuid)	Identificador de inquilino de la identidad asignada por el sistema. Esta propiedad solo se proporcionará para una identidad asignada por el sistema.
type	ManagedServiceIdentityType	Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).
userAssignedIdentities	<string,  UserAssignedIdentity>	identidades de User-Assigned Conjunto de identidades asignadas por el usuario asociadas al recurso. Las claves de diccionario userAssignedIdentities serán identificadores de recursos de ARM con el formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Los valores del diccionario pueden ser objetos vacíos ({}) en las solicitudes.

ManagedServiceIdentityType

Enumeración

Tipo de identidad de servicio administrada (donde se permiten los tipos SystemAssigned y UserAssigned).

Valor	Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UserAssignedIdentity

Object

Propiedades de identidad asignadas por el usuario

Nombre	Tipo	Description
clientId	string (uuid)	Identificador de cliente de la identidad asignada.
principalId	string (uuid)	Identificador de entidad de seguridad de la identidad asignada.

Watcher

Object

El recurso DatabaseWatcherProviderHub.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Identidades de servicio administradas asignadas a este recurso.
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso
properties.datastore	Datastore	Almacén de datos para los datos de supervisión recopilados.
properties.defaultAlertRuleIdentityResourceId	string (arm-id)	Identificador de recurso de una identidad administrada asignada por el usuario que se asignará a una nueva regla de alertas.
properties.provisioningState	DatabaseWatcherProvisioningState	Estado de aprovisionamiento del monitor de recursos.
properties.status	WatcherStatus	Estado de la recopilación de supervisión del monitor.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
tags	object	Etiquetas de recursos.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WatcherStatus

Enumeración

Estado de la colección de supervisión de un monitor.

Valor	Description
Deleting	Indica que el monitor está en un estado de eliminación.
Running	Indica que el monitor está en un estado en ejecución.
Starting	Indica que el monitor está en un estado inicial.
Stopped	Indica que el monitor está en estado detenido.
Stopping	Indica que el monitor está en un estado de detención.