Diagnostic Settings - Create Or Update

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

Hiermee worden diagnostische instellingen voor de opgegeven resource gemaakt of bijgewerkt.

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

URI-parameters

Name In Vereist Type Description
name
 path True

string

De naam van de diagnostische instelling.
resourceUri
 path True

string

De id van de resource.
api-version
 query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Type Description
properties.eventHubAuthorizationRuleId

string

De resource-id voor de autorisatieregel voor de Event Hub.
properties.eventHubName

string

De naam van de event hub. Als er geen is opgegeven, wordt de standaard Event Hub geselecteerd.
properties.logAnalyticsDestinationType

string

Een tekenreeks die aangeeft of de export naar Log Analytics het standaarddoeltype moet gebruiken, dat wil weten AzureDiagnostics, of een doeltype moet gebruiken dat als volgt is samengesteld: _. Mogelijke waarden zijn: Dedicated en null (null is standaard).)
properties.logs

LogSettings[]

De lijst met logboekinstellingen.
properties.marketplacePartnerId

string

De volledige ARM-resource-id van de Marketplace-resource waarnaar u diagnostische logboeken wilt verzenden.
properties.metrics

MetricSettings[]

De lijst met metrische instellingen.
properties.serviceBusRuleId

string

De service bus-regel-id van de diagnostische instelling. Dit is bedoeld om compatibiliteit met eerdere versies te behouden.
properties.storageAccountId

string

De resource-id van het opslagaccount waarnaar u diagnostische logboeken wilt verzenden.
properties.workspaceId

string

De volledige ARM-resource-id van de Log Analytics-werkruimte waarnaar u diagnostische logboeken wilt verzenden. Voorbeeld: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

Antwoorden

Name Type Description
200 OK

DiagnosticSettingsResource

Geslaagde aanvraag voor het maken van een diagnostische instelling
Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name Description
createdByType

Het type identiteit waarmee de resource is gemaakt.
DiagnosticSettingsResource

De resource voor diagnostische instellingen.
ErrorResponse

Beschrijft de indeling van foutantwoord.
LogSettings

Onderdeel van MultiTenantDiagnosticSettings. Hiermee geeft u de instellingen voor een bepaald logboek.
MetricSettings

Onderdeel van MultiTenantDiagnosticSettings. Hiermee geeft u de instellingen voor een bepaalde metrische waarde.
RetentionPolicy

Hiermee geeft u het bewaarbeleid voor het logboek op.
systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

DiagnosticSettingsResource

De resource voor diagnostische instellingen.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

De naam van de resource
properties.eventHubAuthorizationRuleId

string

De resource-id voor de autorisatieregel voor de Event Hub.
properties.eventHubName

string

De naam van de event hub. Als er geen is opgegeven, wordt de standaard Event Hub geselecteerd.
properties.logAnalyticsDestinationType

string

Een tekenreeks die aangeeft of de export naar Log Analytics het standaarddoeltype moet gebruiken, dat wil weten AzureDiagnostics, of een doeltype moet gebruiken dat als volgt is samengesteld: _. Mogelijke waarden zijn: Dedicated en null (null is standaard).)
properties.logs

LogSettings[]

De lijst met logboekinstellingen.
properties.marketplacePartnerId

string

De volledige ARM-resource-id van de Marketplace-resource waarnaar u diagnostische logboeken wilt verzenden.
properties.metrics

MetricSettings[]

De lijst met metrische instellingen.
properties.serviceBusRuleId

string

De service bus-regel-id van de diagnostische instelling. Dit is bedoeld om compatibiliteit met eerdere versies te behouden.
properties.storageAccountId

string

De resource-id van het opslagaccount waarnaar u diagnostische logboeken wilt verzenden.
properties.workspaceId

string

De volledige ARM-resource-id van de Log Analytics-werkruimte waarnaar u diagnostische logboeken wilt verzenden. Voorbeeld: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2
systemData

systemData

De systeemmetagegevens met betrekking tot deze resource.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ErrorResponse

Beschrijft de indeling van foutantwoord.

Name Type Description
code

string

Foutcode
message

string

Foutbericht waarin wordt aangegeven waarom de bewerking is mislukt.

LogSettings

Onderdeel van MultiTenantDiagnosticSettings. Hiermee geeft u de instellingen voor een bepaald logboek.

Name Type Description
category

string

Naam van een categorie diagnostisch logboek voor een resourcetype waar deze instelling op wordt toegepast. Als u de lijst met diagnostische logboekcategorieën voor een resource wilt ophalen, moet u eerst een bewerking voor diagnostische instellingen voor GET uitvoeren.
categoryGroup

string

Naam van een categoriegroep voor diagnostisch logboek voor een resourcetype waar deze instelling op wordt toegepast. Als u de lijst met diagnostische logboekcategorieën voor een resource wilt ophalen, moet u eerst een bewerking voor diagnostische instellingen voor GET uitvoeren.
enabled

boolean

een waarde die aangeeft of dit logboek is ingeschakeld.
retentionPolicy

RetentionPolicy

het bewaarbeleid voor dit logboek.

MetricSettings

Onderdeel van MultiTenantDiagnosticSettings. Hiermee geeft u de instellingen voor een bepaalde metrische waarde.

Name Type Description
category

string

De naam van een categorie diagnostische metrische gegevens voor een resourcetype waar deze instelling op wordt toegepast. Als u de lijst met diagnostische metrische categorieën voor een resource wilt ophalen, voert u eerst een bewerking voor diagnostische instellingen voor GET uit.
enabled

boolean

een waarde die aangeeft of deze categorie is ingeschakeld.
retentionPolicy

RetentionPolicy

het bewaarbeleid voor deze categorie.
timeGrain

string

de tijdgrain van de metrische waarde in ISO8601 indeling.

RetentionPolicy

Hiermee geeft u het bewaarbeleid voor het logboek op.

Name Type Description
days

integer

het aantal dagen voor de retentie in dagen. De waarde 0 behoudt de gebeurtenissen voor onbepaalde tijd.
enabled

boolean

een waarde die aangeeft of het bewaarbeleid is ingeschakeld.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name Type Description
createdAt

string

Het tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit waarmee de resource is gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string

De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy

string

De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource het laatst heeft gewijzigd.