Partilhar via


Diagnostic Settings - Create Or Update

Cria ou atualiza as configurações de diagnóstico para o 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 configuração de diagnóstico.

resourceUri
path True

string

O identificador do recurso.

api-version
query True

string

minLength: 1

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

Corpo do Pedido

Name Tipo Description
properties.eventHubAuthorizationRuleId

string

A ID do recurso para a regra de autorização do hub de eventos.

properties.eventHubName

string

O nome do hub de eventos. Se nenhum for especificado, o hub de eventos padrão será selecionado.

properties.logAnalyticsDestinationType

string

Uma cadeia de caracteres que indica se a exportação para o Log Analytics deve usar o tipo de destino padrão, ou seja, AzureDiagnostics, ou usar um tipo de destino construído da seguinte maneira: <normalized service identity>_<normalized category name>. Os valores possíveis são: Dedicado e nulo (null é padrão.)

properties.logs

LogSettings[]

A lista de configurações de logs.

properties.marketplacePartnerId

string

O ID de recurso ARM completo do recurso do Marketplace para o qual você gostaria de enviar Logs de diagnóstico.

properties.metrics

MetricSettings[]

A lista de configurações métricas.

properties.serviceBusRuleId

string

A ID da regra do barramento de serviço da configuração de diagnóstico. Isso está aqui para manter a compatibilidade com versões anteriores.

properties.storageAccountId

string

O ID do recurso da conta de armazenamento para a qual você deseja enviar Logs de Diagnóstico.

properties.workspaceId

string

O ID de recurso ARM completo do espaço de trabalho do Log Analytics para o qual você deseja enviar Logs 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

Solicitação bem-sucedida para criar uma configuração de diagnóstico

Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar 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

Pedido de amostra

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

Resposta da amostra

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

Pedido de amostra

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

Resposta da amostra

{
  "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 configuração de diagnóstico.

ErrorResponse

Descreve o formato de Resposta de erro.

LogSettings

Parte de MultiTenantDiagnosticSettings. Especifica as configurações para um log específico.

MetricSettings

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

RetentionPolicy

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

systemData

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

createdByType

O tipo de identidade que criou o recurso.

Valor Description
User
Application
ManagedIdentity
Key

DiagnosticSettingsResource

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

Name Tipo Description
id

string

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

name

string

O nome do recurso

properties.eventHubAuthorizationRuleId

string

A ID do recurso para a regra de autorização do hub de eventos.

properties.eventHubName

string

O nome do hub de eventos. Se nenhum for especificado, o hub de eventos padrão será selecionado.

properties.logAnalyticsDestinationType

string

Uma cadeia de caracteres que indica se a exportação para o Log Analytics deve usar o tipo de destino padrão, ou seja, AzureDiagnostics, ou usar um tipo de destino construído da seguinte maneira: <normalized service identity>_<normalized category name>. Os valores possíveis são: Dedicado e nulo (null é padrão.)

properties.logs

LogSettings[]

A lista de configurações de logs.

properties.marketplacePartnerId

string

O ID de recurso ARM completo do recurso do Marketplace para o qual você gostaria de enviar Logs de diagnóstico.

properties.metrics

MetricSettings[]

A lista de configurações métricas.

properties.serviceBusRuleId

string

A ID da regra do barramento de serviço da configuração de diagnóstico. Isso está aqui para manter a compatibilidade com versões anteriores.

properties.storageAccountId

string

O ID do recurso da conta de armazenamento para a qual você deseja enviar Logs de Diagnóstico.

properties.workspaceId

string

O ID de recurso ARM completo do espaço de trabalho do Log Analytics para o qual você deseja enviar Logs 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 a este recurso.

type

string

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

ErrorResponse

Descreve o formato de Resposta de erro.

Name Tipo Description
code

string

Código de erro

message

string

Mensagem de erro indicando por que a operação falhou.

LogSettings

Parte de MultiTenantDiagnosticSettings. Especifica as configurações para um log específico.

Name Tipo Description
category

string

Nome de uma categoria de Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET.

categoryGroup

string

Nome de um grupo de categorias de Log de Diagnóstico para um tipo de recurso ao qual essa configuração é aplicada. Para obter a lista de categorias de Log de Diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET.

enabled

boolean

Um valor que indica se esse log está habilitado.

retentionPolicy

RetentionPolicy

A política de retenção para este log.

MetricSettings

Parte de MultiTenantDiagnosticSettings. Especifica as configuraçõ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 ao qual essa configuração é aplicada. Para obter a lista de categorias de métricas de diagnóstico para um recurso, primeiro execute uma operação de configurações de diagnóstico GET.

enabled

boolean

Um valor que indica se essa categoria está habilitada.

retentionPolicy

RetentionPolicy

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

timeGrain

string (duration)

o timegrain da métrica em ISO8601 formato.

RetentionPolicy

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

Name Tipo Description
days

integer (int32)

minimum: 0

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

enabled

boolean

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

systemData

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

Name Tipo Description
createdAt

string (date-time)

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 (date-time)

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.