Diagnostic Settings - Create Or Update
为指定资源创建或更新诊断设置。
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2021-05-01-preview
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
name
|
path | True |
string |
诊断设置的名称。 |
|
resource
|
path | True |
string |
资源的标识符。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此作的 API 版本。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| properties.eventHubAuthorizationRuleId |
string |
事件中心授权规则的资源 ID。 |
| properties.eventHubName |
string |
事件中心的名称。 如果未指定任何事件,则会选择默认事件中心。 |
| properties.logAnalyticsDestinationType |
string |
一个字符串,指示导出到 Log Analytics 是否应使用默认目标类型,即 AzureDiagnostics,或使用构造为如下的目标类型: <规范化服务 identity>_<normalized 类别名称>。 可能的值为:专用值和 null(默认值为 null)。 |
| properties.logs |
日志设置的列表。 |
|
| properties.marketplacePartnerId |
string |
要向其发送诊断日志的市场资源的完整 ARM 资源 ID。 |
| properties.metrics |
指标设置列表。 |
|
| properties.serviceBusRuleId |
string |
诊断设置的服务总线规则 ID。 这是为了保持向后兼容性。 |
| properties.storageAccountId |
string |
要向其发送诊断日志的存储帐户的资源 ID。 |
| properties.workspaceId |
string |
要向其发送诊断日志的 Log Analytics 工作区的完整 ARM 资源 ID。 示例:/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功创建诊断设置的请求 |
|
| Other Status Codes |
描述操作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
| Creates or Updates the diagnostic setting |
| Creates or Updates the diagnostic setting for category |
Creates or Updates the diagnostic setting
示例请求
PUT https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview
{
"properties": {
"storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
"workspaceId": "",
"eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
"eventHubName": "myeventhub",
"marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
"metrics": [
{
"category": "WorkflowMetrics",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
],
"logs": [
{
"categoryGroup": "allLogs",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
],
"logAnalyticsDestinationType": "Dedicated"
}
}
示例响应
{
"id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/microsoft.insights/diagnosticSettings/mysetting",
"type": "Microsoft.Insights/diagnosticSettings",
"name": "mysetting",
"properties": {
"storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
"workspaceId": "",
"eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
"eventHubName": "myeventhub",
"marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
"metrics": [
{
"category": "WorkflowMetrics",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
],
"logs": [
{
"categoryGroup": "allLogs",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
],
"logAnalyticsDestinationType": "Dedicated"
}
}
Creates or Updates the diagnostic setting for category
示例请求
PUT https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview
{
"properties": {
"storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
"workspaceId": "",
"eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
"eventHubName": "myeventhub",
"marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
"metrics": [
{
"category": "WorkflowMetrics",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
],
"logs": [
{
"category": "WorkflowRuntime",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
],
"logAnalyticsDestinationType": "Dedicated"
}
}
示例响应
{
"id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting",
"type": "",
"name": "mysetting",
"properties": {
"storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
"workspaceId": "",
"eventHubAuthorizationRuleId": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
"eventHubName": "myeventhub",
"marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
"metrics": [
{
"category": "WorkflowMetrics",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
],
"logs": [
{
"category": "WorkflowRuntime",
"enabled": true,
"retentionPolicy": {
"enabled": false,
"days": 0
}
}
],
"logAnalyticsDestinationType": "Dedicated"
}
}
定义
| 名称 | 说明 |
|---|---|
|
created |
创建资源的标识的类型。 |
|
Diagnostic |
诊断设置资源。 |
|
Error |
描述错误响应的格式。 |
|
Log |
MultiTenantDiagnosticSettings 的一部分。 指定特定日志的设置。 |
|
Metric |
MultiTenantDiagnosticSettings 的一部分。 指定特定指标的设置。 |
|
Retention |
指定日志的保留策略。 |
|
system |
与创建和上次修改资源相关的元数据。 |
createdByType
创建资源的标识的类型。
| 值 | 说明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiagnosticSettingsResource
诊断设置资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
资源的名称 |
| properties.eventHubAuthorizationRuleId |
string |
事件中心授权规则的资源 ID。 |
| properties.eventHubName |
string |
事件中心的名称。 如果未指定任何事件,则会选择默认事件中心。 |
| properties.logAnalyticsDestinationType |
string |
一个字符串,指示导出到 Log Analytics 是否应使用默认目标类型,即 AzureDiagnostics,或使用构造为如下的目标类型: <规范化服务 identity>_<normalized 类别名称>。 可能的值为:专用值和 null(默认值为 null)。 |
| properties.logs |
日志设置的列表。 |
|
| properties.marketplacePartnerId |
string |
要向其发送诊断日志的市场资源的完整 ARM 资源 ID。 |
| properties.metrics |
指标设置列表。 |
|
| properties.serviceBusRuleId |
string |
诊断设置的服务总线规则 ID。 这是为了保持向后兼容性。 |
| properties.storageAccountId |
string |
要向其发送诊断日志的存储帐户的资源 ID。 |
| properties.workspaceId |
string |
要向其发送诊断日志的 Log Analytics 工作区的完整 ARM 资源 ID。 示例:/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
| systemData |
与此资源相关的系统元数据。 |
|
| type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
ErrorResponse
描述错误响应的格式。
| 名称 | 类型 | 说明 |
|---|---|---|
| code |
string |
错误代码 |
| message |
string |
指示操作失败的原因的错误消息。 |
LogSettings
MultiTenantDiagnosticSettings 的一部分。 指定特定日志的设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| category |
string |
此设置应用于的资源类型的诊断日志类别的名称。 若要获取资源的诊断日志类别列表,请先执行 GET 诊断设置作。 |
| categoryGroup |
string |
此设置应用于的资源类型的诊断日志类别组的名称。 若要获取资源的诊断日志类别列表,请先执行 GET 诊断设置作。 |
| enabled |
boolean |
一个值,该值指示是否启用此日志。 |
| retentionPolicy |
此日志的保留策略。 |
MetricSettings
MultiTenantDiagnosticSettings 的一部分。 指定特定指标的设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| category |
string |
此设置应用于的资源类型的诊断指标类别的名称。 若要获取资源的诊断指标类别列表,请先执行 GET 诊断设置作。 |
| enabled |
boolean |
一个值,该值指示是否启用此类别。 |
| retentionPolicy |
此类别的保留策略。 |
|
| timeGrain |
string (duration) |
ISO8601格式的指标的时间根。 |
RetentionPolicy
指定日志的保留策略。
| 名称 | 类型 | 说明 |
|---|---|---|
| days |
integer (int32) minimum: 0 |
保留天数(以天为单位)。 值为 0 将无限期保留事件。 |
| enabled |
boolean |
一个值,该值指示是否启用保留策略。 |
systemData
与创建和上次修改资源相关的元数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
| createdBy |
string |
创建资源的标识。 |
| createdByType |
创建资源的标识的类型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
| lastModifiedBy |
string |
上次修改资源的标识。 |
| lastModifiedByType |
上次修改资源的标识的类型。 |