Diagnostic Settings - Create Or Update
建立或更新指定資源的診斷設定。
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2021-05-01-preview
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
name
|
path | True |
string |
診斷設定的名稱。 |
resource
|
path | True |
string |
資源的標識碼。 |
api-version
|
query | True |
string |
用於此作業的 API 版本。 |
要求本文
名稱 | 類型 | Description |
---|---|---|
properties.eventHubAuthorizationRuleId |
string |
事件中樞授權規則的資源標識碼。 |
properties.eventHubName |
string |
事件中樞的名稱。 如果未指定任何專案,則會選取預設事件中樞。 |
properties.logAnalyticsDestinationType |
string |
字串,指出導出至 Log Analytics 是否應該使用預設目的地類型,亦即 AzureDiagnostics,或使用建構如下的目的地類型: _。 可能的值為:Dedicated 和 null (null 是 default。) |
properties.logs |
記錄設定的清單。 |
|
properties.marketplacePartnerId |
string |
您要傳送診斷記錄之 Marketplace 資源的完整 ARM 資源識別碼。 |
properties.metrics |
計量設定的清單。 |
|
properties.serviceBusRuleId |
string |
診斷設定的服務總線規則標識碼。 這是為了維持回溯相容性。 |
properties.storageAccountId |
string |
您要傳送診斷記錄的記憶體帳戶資源識別碼。 |
properties.workspaceId |
string |
要傳送診斷記錄之Log Analytics工作區的完整ARM資源識別碼。 範例:/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
成功要求以建立診斷設定 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
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"
}
}
定義
名稱 | Description |
---|---|
created |
建立資源的身分識別類型。 |
Diagnostic |
診斷設定資源。 |
Error |
描述錯誤回應的格式。 |
Log |
MultiTenantDiagnosticSettings 的一部分。 指定特定記錄檔的設定。 |
Metric |
MultiTenantDiagnosticSettings 的一部分。 指定特定計量的設定。 |
Retention |
指定記錄的保留原則。 |
system |
與建立和上次修改資源相關的元數據。 |
createdByType
建立資源的身分識別類型。
名稱 | 類型 | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
DiagnosticSettingsResource
診斷設定資源。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源的完整資源識別碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
資源的名稱 |
properties.eventHubAuthorizationRuleId |
string |
事件中樞授權規則的資源標識碼。 |
properties.eventHubName |
string |
事件中樞的名稱。 如果未指定任何專案,則會選取預設事件中樞。 |
properties.logAnalyticsDestinationType |
string |
字串,指出導出至 Log Analytics 是否應該使用預設目的地類型,亦即 AzureDiagnostics,或使用建構如下的目的地類型: _。 可能的值為:Dedicated 和 null (null 是 default。) |
properties.logs |
記錄設定的清單。 |
|
properties.marketplacePartnerId |
string |
您要傳送診斷記錄之 Marketplace 資源的完整 ARM 資源識別碼。 |
properties.metrics |
計量設定的清單。 |
|
properties.serviceBusRuleId |
string |
診斷設定的服務總線規則標識碼。 這是為了維持回溯相容性。 |
properties.storageAccountId |
string |
您要傳送診斷記錄的記憶體帳戶資源識別碼。 |
properties.workspaceId |
string |
要傳送診斷記錄之Log Analytics工作區的完整ARM資源識別碼。 範例:/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2 |
systemData |
與這個資源相關的系統元數據。 |
|
type |
string |
資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” |
ErrorResponse
描述錯誤回應的格式。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤碼 |
message |
string |
錯誤訊息,指出作業失敗的原因。 |
LogSettings
MultiTenantDiagnosticSettings 的一部分。 指定特定記錄檔的設定。
名稱 | 類型 | Description |
---|---|---|
category |
string |
套用此設定的資源類型診斷記錄類別名稱。 若要取得資源之診斷記錄類別的清單,請先執行 GET 診斷設定作業。 |
categoryGroup |
string |
套用此設定的資源類型診斷記錄類別群組名稱。 若要取得資源之診斷記錄類別的清單,請先執行 GET 診斷設定作業。 |
enabled |
boolean |
值,指出是否啟用此記錄檔。 |
retentionPolicy |
此記錄檔的保留原則。 |
MetricSettings
MultiTenantDiagnosticSettings 的一部分。 指定特定計量的設定。
名稱 | 類型 | Description |
---|---|---|
category |
string |
套用此設定的資源類型診斷計量類別名稱。 若要取得資源的診斷計量類別清單,請先執行 GET 診斷設定作業。 |
enabled |
boolean |
值,指出是否啟用此類別。 |
retentionPolicy |
此類別的保留原則。 |
|
timeGrain |
string |
格式ISO8601計量的timegrain。 |
RetentionPolicy
指定記錄的保留原則。
名稱 | 類型 | Description |
---|---|---|
days |
integer |
保留天數的天數。 值為 0 會無限期地保留事件。 |
enabled |
boolean |
值,指出是否啟用保留原則。 |
systemData
與建立和上次修改資源相關的元數據。
名稱 | 類型 | Description |
---|---|---|
createdAt |
string |
資源建立的時間戳 (UTC) 。 |
createdBy |
string |
建立資源的身分識別。 |
createdByType |
建立資源的身分識別類型。 |
|
lastModifiedAt |
string |
上次修改的資源時間戳 (UTC) |
lastModifiedBy |
string |
上次修改資源的身分識別。 |
lastModifiedByType |
上次修改資源的身分識別類型。 |