Sdílet prostřednictvím


Diagnostic Settings - Get

Získá aktivní nastavení diagnostiky pro zadaný prostředek.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
name
path True

string

Název nastavení diagnostiky.

resourceUri
path True

string

Identifikátor prostředku.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

DiagnosticSettingsResource

Úspěšná žádost o získání dalších informací o nastavení diagnostiky

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

Gets the diagnostic setting
Gets the diagnostic setting for category

Gets the diagnostic setting

Ukázkový požadavek

GET 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

Ukázková odpověď

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

Ukázkový požadavek

GET 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

Ukázková odpověď

{
  "id": "/subscriptions/1a66ce04-b633-4a0b-b2bc-a912ec8986a6/resourcegroups/viruela1/providers/microsoft.logic/workflows/viruela6/diagnosticSettings/service",
  "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",
    "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
        }
      }
    ]
  }
}

Definice

Name Description
createdByType

Typ identity, která vytvořila prostředek.

DiagnosticSettingsResource

Prostředek nastavení diagnostiky

ErrorResponse

Popisuje formát chybové odpovědi.

LogSettings

Součást MultiTenantDiagnosticSettings. Určuje nastavení pro konkrétní protokol.

MetricSettings

Součást MultiTenantDiagnosticSettings. Určuje nastavení pro konkrétní metriku.

RetentionPolicy

Určuje zásadu uchovávání informací pro protokol.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

createdByType

Typ identity, která vytvořila prostředek.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DiagnosticSettingsResource

Prostředek nastavení diagnostiky

Name Typ Description
id

string

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Název prostředku

properties.eventHubAuthorizationRuleId

string

ID prostředku pro autorizační pravidlo centra událostí.

properties.eventHubName

string

Název centra událostí. Pokud není zadán žádný, vybere se výchozí centrum událostí.

properties.logAnalyticsDestinationType

string

Řetězec označující, jestli má export do Log Analytics používat výchozí cílový typ, tj. AzureDiagnostics, nebo cílový typ vytvořený takto: _. Možné hodnoty jsou: Dedicated a null (hodnota null je výchozí).

properties.logs

LogSettings[]

Seznam nastavení protokolů

properties.marketplacePartnerId

string

Úplné ID prostředku ARM prostředku Marketplace, do kterého chcete odesílat diagnostické protokoly.

properties.metrics

MetricSettings[]

Seznam nastavení metrik.

properties.serviceBusRuleId

string

Id pravidla služby Service Bus nastavení diagnostiky. To je tady kvůli zachování zpětné kompatibility.

properties.storageAccountId

string

ID prostředku účtu úložiště, do kterého chcete odesílat diagnostické protokoly.

properties.workspaceId

string

Úplné ID prostředku ARM pracovního prostoru služby Log Analytics, do kterého chcete odesílat diagnostické protokoly. Příklad: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

systemData

systemData

Systémová metadata související s tímto prostředkem.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ErrorResponse

Popisuje formát chybové odpovědi.

Name Typ Description
code

string

Kód chyby

message

string

Chybová zpráva označující, proč operace selhala.

LogSettings

Součást MultiTenantDiagnosticSettings. Určuje nastavení pro konkrétní protokol.

Name Typ Description
category

string

Název kategorie diagnostického protokolu pro typ prostředku, na který se toto nastavení vztahuje. Pokud chcete získat seznam kategorií diagnostických protokolů pro prostředek, nejprve proveďte operaci GET s nastavením diagnostiky.

categoryGroup

string

Název skupiny kategorií diagnostického protokolu pro typ prostředku, na který se toto nastavení vztahuje. Pokud chcete získat seznam kategorií diagnostických protokolů pro prostředek, nejprve proveďte operaci GET s nastavením diagnostiky.

enabled

boolean

hodnota označující, jestli je tento protokol povolený.

retentionPolicy

RetentionPolicy

zásady uchovávání informací pro tento protokol.

MetricSettings

Součást MultiTenantDiagnosticSettings. Určuje nastavení pro konkrétní metriku.

Name Typ Description
category

string

Název kategorie diagnostické metriky pro typ prostředku, na který se toto nastavení vztahuje. Seznam kategorií diagnostických metrik pro prostředek získáte tak, že nejprve provedete operaci GET s nastavením diagnostiky.

enabled

boolean

hodnota označující, zda je tato kategorie povolena.

retentionPolicy

RetentionPolicy

zásady uchovávání informací pro tuto kategorii.

timeGrain

string

časový interval metriky ve formátu ISO8601.

RetentionPolicy

Určuje zásadu uchovávání informací pro protokol.

Name Typ Description
days

integer

počet dnů uchovávání ve dnech. Hodnota 0 zachová události po neomezenou dobu.

enabled

boolean

hodnota označující, jestli jsou zásady uchovávání informací povolené.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která vytvořila prostředek.

lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.