Subscription Diagnostic Settings - Get

Служба:: Monitor

Версия API:: 2021-05-01-preview

Возвращает параметры диагностики активных подписок для указанного ресурса.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя параметра диагностики.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	SubscriptionDiagnosticSettingsResource	Успешный запрос, чтобы получить дополнительные сведения о параметрах диагностики.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Gets the subscription diagnostic setting

Gets the subscription diagnostic setting for category

Gets the subscription diagnostic setting

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview

Пример ответа

Код состояния:: 200

{
  "id": "subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/providers/AzureResourceManager/diagnosticSettings/ds4",
  "type": null,
  "name": "ds4",
  "properties": {
    "storageAccountId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.OperationalInsights/workspaces/test1",
    "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "logs": [
      {
        "categoryGroup": "allLogs",
        "enabled": true
      }
    ]
  }
}

Gets the subscription diagnostic setting for category

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/providers/Microsoft.Insights/diagnosticSettings/mysetting?api-version=2021-05-01-preview

Пример ответа

Код состояния:: 200

{
  "id": "subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/providers/AzureResourceManager/diagnosticSettings/ds4",
  "type": null,
  "name": "ds4",
  "properties": {
    "storageAccountId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.Storage/storageAccounts/appteststorage1",
    "workspaceId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/Microsoft.OperationalInsights/workspaces/test1",
    "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/apptest/providers/microsoft.eventhub/namespaces/mynamespace/authorizationrules/myrule",
    "marketplacePartnerId": "/subscriptions/abcdeabc-1234-1234-ab12-123a1234567a/resourceGroups/test-rg/providers/Microsoft.Datadog/monitors/dd1",
    "logs": [
      {
        "category": "Security",
        "enabled": true
      },
      {
        "category": "Administrative",
        "enabled": true
      },
      {
        "category": "ServiceHealth",
        "enabled": true
      },
      {
        "category": "Alert",
        "enabled": true
      },
      {
        "category": "Recommendation",
        "enabled": true
      },
      {
        "category": "Policy",
        "enabled": true
      },
      {
        "category": "Autoscale",
        "enabled": true
      },
      {
        "category": "ResourceHealth",
        "enabled": true
      }
    ]
  }
}

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorResponse	Описывает формат ответа на ошибку.
SubscriptionDiagnosticSettingsResource	Ресурс параметра диагностики подписки.
SubscriptionLogSettings	Часть параметра диагностики подписки. Задает параметры для определенного журнала.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorResponse

Object

Описывает формат ответа на ошибку.

Имя	Тип	Описание
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась ошибкой.

SubscriptionDiagnosticSettingsResource

Object

Ресурс параметра диагностики подписки.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.eventHubAuthorizationRuleId	string	Идентификатор ресурса для правила авторизации концентратора событий.
properties.eventHubName	string	Имя концентратора событий. Если ни один из них не указан, будет выбран концентратор событий по умолчанию.
properties.logs	SubscriptionLogSettings[]	Список параметров журналов.
properties.marketplacePartnerId	string	Полный идентификатор ресурса ARM ресурса Marketplace, в который вы хотите отправить журналы диагностики.
properties.serviceBusRuleId	string	Идентификатор правила служебной шины параметра диагностики. Здесь для обеспечения обратной совместимости.
properties.storageAccountId	string	Идентификатор ресурса учетной записи хранения, в которую вы хотите отправить журналы диагностики.
properties.workspaceId	string	Полный идентификатор ресурса ARM рабочей области Log Analytics, в которую вы хотите отправить журналы диагностики. Пример: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2
systemData	systemData	Системные метаданные, связанные с этим ресурсом.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

SubscriptionLogSettings

Object

Часть параметра диагностики подписки. Задает параметры для определенного журнала.

Имя	Тип	Описание
category	string	Имя категории журнала диагностики подписки для типа ресурса применяется к этому параметру.
categoryGroup	string	Имя группы категорий журнала диагностики подписки для типа ресурса применяется к этому параметру.
enabled	boolean	значение, указывающее, включен ли этот журнал.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.