Diagnostic Settings - List

Pobiera listę aktywnych ustawień diagnostycznych dla określonego zasobu.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceUri
path True

string

Identyfikator zasobu.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

DiagnosticSettingsResourceCollection

Pomyślne żądanie uzyskania dodatkowych informacji o ustawieniu diagnostycznym

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

Gets the diagnostic setting
Gets the diagnostic setting for category

Gets the diagnostic setting

Sample Request

GET https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings?api-version=2021-05-01-preview

Sample Response

{
  "value": [
    {
      "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",
        "eventHubAuthorizationRuleId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "",
        "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
            }
          }
        ]
      }
    }
  ]
}

Gets the diagnostic setting for category

Sample Request

GET https://management.azure.com/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/providers/Microsoft.Insights/diagnosticSettings?api-version=2021-05-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/mysetting",
      "type": "microsoft.logic/workflows",
      "name": "mysetting",
      "properties": {
        "storageAccountId": "/subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
        "eventHubAuthorizationRuleId": "/subscriptions/b67f7fec-69fc-4974-9099-a26bd6ffeda3/resourceGroups/andy1101/providers/Microsoft.EventHub/namespaces/andy1101/authorizationrules/RootManageSharedAccessKey",
        "workspaceId": "",
        "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
            }
          }
        ]
      }
    }
  ]
}

Definicje

Nazwa Opis
createdByType

Typ tożsamości, która utworzyła zasób.

DiagnosticSettingsResource

Zasób ustawienia diagnostycznego.

DiagnosticSettingsResourceCollection

Reprezentuje kolekcję zasobów reguły alertu.

ErrorResponse

Opisuje format odpowiedzi Błąd.

LogSettings

Część funkcji MultiTenantDiagnosticSettings. Określa ustawienia dla określonego dziennika.

MetricSettings

Część funkcji MultiTenantDiagnosticSettings. Określa ustawienia dla określonej metryki.

RetentionPolicy

Określa zasady przechowywania dziennika.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DiagnosticSettingsResource

Zasób ustawienia diagnostycznego.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties.eventHubAuthorizationRuleId

string

Identyfikator zasobu reguły autoryzacji centrum zdarzeń.

properties.eventHubName

string

Nazwa centrum zdarzeń. Jeśli żaden z nich nie zostanie określony, zostanie wybrane domyślne centrum zdarzeń.

properties.logAnalyticsDestinationType

string

Ciąg wskazujący, czy eksport do usługi Log Analytics powinien używać domyślnego typu docelowego, tj. AzureDiagnostics, czy użyć typu docelowego skonstruowanego w następujący sposób: _. Możliwe wartości to: Dedykowane i null (wartość null jest domyślna).

properties.logs

LogSettings[]

Lista ustawień dzienników.

properties.marketplacePartnerId

string

Pełny identyfikator zasobu usługi ARM zasobu witryny Marketplace, do którego chcesz wysłać dzienniki diagnostyczne.

properties.metrics

MetricSettings[]

Lista ustawień metryk.

properties.serviceBusRuleId

string

Identyfikator reguły usługi Service Bus ustawienia diagnostycznego. Jest to tutaj, aby zachować zgodność z poprzednimi wersjami.

properties.storageAccountId

string

Identyfikator zasobu konta magazynu, do którego chcesz wysłać dzienniki diagnostyczne.

properties.workspaceId

string

Pełny identyfikator zasobu usługi ARM obszaru roboczego usługi Log Analytics, do którego chcesz wysłać dzienniki diagnostyczne. Przykład: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

systemData

systemData

Metadane systemowe związane z tym zasobem.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

DiagnosticSettingsResourceCollection

Reprezentuje kolekcję zasobów reguły alertu.

Nazwa Typ Opis
value

DiagnosticSettingsResource[]

Kolekcja zasobów ustawień diagnostycznych;.

ErrorResponse

Opisuje format odpowiedzi Błąd.

Nazwa Typ Opis
code

string

Kod błędu

message

string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

LogSettings

Część funkcji MultiTenantDiagnosticSettings. Określa ustawienia dla określonego dziennika.

Nazwa Typ Opis
category

string

Nazwa kategorii dzienników diagnostycznych dla typu zasobu, do których jest stosowane to ustawienie. Aby uzyskać listę kategorii dzienników diagnostycznych dla zasobu, najpierw wykonaj operację GET ustawień diagnostycznych.

categoryGroup

string

Nazwa grupy kategorii dzienników diagnostycznych dla typu zasobu, do których jest stosowane to ustawienie. Aby uzyskać listę kategorii dzienników diagnostycznych dla zasobu, najpierw wykonaj operację GET ustawień diagnostycznych.

enabled

boolean

wartość wskazująca, czy ten dziennik jest włączony.

retentionPolicy

RetentionPolicy

zasady przechowywania dla tego dziennika.

MetricSettings

Część funkcji MultiTenantDiagnosticSettings. Określa ustawienia dla określonej metryki.

Nazwa Typ Opis
category

string

Nazwa kategorii Metryka diagnostyczna dla typu zasobu, do których jest stosowane to ustawienie. Aby uzyskać listę kategorii metryk diagnostycznych dla zasobu, najpierw wykonaj operację GET ustawień diagnostycznych.

enabled

boolean

wartość wskazująca, czy ta kategoria jest włączona.

retentionPolicy

RetentionPolicy

zasady przechowywania dla tej kategorii.

timeGrain

string

wartość timegrain metryki w formacie ISO8601.

RetentionPolicy

Określa zasady przechowywania dziennika.

Nazwa Typ Opis
days

integer

liczba dni przechowywania w dniach. Wartość 0 zachowuje zdarzenia na czas nieokreślony.

enabled

boolean

wartość wskazująca, czy zasady przechowywania są włączone.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).

createdBy

string

Tożsamość, która utworzyła zasób.

createdByType

createdByType

Typ tożsamości, która utworzyła zasób.

lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)

lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.

lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.