Components - Create Or Update

Référence

Service:: Application Insights

Version d'API:: 2015-05-01

Crée (ou met à jour) un composant Application Insights. Remarque : Vous ne pouvez pas spécifier une valeur différente pour InstrumentationKey ou AppId dans l’opération Put.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
resourceName	path	True	string	Nom de la ressource du composant Application Insights.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
kind	True	string	Type d’application auquel ce composant fait référence, utilisé pour personnaliser l’interface utilisateur. Cette valeur est une chaîne de forme libre. Les valeurs doivent généralement être l’une des suivantes : web, ios, autre, store, java, téléphone.
location	True	string	Emplacement de la ressource
properties.Application_Type	True	ApplicationType	Type d’application surveillé.
properties.DisableIpMasking		boolean	Désactivez le masquage IP.
properties.Flow_Type		FlowType	Utilisé par le système Application Insights pour déterminer le type de flux par lequel ce composant a été créé. Cette valeur doit être définie sur « Bluefield » lors de la création/mise à jour d’un composant via l’API REST.
properties.HockeyAppId		string	ID d’application unique créé lors de l’ajout d’une application à HockeyApp, utilisé pour les communications avec HockeyApp.
properties.ImmediatePurgeDataOn30Days		boolean	Vider les données immédiatement après 30 jours.
properties.IngestionMode		IngestionMode	Indique le flux de l’ingestion.
properties.Request_Source		RequestSource	Décrit l’outil qui a créé ce composant Application Insights. Les clients qui utilisent cette API doivent définir cette valeur sur « rest » par défaut.
properties.RetentionInDays		integer	Période de rétention en jours.
properties.SamplingPercentage		number	Pourcentage des données produites par l’application surveillée et échantillonnées pour les données de télémétrie Application Insights.
tags		object	Balises de ressource

Réponses

Nom	Type	Description
200 OK	ApplicationInsightsComponent	Demande réussie lors de la création ou de la mise à jour d’un composant Application Insights. Le composant mis à jour est retourné.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

ComponentCreate

ComponentUpdate

ComponentCreate

Exemple de requête

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

Nom	Description
ApplicationInsightsComponent	Définition de composant Application Insights.
ApplicationType	Type d’application surveillé.
FlowType	Utilisé par le système Application Insights pour déterminer le type de flux par lequel ce composant a été créé. Cette valeur doit être définie sur « Bluefield » lors de la création/mise à jour d’un composant via l’API REST.
IngestionMode	Indique le flux de l’ingestion.
PrivateLinkScopedResource	Référence de ressource d’étendue de liaison privée.
RequestSource	Décrit l’outil qui a créé ce composant Application Insights. Les clients qui utilisent cette API doivent définir cette valeur sur « rest » par défaut.

ApplicationInsightsComponent

Définition de composant Application Insights.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource Azure
kind	string		Type d’application auquel ce composant fait référence, utilisé pour personnaliser l’interface utilisateur. Cette valeur est une chaîne de forme libre. Les valeurs doivent généralement être l’une des suivantes : web, ios, autre, store, java, téléphone.
location	string		Emplacement de la ressource
name	string		Nom de la ressource Azure
properties.AppId	string		ID unique Application Insights pour votre application.
properties.ApplicationId	string		ID unique de votre application. Ce champ reflète le champ « Nom » et ne peut pas être modifié.
properties.Application_Type	ApplicationType	web	Type d’application surveillé.
properties.ConnectionString	string		Chaîne de connexion du composant Application Insights.
properties.CreationDate	string		Date de création du composant Application Insights, au format ISO 8601.
properties.DisableIpMasking	boolean		Désactivez le masquage IP.
properties.Flow_Type	FlowType	Bluefield	Utilisé par le système Application Insights pour déterminer le type de flux par lequel ce composant a été créé. Cette valeur doit être définie sur « Bluefield » lors de la création/mise à jour d’un composant via l’API REST.
properties.HockeyAppId	string		ID d’application unique créé lors de l’ajout d’une application à HockeyApp, utilisé pour les communications avec HockeyApp.
properties.HockeyAppToken	string		Jeton utilisé pour authentifier les communications avec Application Insights et HockeyApp.
properties.ImmediatePurgeDataOn30Days	boolean		Vider les données immédiatement après 30 jours.
properties.IngestionMode	IngestionMode	ApplicationInsights	Indique le flux de l’ingestion.
properties.InstrumentationKey	string		Clé d’instrumentation Application Insights. Valeur en lecture seule que les applications peuvent utiliser pour identifier la destination de toutes les données de télémétrie envoyées à Azure Application Insights. Cette valeur sera fournie lors de la construction de chaque nouveau composant Application Insights.
properties.PrivateLinkScopedResources	PrivateLinkScopedResource[]		Liste des ressources d’étendue de liaison privée liées.
properties.Request_Source	RequestSource	rest	Décrit l’outil qui a créé ce composant Application Insights. Les clients qui utilisent cette API doivent définir cette valeur sur « rest » par défaut.
properties.RetentionInDays	integer	90	Période de rétention en jours.
properties.SamplingPercentage	number		Pourcentage des données produites par l’application surveillée et échantillonnées pour les données de télémétrie Application Insights.
properties.TenantId	string		ID de locataire Azure.
properties.provisioningState	string		État actuel de ce composant : indique si a été provisionné ou non dans le groupe de ressources qu’il est défini. Les utilisateurs ne peuvent pas modifier cette valeur, mais peuvent la lire. Les valeurs incluent Réussi, Déploiement, Annulé et Échec.
tags	object		Balises de ressource
type	string		Type de ressource Azure

ApplicationType

Type d’application surveillé.

Nom	Type	Description
other	string
web	string

FlowType

Utilisé par le système Application Insights pour déterminer le type de flux par lequel ce composant a été créé. Cette valeur doit être définie sur « Bluefield » lors de la création/mise à jour d’un composant via l’API REST.

Nom	Type	Description
Bluefield	string

IngestionMode

Indique le flux de l’ingestion.

Nom	Type	Description
ApplicationInsights	string
ApplicationInsightsWithDiagnosticSettings	string
LogAnalytics	string

PrivateLinkScopedResource

Référence de ressource d’étendue de liaison privée.

Nom	Type	Description
ResourceId	string	ID de ressource complet de la ressource d’étendue de liaison privée.
ScopeId	string	Identificateur unique d’étendue de liaison privée.

RequestSource

Décrit l’outil qui a créé ce composant Application Insights. Les clients qui utilisent cette API doivent définir cette valeur sur « rest » par défaut.

Nom	Type	Description
rest	string

Partager via

Components - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

ComponentCreate

Exemple de requête

Exemple de réponse

ComponentUpdate

Exemple de requête

Exemple de réponse

Définitions

ApplicationInsightsComponent

ApplicationType

FlowType

IngestionMode

PrivateLinkScopedResource

RequestSource

Ressources supplémentaires