Diagnostic Settings - Create Or Update

  • Referência
Service:
Monitor
API Version:
2021-05-01-preview

Cria ou atualiza as definições de diagnóstico do recurso especificado.

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

Parâmetros do URI

Name Em Necessário Tipo Description
name
 path True

string

O nome da definição de diagnóstico.
resourceUri
 path True

string

O identificador do recurso.
api-version
 query True

string

A versão da API a utilizar para esta operação.

Corpo do Pedido

Name Tipo Description
properties.eventHubAuthorizationRuleId

string

O ID de recurso da regra de autorização do hub de eventos.
properties.eventHubName

string

O nome do hub de eventos. Se não for especificado nenhum, o hub de eventos predefinido será selecionado.
properties.logAnalyticsDestinationType

string

Uma cadeia que indica se a exportação para o Log Analytics deve utilizar o tipo de destino predefinido, ou seja, AzureDiagnostics ou utilizar um tipo de destino construído da seguinte forma: _. Os valores possíveis são: Dedicado e nulo (nulo é predefinido.)
properties.logs

LogSettings[]

A lista de definições de registos.
properties.marketplacePartnerId

string

O ID de recurso do ARM completo do recurso do Marketplace para o qual gostaria de enviar Registos de Diagnóstico.
properties.metrics

MetricSettings[]

A lista de definições de métricas.
properties.serviceBusRuleId

string

O ID da regra do service bus da definição de diagnóstico. Isto é para manter a retrocompatibilidade.
properties.storageAccountId

string

O ID de recurso da conta de armazenamento para a qual pretende enviar Registos de Diagnóstico.
properties.workspaceId

string

O ID de recurso do ARM completo da área de trabalho do Log Analytics para a qual gostaria de enviar Registos de Diagnóstico. Exemplo: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

Respostas

Name Tipo Description
200 OK

DiagnosticSettingsResource

Pedido com êxito para criar uma definição de diagnóstico
Other Status Codes

ErrorResponse

Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

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

Definições

Name Description
createdByType

O tipo de identidade que criou o recurso.
DiagnosticSettingsResource

O recurso de definição de diagnóstico.
ErrorResponse

Descreve o formato da resposta de Erro.
LogSettings

Parte de MultiTenantDiagnosticSettings. Especifica as definições de um registo específico.
MetricSettings

Parte de MultiTenantDiagnosticSettings. Especifica as definições para uma métrica específica.
RetentionPolicy

Especifica a política de retenção para o registo.
systemData

Metadados relativos à criação e última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

DiagnosticSettingsResource

O recurso de definição de diagnóstico.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.eventHubAuthorizationRuleId

string

O ID de recurso da regra de autorização do hub de eventos.
properties.eventHubName

string

O nome do hub de eventos. Se não for especificado nenhum, o hub de eventos predefinido será selecionado.
properties.logAnalyticsDestinationType

string

Uma cadeia que indica se a exportação para o Log Analytics deve utilizar o tipo de destino predefinido, ou seja, AzureDiagnostics ou utilizar um tipo de destino construído da seguinte forma: _. Os valores possíveis são: Dedicado e nulo (nulo é predefinido.)
properties.logs

LogSettings[]

A lista de definições de registos.
properties.marketplacePartnerId

string

O ID de recurso do ARM completo do recurso do Marketplace para o qual gostaria de enviar Registos de Diagnóstico.
properties.metrics

MetricSettings[]

A lista de definições de métricas.
properties.serviceBusRuleId

string

O ID da regra do service bus da definição de diagnóstico. Isto é para manter a retrocompatibilidade.
properties.storageAccountId

string

O ID de recurso da conta de armazenamento para a qual pretende enviar Registos de Diagnóstico.
properties.workspaceId

string

O ID de recurso do ARM completo da área de trabalho do Log Analytics para a qual gostaria de enviar Registos de Diagnóstico. Exemplo: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2
systemData

systemData

Os metadados do sistema relacionados com este recurso.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ErrorResponse

Descreve o formato da resposta de Erro.

Name Tipo Description
code

string

Código de erro
message

string

Mensagem de erro a indicar o motivo pela qual a operação falhou.

LogSettings

Parte de MultiTenantDiagnosticSettings. Especifica as definições de um registo específico.

Name Tipo Description
category

string

Nome de uma categoria de Registo de Diagnóstico para um tipo de recurso a que esta definição é aplicada. Para obter a lista de categorias do Registo de Diagnósticos de um recurso, execute primeiro uma operação de definições de diagnóstico GET.
categoryGroup

string

Nome de um grupo de categorias do Registo de Diagnósticos para um tipo de recurso ao qual esta definição é aplicada. Para obter a lista de categorias do Registo de Diagnósticos de um recurso, execute primeiro uma operação de definições de diagnóstico GET.
enabled

boolean

um valor que indica se este registo está ativado.
retentionPolicy

RetentionPolicy

a política de retenção para este registo.

MetricSettings

Parte de MultiTenantDiagnosticSettings. Especifica as definições para uma métrica específica.

Name Tipo Description
category

string

Nome de uma categoria de Métrica de Diagnóstico para um tipo de recurso a que esta definição é aplicada. Para obter a lista de Categorias de métricas de diagnóstico para um recurso, execute primeiro uma operação de definições de diagnóstico GET.
enabled

boolean

um valor que indica se esta categoria está ativada.
retentionPolicy

RetentionPolicy

a política de retenção para esta categoria.
timeGrain

string

o timegrain da métrica no formato ISO8601.

RetentionPolicy

Especifica a política de retenção para o registo.

Name Tipo Description
days

integer

o número de dias para a retenção em dias. Um valor de 0 irá manter os eventos indefinidamente.
enabled

boolean

um valor que indica se a política de retenção está ativada.

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.