insights.azure.com/v1api20200202
insights.azure.com/v1api20200202
Package v1api20200202 contains API Schema definitions for the insights v1api20200202 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2020-02-02" |
ApplicationInsightsComponentProperties_Application_Type
(string
alias)
(Appears on:Component_Spec)
Value | Description |
---|---|
"other" |
|
"web" |
ApplicationInsightsComponentProperties_Application_Type_STATUS
(string
alias)
(Appears on:Component_STATUS)
Value | Description |
---|---|
"other" |
|
"web" |
ApplicationInsightsComponentProperties_Flow_Type
(string
alias)
(Appears on:Component_Spec)
Value | Description |
---|---|
"Bluefield" |
ApplicationInsightsComponentProperties_Flow_Type_STATUS
(string
alias)
(Appears on:Component_STATUS)
Value | Description |
---|---|
"Bluefield" |
ApplicationInsightsComponentProperties_IngestionMode
(string
alias)
(Appears on:Component_Spec)
Value | Description |
---|---|
"ApplicationInsights" |
|
"ApplicationInsightsWithDiagnosticSettings" |
|
"LogAnalytics" |
ApplicationInsightsComponentProperties_IngestionMode_STATUS
(string
alias)
(Appears on:Component_STATUS)
Value | Description |
---|---|
"ApplicationInsights" |
|
"ApplicationInsightsWithDiagnosticSettings" |
|
"LogAnalytics" |
ApplicationInsightsComponentProperties_Request_Source
(string
alias)
(Appears on:Component_Spec)
Value | Description |
---|---|
"rest" |
ApplicationInsightsComponentProperties_Request_Source_STATUS
(string
alias)
(Appears on:Component_STATUS)
Value | Description |
---|---|
"rest" |
Component
Generator information: - Generated from: /applicationinsights/resource-manager/Microsoft.Insights/stable/2020-02-02/components_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}p>
Field | Description | ||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||||||||||||||
spec Component_Spec |
|
||||||||||||||||||||||||||||||||||||||||||
status Component_STATUS |
ComponentOperatorConfigMaps
(Appears on:ComponentOperatorSpec)
Field | Description |
---|---|
connectionString genruntime.ConfigMapDestination |
ConnectionString: indicates where the ConnectionString config map should be placed. If omitted, no config map will be created. |
instrumentationKey genruntime.ConfigMapDestination |
InstrumentationKey: indicates where the InstrumentationKey config map should be placed. If omitted, no config map will be created. |
ComponentOperatorSpec
(Appears on:Component_Spec)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Field | Description |
---|---|
configMapExpressions []genruntime/core.DestinationExpression |
ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
configMaps ComponentOperatorConfigMaps |
ConfigMaps: configures where to place operator written ConfigMaps. |
secretExpressions []genruntime/core.DestinationExpression |
SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
Component_STATUS
(Appears on:Component)
Field | Description |
---|---|
AppId string |
AppId: Application Insights Unique ID for your Application. |
ApplicationId string |
ApplicationId: The unique ID of your application. This field mirrors the ‘Name’ field and cannot be changed. |
Application_Type ApplicationInsightsComponentProperties_Application_Type_STATUS |
Application_Type: Type of application being monitored. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
ConnectionString string |
ConnectionString: Application Insights component connection string. |
CreationDate string |
CreationDate: Creation Date for the Application Insights component, in ISO 8601 format. |
DisableIpMasking bool |
DisableIpMasking: Disable IP masking. |
DisableLocalAuth bool |
DisableLocalAuth: Disable Non-AAD based Auth. |
etag string |
Etag: Resource etag |
Flow_Type ApplicationInsightsComponentProperties_Flow_Type_STATUS |
Flow_Type: Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to ‘Bluefield’ when creating/updating a component via the REST API. |
ForceCustomerStorageForProfiler bool |
ForceCustomerStorageForProfiler: Force users to create their own storage account for profiler and debugger. |
HockeyAppId string |
HockeyAppId: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp. |
HockeyAppToken string |
HockeyAppToken: Token used to authenticate communications with between Application Insights and HockeyApp. |
id string |
Id: Azure resource Id |
ImmediatePurgeDataOn30Days bool |
ImmediatePurgeDataOn30Days: Purge data immediately after 30 days. |
IngestionMode ApplicationInsightsComponentProperties_IngestionMode_STATUS |
IngestionMode: Indicates the flow of the ingestion. |
InstrumentationKey string |
InstrumentationKey: Application Insights Instrumentation key. A read-only value that applications can use to identify the destination for all telemetry sent to Azure Application Insights. This value will be supplied upon construction of each new Application Insights component. |
kind string |
Kind: The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone. |
LaMigrationDate string |
LaMigrationDate: The date which the component got migrated to LA, in ISO 8601 format. |
location string |
Location: Resource location |
name string |
Name: Azure resource name |
PrivateLinkScopedResources []PrivateLinkScopedResource_STATUS |
PrivateLinkScopedResources: List of linked private link scope resources. |
properties_name string |
PropertiesName: Application name. |
provisioningState string |
ProvisioningState: Current state of this component: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed. |
publicNetworkAccessForIngestion PublicNetworkAccessType_STATUS |
PublicNetworkAccessForIngestion: The network access type for accessing Application Insights ingestion. |
publicNetworkAccessForQuery PublicNetworkAccessType_STATUS |
PublicNetworkAccessForQuery: The network access type for accessing Application Insights query. |
Request_Source ApplicationInsightsComponentProperties_Request_Source_STATUS |
Request_Source: Describes what tool created this Application Insights component. Customers using this API should set this to the default ‘rest’. |
RetentionInDays int |
RetentionInDays: Retention period in days. |
SamplingPercentage float64 |
SamplingPercentage: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. |
tags map[string]string |
Tags: Resource tags |
TenantId string |
TenantId: Azure Tenant Id. |
type string |
Type: Azure resource type |
WorkspaceResourceId string |
WorkspaceResourceId: Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property. |
Component_Spec
(Appears on:Component)
Field | Description |
---|---|
Application_Type ApplicationInsightsComponentProperties_Application_Type |
Application_Type: Type of application being monitored. |
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
DisableIpMasking bool |
DisableIpMasking: Disable IP masking. |
DisableLocalAuth bool |
DisableLocalAuth: Disable Non-AAD based Auth. |
etag string |
Etag: Resource etag |
Flow_Type ApplicationInsightsComponentProperties_Flow_Type |
Flow_Type: Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to ‘Bluefield’ when creating/updating a component via the REST API. |
ForceCustomerStorageForProfiler bool |
ForceCustomerStorageForProfiler: Force users to create their own storage account for profiler and debugger. |
HockeyAppId string |
HockeyAppId: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp. |
ImmediatePurgeDataOn30Days bool |
ImmediatePurgeDataOn30Days: Purge data immediately after 30 days. |
IngestionMode ApplicationInsightsComponentProperties_IngestionMode |
IngestionMode: Indicates the flow of the ingestion. |
kind string |
Kind: The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone. |
location string |
Location: Resource location |
operatorSpec ComponentOperatorSpec |
OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
publicNetworkAccessForIngestion PublicNetworkAccessType |
PublicNetworkAccessForIngestion: The network access type for accessing Application Insights ingestion. |
publicNetworkAccessForQuery PublicNetworkAccessType |
PublicNetworkAccessForQuery: The network access type for accessing Application Insights query. |
Request_Source ApplicationInsightsComponentProperties_Request_Source |
Request_Source: Describes what tool created this Application Insights component. Customers using this API should set this to the default ‘rest’. |
RetentionInDays int |
RetentionInDays: Retention period in days. |
SamplingPercentage float64 |
SamplingPercentage: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry. |
tags map[string]string |
Tags: Resource tags |
workspaceResourceReference genruntime.ResourceReference |
WorkspaceResourceReference: Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property. |
PrivateLinkScopedResource_STATUS
(Appears on:Component_STATUS)
The private link scope resource reference.
Field | Description |
---|---|
ResourceId string |
ResourceId: The full resource Id of the private link scope resource. |
ScopeId string |
ScopeId: The private link scope unique Identifier. |
PublicNetworkAccessType
(string
alias)
(Appears on:Component_Spec)
The network access type for operating on the Application Insights Component. By default it is Enabled
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
PublicNetworkAccessType_STATUS
(string
alias)
(Appears on:Component_STATUS)
The network access type for operating on the Application Insights Component. By default it is Enabled
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |