Components - Create Or Update

Referenz

Dienst:: Application Insights

API-Version:: 2015-05-01

Erstellt (oder aktualisiert) eine Application Insights-Komponente. Hinweis: Sie können keinen anderen Wert für InstrumentationKey oder AppId im Put-Vorgang angeben.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string	Der Name der Application Insights-Komponentenressource.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
kind	True	string	Die Art der Anwendung, auf die sich diese Komponente bezieht, die zum Anpassen der Benutzeroberfläche verwendet wird. Dieser Wert ist eine Freiformzeichenfolge. Die Werte sollten in der Regel wie folgt lauten: web, ios, other, store, java, phone.
location	True	string	Ressourcenspeicherort
properties.Application_Type	True	ApplicationType	Typ der zu überwachenden Anwendung.
properties.DisableIpMasking		boolean	Deaktivieren Sie die IP-Maskierung.
properties.Flow_Type		FlowType	Wird vom Application Insights-System verwendet, um zu bestimmen, von welcher Art von Flow diese Komponente erstellt wurde. Dies ist beim Erstellen/Aktualisieren einer Komponente über die REST-API auf "Bluefield" festzulegen.
properties.HockeyAppId		string	Die eindeutige Anwendungs-ID, die erstellt wird, wenn hockeyApp eine neue Anwendung hinzugefügt wird, die für die Kommunikation mit HockeyApp verwendet wird.
properties.ImmediatePurgeDataOn30Days		boolean	Löschen Sie Daten sofort nach 30 Tagen.
properties.IngestionMode		IngestionMode	Gibt den Ablauf der Erfassung an.
properties.Request_Source		RequestSource	Beschreibt, welches Tool diese Application Insights-Komponente erstellt hat. Kunden, die diese API verwenden, sollten dies auf den Standard "Rest" festlegen.
properties.RetentionInDays		integer	Aufbewahrungszeitraum in Tagen.
properties.SamplingPercentage		number	Prozentsatz der von der überwachten Anwendung erzeugten Daten, die für Application Insights-Telemetriedaten abgetastet werden.
tags		object	Ressourcentags

Antworten

Name	Typ	Beschreibung
200 OK	ApplicationInsightsComponent	Erfolgreiche Anforderung beim Erstellen oder Aktualisieren einer Application Insights-Komponente. Die aktualisierte Komponente wird zurückgegeben.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ComponentCreate

ComponentUpdate

ComponentCreate

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:: 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

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
ApplicationInsightsComponent	Eine Application Insights-Komponentendefinition.
ApplicationType	Typ der zu überwachenden Anwendung.
FlowType	Wird vom Application Insights-System verwendet, um zu bestimmen, von welcher Art von Flow diese Komponente erstellt wurde. Dies ist beim Erstellen/Aktualisieren einer Komponente über die REST-API auf "Bluefield" festzulegen.
IngestionMode	Gibt den Ablauf der Erfassung an.
PrivateLinkScopedResource	Der Ressourcenverweis für den Private Link-Bereich.
RequestSource	Beschreibt, welches Tool diese Application Insights-Komponente erstellt hat. Kunden, die diese API verwenden, sollten dies auf den Standard "Rest" festlegen.

ApplicationInsightsComponent

Eine Application Insights-Komponentendefinition.

Name	Typ	Standardwert	Beschreibung
id	string		Azure-Ressourcen-ID
kind	string		Die Art der Anwendung, auf die sich diese Komponente bezieht, die zum Anpassen der Benutzeroberfläche verwendet wird. Dieser Wert ist eine Freiformzeichenfolge. Die Werte sollten in der Regel wie folgt lauten: web, ios, other, store, java, phone.
location	string		Ressourcenspeicherort
name	string		Name der Azure-Ressource
properties.AppId	string		Eindeutige Application Insights-ID für Ihre Anwendung.
properties.ApplicationId	string		Die eindeutige ID Ihrer Anwendung. Dieses Feld spiegelt das Feld "Name" wieder und kann nicht geändert werden.
properties.Application_Type	ApplicationType	web	Typ der zu überwachenden Anwendung.
properties.ConnectionString	string		Application Insights-Komponenten Verbindungszeichenfolge.
properties.CreationDate	string		Erstellungsdatum für die Application Insights-Komponente im ISO 8601-Format.
properties.DisableIpMasking	boolean		Deaktivieren Sie die IP-Maskierung.
properties.Flow_Type	FlowType	Bluefield	Wird vom Application Insights-System verwendet, um zu bestimmen, von welcher Art von Flow diese Komponente erstellt wurde. Dies ist beim Erstellen/Aktualisieren einer Komponente über die REST-API auf "Bluefield" festzulegen.
properties.HockeyAppId	string		Die eindeutige Anwendungs-ID, die erstellt wird, wenn hockeyApp eine neue Anwendung hinzugefügt wird, die für die Kommunikation mit HockeyApp verwendet wird.
properties.HockeyAppToken	string		Token, das zum Authentifizieren der Kommunikation zwischen Application Insights und HockeyApp verwendet wird.
properties.ImmediatePurgeDataOn30Days	boolean		Löschen Sie Daten sofort nach 30 Tagen.
properties.IngestionMode	IngestionMode	ApplicationInsights	Gibt den Ablauf der Erfassung an.
properties.InstrumentationKey	string		Application Insights-Instrumentierungsschlüssel. Ein schreibgeschützter Wert, den Anwendungen verwenden können, um das Ziel für alle Telemetriedaten zu identifizieren, die an Azure-Anwendung Insights gesendet werden. Dieser Wert wird beim Erstellen jeder neuen Application Insights-Komponente bereitgestellt.
properties.PrivateLinkScopedResources	PrivateLinkScopedResource[]		Liste der Ressourcen des Bereichs für verknüpfte private Links.
properties.Request_Source	RequestSource	rest	Beschreibt, welches Tool diese Application Insights-Komponente erstellt hat. Kunden, die diese API verwenden, sollten dies auf den Standard "Rest" festlegen.
properties.RetentionInDays	integer	90	Aufbewahrungszeitraum in Tagen.
properties.SamplingPercentage	number		Prozentsatz der von der überwachten Anwendung erzeugten Daten, die für Application Insights-Telemetriedaten abgetastet werden.
properties.TenantId	string		Azure-Mandanten-ID.
properties.provisioningState	string		Aktueller Zustand dieser Komponente: unabhängig davon, ob innerhalb der definierten Ressourcengruppe bereitgestellt wurde oder nicht. Benutzer können diesen Wert nicht ändern, können aber daraus lesen. Zu den Werten gehören Erfolgreich, Bereitstellen, Abgebrochen und Fehler.
tags	object		Ressourcentags
type	string		Azure-Ressourcentyp

ApplicationType

Typ der zu überwachenden Anwendung.

Name	Typ	Beschreibung
other	string
web	string

FlowType

Wird vom Application Insights-System verwendet, um zu bestimmen, von welcher Art von Flow diese Komponente erstellt wurde. Dies ist beim Erstellen/Aktualisieren einer Komponente über die REST-API auf "Bluefield" festzulegen.

Name	Typ	Beschreibung
Bluefield	string

IngestionMode

Gibt den Ablauf der Erfassung an.

Name	Typ	Beschreibung
ApplicationInsights	string
ApplicationInsightsWithDiagnosticSettings	string
LogAnalytics	string

PrivateLinkScopedResource

Der Ressourcenverweis für den Private Link-Bereich.

Name	Typ	Beschreibung
ResourceId	string	Die vollständige Ressourcen-ID der Private Link-Bereichsressource.
ScopeId	string	Der eindeutige Bezeichner des Privaten Linkbereichs.

RequestSource

Beschreibt, welches Tool diese Application Insights-Komponente erstellt hat. Kunden, die diese API verwenden, sollten dies auf den Standard "Rest" festlegen.

Name	Typ	Beschreibung
rest	string

Freigeben über

Components - Create Or Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ComponentCreate

Beispielanforderung

Beispiel für eine Antwort

ComponentUpdate

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ApplicationInsightsComponent

ApplicationType

FlowType

IngestionMode

PrivateLinkScopedResource

RequestSource

Zusätzliche Ressourcen