Diagnostic Settings - Create Or Update

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

Crea o aggiorna le impostazioni di diagnostica per la risorsa specificata.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
name
 path True

string

Nome dell'impostazione di diagnostica.
resourceUri
 path True

string

Identificatore della risorsa.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
properties.eventHubAuthorizationRuleId

string

ID risorsa per la regola di autorizzazione dell'hub eventi.
properties.eventHubName

string

Nome di Hub eventi. Se non viene specificato alcun valore, verrà selezionato l'hub eventi predefinito.
properties.logAnalyticsDestinationType

string

Stringa che indica se l'esportazione in Log Analytics deve usare il tipo di destinazione predefinito, ad esempio AzureDiagnostics o usare un tipo di destinazione costruito come indicato di seguito: _. I valori possibili sono: Dedicato e Null (null è predefinito).
properties.logs

LogSettings[]

Elenco delle impostazioni dei log.
properties.marketplacePartnerId

string

ID risorsa ARM completo della risorsa marketplace a cui si desidera inviare i log di diagnostica.
properties.metrics

MetricSettings[]

Elenco delle impostazioni delle metriche.
properties.serviceBusRuleId

string

ID regola del bus di servizio dell'impostazione di diagnostica. Questo è qui per mantenere la compatibilità con le versioni precedenti.
properties.storageAccountId

string

ID risorsa dell'account di archiviazione a cui si desidera inviare i log di diagnostica.
properties.workspaceId

string

ID risorsa ARM completo dell'area di lavoro Log Analytics a cui si desidera inviare i log di diagnostica. Esempio: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

Risposte

Nome Tipo Descrizione
200 OK

DiagnosticSettingsResource

Richiesta riuscita per creare un'impostazione di diagnostica
Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

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

Definizioni

Nome Descrizione
createdByType

Tipo di identità che ha creato la risorsa.
DiagnosticSettingsResource

Risorsa dell'impostazione di diagnostica.
ErrorResponse

Descrive il formato della risposta di errore.
LogSettings

Parte di MultiTenantDiagnosticSettings. Specifica le impostazioni per un particolare log.
MetricSettings

Parte di MultiTenantDiagnosticSettings. Specifica le impostazioni per una particolare metrica.
RetentionPolicy

Specifica i criteri di conservazione per il log.
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

DiagnosticSettingsResource

Risorsa dell'impostazione di diagnostica.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

nome della risorsa.
properties.eventHubAuthorizationRuleId

string

ID risorsa per la regola di autorizzazione dell'hub eventi.
properties.eventHubName

string

Nome di Hub eventi. Se non viene specificato alcun valore, verrà selezionato l'hub eventi predefinito.
properties.logAnalyticsDestinationType

string

Stringa che indica se l'esportazione in Log Analytics deve usare il tipo di destinazione predefinito, ad esempio AzureDiagnostics o usare un tipo di destinazione costruito come indicato di seguito: _. I valori possibili sono: Dedicato e Null (null è predefinito).
properties.logs

LogSettings[]

Elenco delle impostazioni dei log.
properties.marketplacePartnerId

string

ID risorsa ARM completo della risorsa marketplace a cui si desidera inviare i log di diagnostica.
properties.metrics

MetricSettings[]

Elenco delle impostazioni delle metriche.
properties.serviceBusRuleId

string

ID regola del bus di servizio dell'impostazione di diagnostica. Questo è qui per mantenere la compatibilità con le versioni precedenti.
properties.storageAccountId

string

ID risorsa dell'account di archiviazione a cui si desidera inviare i log di diagnostica.
properties.workspaceId

string

ID risorsa ARM completo dell'area di lavoro Log Analytics a cui si desidera inviare i log di diagnostica. Esempio: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2
systemData

systemData

Metadati di sistema correlati a questa risorsa.
type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorResponse

Descrive il formato della risposta di errore.

Nome Tipo Descrizione
code

string

Codice di errore
message

string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

LogSettings

Parte di MultiTenantDiagnosticSettings. Specifica le impostazioni per un particolare log.

Nome Tipo Descrizione
category

string

Nome di una categoria log di diagnostica per un tipo di risorsa a cui viene applicata questa impostazione. Per ottenere l'elenco di una categoria di log di diagnostica per una risorsa, eseguire prima un'operazione GET sulle impostazioni di diagnostica.
categoryGroup

string

Nome di un gruppo di categorie log di diagnostica per un tipo di risorsa a cui viene applicata questa impostazione. Per ottenere l'elenco di una categoria di log di diagnostica per una risorsa, eseguire prima un'operazione GET sulle impostazioni di diagnostica.
enabled

boolean

valore che indica se il log è abilitato.
retentionPolicy

RetentionPolicy

i criteri di conservazione per questo log.

MetricSettings

Parte di MultiTenantDiagnosticSettings. Specifica le impostazioni per una particolare metrica.

Nome Tipo Descrizione
category

string

Nome di una categoria metrica di diagnostica per un tipo di risorsa a cui viene applicata questa impostazione. Per ottenere l'elenco delle categorie di metriche di diagnostica per una risorsa, eseguire prima di tutto un'operazione get delle impostazioni di diagnostica.
enabled

boolean

valore che indica se questa categoria è abilitata.
retentionPolicy

RetentionPolicy

i criteri di conservazione per questa categoria.
timeGrain

string

timegrain della metrica in formato ISO8601.

RetentionPolicy

Specifica i criteri di conservazione per il log.

Nome Tipo Descrizione
days

integer

numero di giorni per la conservazione in giorni. Il valore 0 manterrà gli eventi per un periodo illimitato.
enabled

boolean

valore che indica se i criteri di conservazione sono abilitati.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.