Поделиться через

Logger - Create Or Update

  • Ссылка
Служба:
API Management
Версия API:
2024-05-01

Создает или обновляет средство ведения журнала.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2024-05-01

Параметры URI

Имя В Обязательно Тип Описание
loggerId
 path True

string

maxLength: 256
pattern: ^[^*#&+:<>?]+$

Идентификатор средства ведения журнала. Должен быть уникальным в экземпляре службы управления API.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Имя службы управления API.
subscriptionId
 path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть UUID.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.

Заголовок запроса

Имя Обязательно Тип Описание
If-Match

string

ETag сущности. Не требуется при создании сущности, но требуется при обновлении сущности.

Текст запроса

Имя Обязательно Тип Описание
properties.loggerType True

LoggerType

Тип средства ведения журнала.
properties.credentials

object

Имя и строка подключения SendRule концентратора событий для средства ведения журнала AzureEventHub. Ключ инструментирования для средства ведения журнала applicationInsights.
properties.description

string

maxLength: 256

Описание средства ведения журнала.
properties.isBuffered

boolean

Следует ли буферизать записи в средстве ведения журнала перед публикацией. Предполагается, что значение по умолчанию имеет значение true.
properties.resourceId

string

Идентификатор ресурса Azure целевого объекта журнала (ресурс Концентратора событий Azure или ресурс Azure Application Insights).

Ответы

Имя Тип Описание
200 OK

LoggerContract

Существующий средство ведения журнала успешно обновлено.

Заголовки

ETag: string
201 Created

LoggerContract

Средство ведения журнала успешно создано.

Заголовки

ETag: string
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementCreateAILogger
ApiManagementCreateEHLogger

ApiManagementCreateAILogger

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

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId?api-version=2024-05-01

{
  "properties": {
    "loggerType": "applicationInsights",
    "description": "adding a new logger",
    "credentials": {
      "instrumentationKey": "11................a1"
    }
  }
}

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

Код состояния:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "applicationInsights",
    "description": null,
    "credentials": {
      "instrumentationKey": "{{5a.......2a}}"
    },
    "isBuffered": false,
    "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource"
  }
}
Код состояния:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "applicationInsights",
    "description": null,
    "credentials": {
      "instrumentationKey": "{{5a.......2a}}"
    },
    "isBuffered": false
  }
}

ApiManagementCreateEHLogger

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

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1?api-version=2024-05-01

{
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "name": "hydraeventhub",
      "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********="
    }
  }
}

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

Код состояния:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}
Код состояния:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}

Определения

Имя Описание
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Ответ на ошибку
LoggerContract

Сведения о средстве ведения журнала.
LoggerType

Тип средства ведения журнала.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

LoggerContract

Object

Сведения о средстве ведения журнала.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.credentials

object

Имя и строка подключения SendRule концентратора событий для средства ведения журнала AzureEventHub. Ключ инструментирования для средства ведения журнала applicationInsights.
properties.description

string

maxLength: 256

Описание средства ведения журнала.
properties.isBuffered

boolean

Следует ли буферизать записи в средстве ведения журнала перед публикацией. Предполагается, что значение по умолчанию имеет значение true.
properties.loggerType

LoggerType

Тип средства ведения журнала.
properties.resourceId

string

Идентификатор ресурса Azure целевого объекта журнала (ресурс Концентратора событий Azure или ресурс Azure Application Insights).
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

LoggerType

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

Тип средства ведения журнала.

Значение Описание
applicationInsights

Azure Application Insights в качестве назначения журнала.
azureEventHub

Концентратор событий Azure в качестве назначения журнала.
azureMonitor

Azure Monitor