Components - Create Or Update

Служба:: Application Insights

Версия API:: 2015-05-01

Создает (или обновляет) компонент Application Insights. Примечание. Нельзя указать другое значение для InstrumentationKey или AppId в операции Put.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}?api-version=2015-05-01

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
kind	True	string	Тип приложения, к которому относится этот компонент, используется для настройки пользовательского интерфейса. Это значение является строкой свободной формы, значения обычно должны быть одним из следующих: web, ios, other, store, java, phone.
location	True	string	Расположение ресурса
properties.Application_Type	True	ApplicationType	Тип отслеживаемого приложения.
properties.DisableIpMasking		boolean	Отключите маскирование IP-адресов.
properties.Flow_Type		FlowType	Используется системой Application Insights для определения типа потока, созданного этим компонентом. При создании или обновлении компонента с помощью REST API необходимо задать значение Bluefield.
properties.HockeyAppId		string	Уникальный идентификатор приложения, созданный при добавлении нового приложения в HockeyApp, используемый для обмена данными с HockeyApp.
properties.ImmediatePurgeDataOn30Days		boolean	Очистка данных сразу после 30 дней.
properties.IngestionMode		IngestionMode	Указывает поток приема.
properties.Request_Source		RequestSource	Описывает, какой инструмент создал этот компонент Application Insights. Клиенты, использующие этот API, должны задать значение по умолчанию "rest".
properties.RetentionInDays		integer	Период хранения в днях.
properties.SamplingPercentage		number (double)	Процент данных, создаваемых приложением, отслеживаемых для телеметрии Application Insights.
tags		object	Теги ресурсов

Ответы

Имя	Тип	Описание
200 OK	ApplicationInsightsComponent	Успешный запрос при создании или обновлении компонента Application Insights. Возвращается обновленный компонент.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ComponentCreate

ComponentUpdate

ComponentCreate

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

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component?api-version=2015-05-01

{
  "location": "South Central US",
  "kind": "web",
  "properties": {
    "Application_Type": "web",
    "Flow_Type": "Bluefield",
    "Request_Source": "rest"
  }
}

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

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

{
  "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component",
  "name": "my-component",
  "type": "Microsoft.Insights/components",
  "location": "South Central US",
  "tags": "",
  "kind": "web",
  "properties": {
    "ApplicationId": "my-component",
    "AppId": "887f4bfd-b5fd-40d7-9fc3-123456789abc",
    "Application_Type": "web",
    "Flow_Type": "Bluefield",
    "Request_Source": "rest",
    "InstrumentationKey": "bc095013-3cf2-45ac-ab47-123456789abc",
    "CreationDate": "2017-01-24T01:05:38.5934061+00:00",
    "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc",
    "HockeyAppId": "",
    "HockeyAppToken": "",
    "provisioningState": "Succeeded",
    "SamplingPercentage": 100,
    "RetentionInDays": 90,
    "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
    "DisableIpMasking": false,
    "ImmediatePurgeDataOn30Days": false,
    "IngestionMode": "ApplicationInsights"
  }
}

ComponentUpdate

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

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component?api-version=2015-05-01

{
  "location": "South Central US",
  "kind": "web",
  "tags": {
    "ApplicationGatewayType": "Internal-Only",
    "BillingEntity": "Self"
  }
}

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

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

{
  "id": "/subscriptions/subid/resourceGroups/my-resource-group/providers/Microsoft.Insights/components/my-component",
  "name": "my-component",
  "type": "Microsoft.Insights/components",
  "location": "South Central US",
  "tags": {
    "ApplicationGatewayType": "Internal-Only",
    "BillingEntity": "Self"
  },
  "kind": "web",
  "properties": {
    "ApplicationId": "my-component",
    "AppId": "887f4bfd-b5fd-40d7-9fc3-123456789abc",
    "Application_Type": "web",
    "Flow_Type": "Bluefield",
    "Request_Source": "rest",
    "InstrumentationKey": "bc095013-3cf2-45ac-ab47-123456789abc",
    "CreationDate": "2017-01-24T01:05:38.5934061+00:00",
    "TenantId": "f438d567-7177-4fe1-a5e3-123456789abc",
    "HockeyAppId": "",
    "HockeyAppToken": "",
    "provisioningState": "Succeeded",
    "SamplingPercentage": 100,
    "RetentionInDays": 90,
    "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc",
    "DisableIpMasking": false,
    "ImmediatePurgeDataOn30Days": false,
    "IngestionMode": "ApplicationInsights"
  }
}

Определения

