Diagnostic Settings - Create Or Update

  • Referenz
Service:
Monitor
API Version:
2021-05-01-preview

Erstellt oder aktualisiert Diagnoseeinstellungen für die angegebene Ressource.

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2021-05-01-preview

URI-Parameter

Name In Erforderlich Typ Beschreibung
name
 path True

string

Der Name der Diagnoseeinstellung.
resourceUri
 path True

string

Der Bezeichner der Ressource.
api-version
 query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Typ Beschreibung
properties.eventHubAuthorizationRuleId

string

Die Ressourcen-ID für die Event Hub-Autorisierungsregel.
properties.eventHubName

string

Der Name des Event Hubs. Wenn keine angegeben ist, wird der Standard-Event Hub ausgewählt.
properties.logAnalyticsDestinationType

string

Eine Zeichenfolge, die angibt, ob der Export nach Log Analytics den Standardzieltyp verwenden soll, d. h. AzureDiagnostics, oder einen wie folgt erstellten Zieltyp verwenden soll: _. Mögliche Werte sind: Dedicated und NULL (NULL ist Standardwert.)
properties.logs

LogSettings[]

Die Liste der Protokolleinstellungen.
properties.marketplacePartnerId

string

Die vollständige ARM-Ressourcen-ID der Marketplace-Ressource, an die Sie Diagnoseprotokolle senden möchten.
properties.metrics

MetricSettings[]

Die Liste der Metrikeinstellungen.
properties.serviceBusRuleId

string

Die Service Bus-Regel-ID der Diagnoseeinstellung. Dies ist hier, um die Abwärtskompatibilität zu gewährleisten.
properties.storageAccountId

string

Die Ressourcen-ID des Speicherkontos, an das Sie Diagnoseprotokolle senden möchten.
properties.workspaceId

string

Die vollständige ARM-Ressourcen-ID des Log Analytics-Arbeitsbereichs, an den Sie Diagnoseprotokolle senden möchten. Beispiel: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

Antworten

Name Typ Beschreibung
200 OK

DiagnosticSettingsResource

Erfolgreiche Anforderung zum Erstellen einer Diagnoseeinstellung
Other Status Codes

ErrorResponse

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Creates or Updates the diagnostic setting
Creates or Updates the diagnostic setting for category

Creates or Updates the diagnostic setting

Sample Request

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

Sample Response

Status code:
200 
{
  "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

Sample Request

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

Sample Response

Status code:
200 
{
  "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"
  }
}

Definitionen

Name Beschreibung
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
DiagnosticSettingsResource

Die Diagnoseeinstellungsressource.
ErrorResponse

Beschreibt das Format der Fehlerantwort.
LogSettings

Teil von MultiTenantDiagnosticSettings. Gibt die Einstellungen für ein bestimmtes Protokoll an.
MetricSettings

Teil von MultiTenantDiagnosticSettings. Gibt die Einstellungen für eine bestimmte Metrik an.
RetentionPolicy

Gibt die Aufbewahrungsrichtlinie für das Protokoll an.
systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

DiagnosticSettingsResource

Die Diagnoseeinstellungsressource.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Der Name der Ressource
properties.eventHubAuthorizationRuleId

string

Die Ressourcen-ID für die Event Hub-Autorisierungsregel.
properties.eventHubName

string

Der Name des Event Hubs. Wenn keine angegeben ist, wird der Standard-Event Hub ausgewählt.
properties.logAnalyticsDestinationType

string

Eine Zeichenfolge, die angibt, ob der Export nach Log Analytics den Standardzieltyp verwenden soll, d. h. AzureDiagnostics, oder einen wie folgt erstellten Zieltyp verwenden soll: _. Mögliche Werte sind: Dedicated und NULL (NULL ist Standardwert.)
properties.logs

LogSettings[]

Die Liste der Protokolleinstellungen.
properties.marketplacePartnerId

string

Die vollständige ARM-Ressourcen-ID der Marketplace-Ressource, an die Sie Diagnoseprotokolle senden möchten.
properties.metrics

MetricSettings[]

Die Liste der Metrikeinstellungen.
properties.serviceBusRuleId

string

Die Service Bus-Regel-ID der Diagnoseeinstellung. Dies ist hier, um die Abwärtskompatibilität zu gewährleisten.
properties.storageAccountId

string

Die Ressourcen-ID des Speicherkontos, an das Sie Diagnoseprotokolle senden möchten.
properties.workspaceId

string

Die vollständige ARM-Ressourcen-ID des Log Analytics-Arbeitsbereichs, an den Sie Diagnoseprotokolle senden möchten. Beispiel: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2
systemData

systemData

Die Systemmetadaten im Zusammenhang mit dieser Ressource.
type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ErrorResponse

Beschreibt das Format der Fehlerantwort.

Name Typ Beschreibung
code

string

Fehlercode
message

string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

LogSettings

Teil von MultiTenantDiagnosticSettings. Gibt die Einstellungen für ein bestimmtes Protokoll an.

Name Typ Beschreibung
category

string

Name einer Diagnoseprotokollkategorie für einen Ressourcentyp, auf den diese Einstellung angewendet wird. Um die Liste der Diagnoseprotokollkategorien für eine Ressource zu erhalten, führen Sie zuerst einen GET-Vorgang zum Abrufen von Diagnoseeinstellungen aus.
categoryGroup

string

Name einer Kategoriegruppe des Diagnoseprotokolls für einen Ressourcentyp, auf den diese Einstellung angewendet wird. Um die Liste der Diagnoseprotokollkategorien für eine Ressource zu erhalten, führen Sie zuerst einen GET-Vorgang zum Abrufen von Diagnoseeinstellungen aus.
enabled

boolean

ein Wert, der angibt, ob dieses Protokoll aktiviert ist.
retentionPolicy

RetentionPolicy

die Aufbewahrungsrichtlinie für dieses Protokoll.

MetricSettings

Teil von MultiTenantDiagnosticSettings. Gibt die Einstellungen für eine bestimmte Metrik an.

Name Typ Beschreibung
category

string

Name einer Diagnosemetrikkategorie für einen Ressourcentyp, auf den diese Einstellung angewendet wird. Um die Liste der Diagnosemetrikkategorien für eine Ressource abzurufen, führen Sie zuerst einen GET-Diagnoseeinstellungenvorgang aus.
enabled

boolean

ein Wert, der angibt, ob diese Kategorie aktiviert ist.
retentionPolicy

RetentionPolicy

die Aufbewahrungsrichtlinie für diese Kategorie.
timeGrain

string

das Zeitgrain der Metrik im ISO8601 Format.

RetentionPolicy

Gibt die Aufbewahrungsrichtlinie für das Protokoll an.

Name Typ Beschreibung
days

integer

die Anzahl der Tage für die Aufbewahrung in Tagen. Der Wert 0 behält die Ereignisse auf unbestimmte Zeit bei.
enabled

boolean

ein Wert, der angibt, ob die Aufbewahrungsrichtlinie aktiviert ist.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.