Diagnostic Settings - Create Or Update
Создает или обновляет параметры диагностики для указанного ресурса.
PUT https://management.azure.com/{resourceUri}/providers/Microsoft.Insights/diagnosticSettings/{name}?api-version=2021-05-01-preview
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
name
|
path | True |
string |
Имя параметра диагностики. |
|
resource
|
path | True |
string |
Идентификатор ресурса. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для этой операции. |
Текст запроса
| Имя | Тип | Описание |
|---|---|---|
| properties.eventHubAuthorizationRuleId |
string |
Идентификатор ресурса для правила авторизации концентратора событий. |
| properties.eventHubName |
string |
Имя концентратора событий. Если ни один из них не указан, будет выбран концентратор событий по умолчанию. |
| properties.logAnalyticsDestinationType |
string |
Строка, указывающая, должен ли экспорт в Log Analytics использовать тип назначения по умолчанию, т. е. AzureDiagnostics или использовать тип назначения, созданный следующим образом: <нормализованное имя> категории identity<_>normalized службы. Возможные значения: выделенный и null (значение NULL по умолчанию).) |
| properties.logs |
Список параметров журналов. |
|
| properties.marketplacePartnerId |
string |
Полный идентификатор ресурса ARM ресурса Marketplace, в который вы хотите отправить журналы диагностики. |
| properties.metrics |
Список параметров метрик. |
|
| 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 |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Успешный запрос на создание параметра диагностики |
|
| Other Status Codes |
Ответ на ошибку, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
| Имя | Описание |
|---|---|
| user_impersonation | олицетворения учетной записи пользователя |
Примеры
| Creates or Updates the diagnostic setting |
| Creates or Updates the diagnostic setting for category |
Creates or Updates the diagnostic setting
Образец запроса
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"
}
}
Пример ответа
{
"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
Образец запроса
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"
}
}
Пример ответа
{
"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"
}
}
Определения
| Имя | Описание |
|---|---|
|
created |
Тип удостоверения, создавшего ресурс. |
|
Diagnostic |
Ресурс параметра диагностики. |
|
Error |
Описывает формат ответа на ошибку. |
|
Log |
Часть MultiTenantDiagnosticSettings. Задает параметры для определенного журнала. |
|
Metric |
Часть MultiTenantDiagnosticSettings. Задает параметры для определенной метрики. |
|
Retention |
Указывает политику хранения для журнала. |
|
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
createdByType
Тип удостоверения, создавшего ресурс.
| Значение | Описание |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DiagnosticSettingsResource
Ресурс параметра диагностики.
| Имя | Тип | Описание |
|---|---|---|
| id |
string |
Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
Имя ресурса |
| properties.eventHubAuthorizationRuleId |
string |
Идентификатор ресурса для правила авторизации концентратора событий. |
| properties.eventHubName |
string |
Имя концентратора событий. Если ни один из них не указан, будет выбран концентратор событий по умолчанию. |
| properties.logAnalyticsDestinationType |
string |
Строка, указывающая, должен ли экспорт в Log Analytics использовать тип назначения по умолчанию, т. е. AzureDiagnostics или использовать тип назначения, созданный следующим образом: <нормализованное имя> категории identity<_>normalized службы. Возможные значения: выделенный и null (значение NULL по умолчанию).) |
| properties.logs |
Список параметров журналов. |
|
| properties.marketplacePartnerId |
string |
Полный идентификатор ресурса ARM ресурса Marketplace, в который вы хотите отправить журналы диагностики. |
| properties.metrics |
Список параметров метрик. |
|
| 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 |
Системные метаданные, связанные с этим ресурсом. |
|
| type |
string |
Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts" |
ErrorResponse
Описывает формат ответа на ошибку.
| Имя | Тип | Описание |
|---|---|---|
| code |
string |
Код ошибки |
| message |
string |
Сообщение об ошибке, указывающее, почему операция завершилась ошибкой. |
LogSettings
Часть MultiTenantDiagnosticSettings. Задает параметры для определенного журнала.
| Имя | Тип | Описание |
|---|---|---|
| category |
string |
Имя категории журнала диагностики для типа ресурса применяется к этому параметру. Чтобы получить список категорий журналов диагностики для ресурса, сначала выполните операцию параметров диагностики GET. |
| categoryGroup |
string |
Имя группы категорий журнала диагностики для типа ресурса применяется к этому параметру. Чтобы получить список категорий журналов диагностики для ресурса, сначала выполните операцию параметров диагностики GET. |
| enabled |
boolean |
значение, указывающее, включен ли этот журнал. |
| retentionPolicy |
Политика хранения для этого журнала. |
MetricSettings
Часть MultiTenantDiagnosticSettings. Задает параметры для определенной метрики.
| Имя | Тип | Описание |
|---|---|---|
| category |
string |
Имя категории метрики диагностики для типа ресурса применяется к этому параметру. Чтобы получить список категорий метрики диагностики для ресурса, сначала выполните операцию параметров диагностики GET. |
| enabled |
boolean |
значение, указывающее, включена ли эта категория. |
| retentionPolicy |
Политика хранения для этой категории. |
|
| timeGrain |
string (duration) |
время метрики в формате ISO8601. |
RetentionPolicy
Указывает политику хранения для журнала.
| Имя | Тип | Описание |
|---|---|---|
| days |
integer (int32) minimum: 0 |
количество дней хранения в днях. Значение 0 будет хранить события на неопределенный срок. |
| enabled |
boolean |
значение, указывающее, включена ли политика хранения. |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
| Имя | Тип | Описание |
|---|---|---|
| createdAt |
string (date-time) |
Метка времени создания ресурса (UTC). |
| createdBy |
string |
Удостоверение, создающее ресурс. |
| createdByType |
Тип удостоверения, создавшего ресурс. |
|
| lastModifiedAt |
string (date-time) |
Метка времени последнего изменения ресурса (UTC) |
| lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
| lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |