你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Watchers - Create Or Update

参考

服务:: Database Watcher

API 版本:: 2024-10-01-preview

创建观察程序

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DatabaseWatcher/watchers/{watcherName}?api-version=2024-10-01-preview

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string	资源组的名称。名称不区分大小写。
subscriptionId	path	True	string uuid	目标订阅的 ID。该值必须是 UUID。
watcherName	path	True	string	数据库观察程序名称。正则表达式模式: `^[a-zA-Z0-9]{1}[a-zA-Z0-9-_]{3,60}$`
api-version	query	True	string	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
location	True	string	资源所在的地理位置
identity		ManagedServiceIdentity	分配给此资源的托管服务标识。
properties.datastore		Datastore	用于收集监视数据的数据存储。
properties.defaultAlertRuleIdentityResourceId		string	将分配给新警报规则的用户分配托管标识的资源 ID。
tags		object	资源标记。

响应

名称	类型	说明
200 OK	Watcher	资源“观察程序”更新操作成功
201 Created	Watcher	资源“观察程序”创建操作成功标头 Retry-After: integer
Other Status Codes	ErrorResponse	意外的错误响应。

名称

类型

说明

200 OK

Watcher

资源“观察程序”更新操作成功

201 Created

Watcher

资源“观察程序”创建操作成功

标头

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_CreateOrUpdate - generated by [MaximumSet] rule

示例请求

HTTP

PUT https://management.azure.com/subscriptions/49e0fbd3-75e8-44e7-96fd-5b64d9ad818d/resourceGroups/rgWatcher/providers/Microsoft.DatabaseWatcher/watchers/testWatcher?api-version=2024-10-01-preview

{
  "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"
    }
  },
  "identity": {
    "type": "SystemAssigned"
  },
  "tags": {},
  "location": "eastus2euap"
}

示例响应

状态代码:: 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": "eastus2euap",
  "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"
  }
}

状态代码:: 201

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

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

定义

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

createdByType

创建资源的标识的类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DatabaseWatcherProvisioningState

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

名称	类型	说明
Canceled	string	资源创建已取消。
Failed	string	资源创建失败。
Succeeded	string	已创建资源。

Datastore

数据存储的属性。

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

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

KustoOfferingType

Kusto 产品/服务的类型。

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

ManagedServiceIdentity

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

名称	类型	说明
principalId	string	系统分配标识的服务主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string	系统分配标识的租户 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	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

systemData

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

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

UserAssignedIdentity

用户分配的标识属性

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

Watcher

DatabaseWatcherProviderHub 资源。

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

WatcherStatus

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

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

通过

Watchers - Create Or Update

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Watchers_CreateOrUpdate - generated by [MaximumSet] rule

示例请求

示例响应

定义

createdByType

DatabaseWatcherProvisioningState

Datastore

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KustoOfferingType

ManagedServiceIdentity

ManagedServiceIdentityType

systemData

UserAssignedIdentity

Watcher

WatcherStatus

其他资源