Имя	Описание
ApplicationInsightsComponent	Определение компонента Application Insights.
ApplicationType	Тип отслеживаемого приложения.
FlowType	Используется системой Application Insights для определения типа потока, созданного этим компонентом. При создании или обновлении компонента с помощью REST API необходимо задать значение Bluefield.
IngestionMode	Указывает поток приема.
PrivateLinkScopedResource	Ссылка на ресурс области приватного канала.
RequestSource	Описывает, какой инструмент создал этот компонент Application Insights. Клиенты, использующие этот API, должны задать значение по умолчанию "rest".

ApplicationInsightsComponent

Object

Определение компонента Application Insights.

Имя	Тип	Default value	Описание
id	string		Идентификатор ресурса Azure
kind	string		Тип приложения, к которому относится этот компонент, используется для настройки пользовательского интерфейса. Это значение является строкой свободной формы, значения обычно должны быть одним из следующих: web, ios, other, store, java, phone.
location	string		Расположение ресурса
name	string		Имя ресурса Azure
properties.AppId	string		Уникальный идентификатор Application Insights для приложения.
properties.ApplicationId	string		Уникальный идентификатор приложения. Это поле отражает поле "Имя" и не может быть изменено.
properties.Application_Type	ApplicationType	web	Тип отслеживаемого приложения.
properties.ConnectionString	string		Строка подключения компонента Application Insights.
properties.CreationDate	string (date-time)		Дата создания компонента Application Insights в формате ISO 8601.
properties.DisableIpMasking	boolean		Отключите маскирование IP-адресов.
properties.Flow_Type	FlowType	Bluefield	Используется системой Application Insights для определения типа потока, созданного этим компонентом. При создании или обновлении компонента с помощью REST API необходимо задать значение Bluefield.
properties.HockeyAppId	string		Уникальный идентификатор приложения, созданный при добавлении нового приложения в HockeyApp, используемый для обмена данными с HockeyApp.
properties.HockeyAppToken	string		Маркер, используемый для проверки подлинности обмена данными между Application Insights и HockeyApp.
properties.ImmediatePurgeDataOn30Days	boolean		Очистка данных сразу после 30 дней.
properties.IngestionMode	IngestionMode	ApplicationInsights	Указывает поток приема.
properties.InstrumentationKey	string		Ключ инструментирования Application Insights. Значение, доступное только для чтения, которое приложения могут использовать для идентификации назначения для всех данных телеметрии, отправляемых в Azure Application Insights. Это значение будет предоставлено при создании каждого нового компонента Application Insights.
properties.PrivateLinkScopedResources	PrivateLinkScopedResource[]		Список ресурсов связанной области приватного канала.
properties.Request_Source	RequestSource	rest	Описывает, какой инструмент создал этот компонент Application Insights. Клиенты, использующие этот API, должны задать значение по умолчанию "rest".
properties.RetentionInDays	integer	90	Период хранения в днях.
properties.SamplingPercentage	number (double)		Процент данных, создаваемых приложением, отслеживаемых для телеметрии Application Insights.
properties.TenantId	string		Идентификатор клиента Azure.
properties.provisioningState	string		Текущее состояние этого компонента: подготовлено ли оно в группе ресурсов. Пользователи не могут изменить это значение, но могут прочитать его. К значениям относятся успешное выполнение, развертывание, отмена и сбой.
tags	object		Теги ресурсов
type	string		Тип ресурса Azure

ApplicationType

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

Тип отслеживаемого приложения.

Значение	Описание
web
other

FlowType

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

Используется системой Application Insights для определения типа потока, созданного этим компонентом. При создании или обновлении компонента с помощью REST API необходимо задать значение Bluefield.

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

IngestionMode

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

Указывает поток приема.

Значение	Описание
ApplicationInsights
ApplicationInsightsWithDiagnosticSettings
LogAnalytics

PrivateLinkScopedResource

Object

Ссылка на ресурс области приватного канала.

Имя	Тип	Описание
ResourceId	string	Полный идентификатор ресурса области приватного канала.
ScopeId	string	Уникальный идентификатор области приватного канала.

RequestSource

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

Описывает, какой инструмент создал этот компонент Application Insights. Клиенты, использующие этот API, должны задать значение по умолчанию "rest".

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

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

Components - Create Or Update

Параметры URI

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

Ответы

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

azure_auth

Области

Примеры

ComponentCreate

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

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

ComponentUpdate

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

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

Определения

ApplicationInsightsComponent

ApplicationType

FlowType

IngestionMode

PrivateLinkScopedResource

RequestSource