Watchers - Stop

服务:

Database Watcher

API 版本:

2025-01-02

停止监视为数据库观察程序配置的所有目标的操作。

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

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 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	Watcher	Azure 操作已成功完成。
202 Accepted		已接受资源操作。 标头 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Watchers_Stop_MaximumSet

示例请求

HTTP

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

Java

/**
 * Samples for Watchers Stop.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-02/Watchers_Stop_MaximumSet_Gen.json
     */
    /**
     * Sample code: Watchers_Stop_MaximumSet.
     * 
     * @param manager Entry point to DatabaseWatcherManager.
     */
    public static void
        watchersStopMaximumSet(com.azure.resourcemanager.databasewatcher.DatabaseWatcherManager manager) {
        manager.watchers().stop("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_stop_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",
    )

    client.watchers.begin_stop(
        resource_group_name="rgWatcher",
        watcher_name="myWatcher",
    ).result()


# x-ms-original-file: 2025-01-02/Watchers_Stop_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_Stop_MaximumSet_Gen.json
func ExampleWatchersClient_BeginStop() {
	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)
	}
	poller, err := clientFactory.NewWatchersClient().BeginStop(ctx, "rgWatcher", "myWatcher", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.WatchersClientStopResponse{
	// }
}

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 the action to stop monitoring all targets configured for a database watcher.
 *
 * @summary the action to stop monitoring all targets configured for a database watcher.
 * x-ms-original-file: 2025-01-02/Watchers_Stop_MaximumSet_Gen.json
 */
async function watchersStopMaximumSet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "A76F9850-996B-40B3-94D4-C98110A0EEC9";
  const client = new DatabaseWatcherClient(credential, subscriptionId);
  await client.watchers.stop("rgWatcher", "myWatcher");
}

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_Stop_MaximumSet_Gen.json
// this example is just showing the usage of "Watchers_Stop" 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
await databaseWatcher.StopAsync(WaitUntil.Completed);

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

{
  "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": "SystemAssigned",
    "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"
  }
}

状态代码:

202

Azure-AsyncOperation: https://contoso.com/operationstatus

定义

名称	说明
createdByType	创建资源的标识的类型。
DatabaseWatcherProvisioningState	上次对资源执行的预配操作的状态。
Datastore	数据存储的属性。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
KustoOfferingType	Kusto 产品/服务的类型。
ManagedServiceIdentity	托管服务标识（系统分配和/或用户分配的标识）
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
systemData	与创建和上次修改资源相关的元数据。
UserAssignedIdentity	用户分配的标识属性
Watcher	DatabaseWatcherProviderHub 资源。
WatcherStatus	观察程序的监视集合状态。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DatabaseWatcherProvisioningState

枚举

上次对资源执行的预配操作的状态。

值	说明
Succeeded	已创建资源。
Failed	资源创建失败。
Canceled	资源创建已取消。

Datastore

Object

数据存储的属性。

名称	类型	说明
adxClusterResourceId	string (arm-id)	Azure 数据资源管理器群集的 Azure 资源 ID。
kustoClusterDisplayName	string	Kusto 群集显示名称。
kustoClusterUri	string	Kusto 群集 URI。
kustoDataIngestionUri	string	Kusto 数据引入 URI。
kustoDatabaseName	string	Kusto 数据库的名称。
kustoManagementUrl	string	Kusto 管理 URL。
kustoOfferingType	KustoOfferingType	Kusto 产品/服务的类型。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

KustoOfferingType

枚举

Kusto 产品/服务的类型。

值	说明
adx	Azure 数据资源管理器群集 Kusto 产品/服务。
free	免费的 Azure 数据资源管理器群集 Kusto 产品/服务。
fabric	Fabric Real-Time Analytics Kusto 产品/服务。

ManagedServiceIdentity

Object

托管服务标识（系统分配和/或用户分配的标识）

名称	类型	说明
principalId	string (uuid)	系统分配标识的服务主体 ID。 此属性仅针对系统分配的标识提供。
tenantId	string (uuid)	系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。
type	ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned 标识 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。

ManagedServiceIdentityType

枚举

托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。

值	说明
None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserAssignedIdentity

Object

用户分配的标识属性

名称	类型	说明
clientId	string (uuid)	分配的标识的客户端 ID。
principalId	string (uuid)	已分配标识的主体 ID。

Watcher

Object

DatabaseWatcherProviderHub 资源。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
identity	ManagedServiceIdentity	分配给此资源的托管服务标识。
location	string	资源所在的地理位置
name	string	资源的名称
properties.datastore	Datastore	用于收集监视数据的数据存储。
properties.defaultAlertRuleIdentityResourceId	string (arm-id)	将分配给新警报规则的用户分配托管标识的资源 ID。
properties.provisioningState	DatabaseWatcherProvisioningState	资源观察程序的预配状态。
properties.status	WatcherStatus	观察程序的监视集合状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

WatcherStatus

枚举

观察程序的监视集合状态。

值	说明
Starting	表示观察程序处于起始状态。
Running	表示观察程序处于运行状态。
Stopping	表示观察程序处于停止状态。
Stopped	表示观察程序处于停止状态。
Deleting	表示观察程序处于删除状态。