Azure Native v2.89.1, Mar 2 25

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.insights.getComponent

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

Using getComponent

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getComponent(args: GetComponentArgs, opts?: InvokeOptions): Promise<GetComponentResult>
function getComponentOutput(args: GetComponentOutputArgs, opts?: InvokeOptions): Output<GetComponentResult>

def get_component(resource_group_name: Optional[str] = None,
                  resource_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetComponentResult
def get_component_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                  resource_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetComponentResult]

func LookupComponent(ctx *Context, args *LookupComponentArgs, opts ...InvokeOption) (*LookupComponentResult, error)
func LookupComponentOutput(ctx *Context, args *LookupComponentOutputArgs, opts ...InvokeOption) LookupComponentResultOutput

> Note: This function is named LookupComponent in the Go SDK.

public static class GetComponent 
{
    public static Task<GetComponentResult> InvokeAsync(GetComponentArgs args, InvokeOptions? opts = null)
    public static Output<GetComponentResult> Invoke(GetComponentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetComponentResult> getComponent(GetComponentArgs args, InvokeOptions options)
public static Output<GetComponentResult> getComponent(GetComponentArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:insights:getComponent
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group. The name is case insensitive.
ResourceName string: The name of the Application Insights component resource.

ResourceGroupName string: The name of the resource group. The name is case insensitive.
ResourceName string: The name of the Application Insights component resource.

resourceGroupName String: The name of the resource group. The name is case insensitive.
resourceName String: The name of the Application Insights component resource.

resourceGroupName string: The name of the resource group. The name is case insensitive.
resourceName string: The name of the Application Insights component resource.

resource_group_name str: The name of the resource group. The name is case insensitive.
resource_name str: The name of the Application Insights component resource.

resourceGroupName String: The name of the resource group. The name is case insensitive.
resourceName String: The name of the Application Insights component resource.

getComponent Result

The following output properties are available:

AppId string: Application Insights Unique ID for your Application.
ApplicationId string: The unique ID of your application. This field mirrors the 'Name' field and cannot be changed.
ApplicationType string: Type of application being monitored.
ConnectionString string: Application Insights component connection string.
CreationDate string: Creation Date for the Application Insights component, in ISO 8601 format.
HockeyAppToken string: Token used to authenticate communications with between Application Insights and HockeyApp.
Id string: Azure resource Id
InstrumentationKey string: 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: 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: The date which the component got migrated to LA, in ISO 8601 format.
Location string: Resource location
Name string: Azure resource name
PrivateLinkScopedResources List<Pulumi.AzureNative.Insights.Outputs.PrivateLinkScopedResourceResponse>: List of linked private link scope resources.
ProvisioningState string: 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.
TenantId string: Azure Tenant Id.
Type string: Azure resource type
DisableIpMasking bool: Disable IP masking.
DisableLocalAuth bool: Disable Non-AAD based Auth.
Etag string: Resource etag
FlowType string: 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: Force users to create their own storage account for profiler and debugger.
HockeyAppId string: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
ImmediatePurgeDataOn30Days bool: Purge data immediately after 30 days.
IngestionMode string: Indicates the flow of the ingestion.
PublicNetworkAccessForIngestion string: The network access type for accessing Application Insights ingestion.
PublicNetworkAccessForQuery string: The network access type for accessing Application Insights query.
RequestSource string: Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
RetentionInDays int: Retention period in days.
SamplingPercentage double: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
Tags Dictionary<string, string>: Resource tags
WorkspaceResourceId string: 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.

AppId string: Application Insights Unique ID for your Application.
ApplicationId string: The unique ID of your application. This field mirrors the 'Name' field and cannot be changed.
ApplicationType string: Type of application being monitored.
ConnectionString string: Application Insights component connection string.
CreationDate string: Creation Date for the Application Insights component, in ISO 8601 format.
HockeyAppToken string: Token used to authenticate communications with between Application Insights and HockeyApp.
Id string: Azure resource Id
InstrumentationKey string: 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: 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: The date which the component got migrated to LA, in ISO 8601 format.
Location string: Resource location
Name string: Azure resource name
PrivateLinkScopedResources []PrivateLinkScopedResourceResponse: List of linked private link scope resources.
ProvisioningState string: 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.
TenantId string: Azure Tenant Id.
Type string: Azure resource type
DisableIpMasking bool: Disable IP masking.
DisableLocalAuth bool: Disable Non-AAD based Auth.
Etag string: Resource etag
FlowType string: 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: Force users to create their own storage account for profiler and debugger.
HockeyAppId string: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
ImmediatePurgeDataOn30Days bool: Purge data immediately after 30 days.
IngestionMode string: Indicates the flow of the ingestion.
PublicNetworkAccessForIngestion string: The network access type for accessing Application Insights ingestion.
PublicNetworkAccessForQuery string: The network access type for accessing Application Insights query.
RequestSource string: Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
RetentionInDays int: Retention period in days.
SamplingPercentage float64: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
Tags map[string]string: Resource tags
WorkspaceResourceId string: 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.

appId String: Application Insights Unique ID for your Application.
applicationId String: The unique ID of your application. This field mirrors the 'Name' field and cannot be changed.
applicationType String: Type of application being monitored.
connectionString String: Application Insights component connection string.
creationDate String: Creation Date for the Application Insights component, in ISO 8601 format.
hockeyAppToken String: Token used to authenticate communications with between Application Insights and HockeyApp.
id String: Azure resource Id
instrumentationKey String: 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: 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: The date which the component got migrated to LA, in ISO 8601 format.
location String: Resource location
name String: Azure resource name
privateLinkScopedResources List<PrivateLinkScopedResourceResponse>: List of linked private link scope resources.
provisioningState String: 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.
tenantId String: Azure Tenant Id.
type String: Azure resource type
disableIpMasking Boolean: Disable IP masking.
disableLocalAuth Boolean: Disable Non-AAD based Auth.
etag String: Resource etag
flowType String: 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 Boolean: Force users to create their own storage account for profiler and debugger.
hockeyAppId String: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
immediatePurgeDataOn30Days Boolean: Purge data immediately after 30 days.
ingestionMode String: Indicates the flow of the ingestion.
publicNetworkAccessForIngestion String: The network access type for accessing Application Insights ingestion.
publicNetworkAccessForQuery String: The network access type for accessing Application Insights query.
requestSource String: Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
retentionInDays Integer: Retention period in days.
samplingPercentage Double: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
tags Map<String,String>: Resource tags
workspaceResourceId String: 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.

appId string: Application Insights Unique ID for your Application.
applicationId string: The unique ID of your application. This field mirrors the 'Name' field and cannot be changed.
applicationType string: Type of application being monitored.
connectionString string: Application Insights component connection string.
creationDate string: Creation Date for the Application Insights component, in ISO 8601 format.
hockeyAppToken string: Token used to authenticate communications with between Application Insights and HockeyApp.
id string: Azure resource Id
instrumentationKey string: 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: 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: The date which the component got migrated to LA, in ISO 8601 format.
location string: Resource location
name string: Azure resource name
privateLinkScopedResources PrivateLinkScopedResourceResponse[]: List of linked private link scope resources.
provisioningState string: 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.
tenantId string: Azure Tenant Id.
type string: Azure resource type
disableIpMasking boolean: Disable IP masking.
disableLocalAuth boolean: Disable Non-AAD based Auth.
etag string: Resource etag
flowType string: 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 boolean: Force users to create their own storage account for profiler and debugger.
hockeyAppId string: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
immediatePurgeDataOn30Days boolean: Purge data immediately after 30 days.
ingestionMode string: Indicates the flow of the ingestion.
publicNetworkAccessForIngestion string: The network access type for accessing Application Insights ingestion.
publicNetworkAccessForQuery string: The network access type for accessing Application Insights query.
requestSource string: Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
retentionInDays number: Retention period in days.
samplingPercentage number: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
tags {[key: string]: string}: Resource tags
workspaceResourceId string: 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.

app_id str: Application Insights Unique ID for your Application.
application_id str: The unique ID of your application. This field mirrors the 'Name' field and cannot be changed.
application_type str: Type of application being monitored.
connection_string str: Application Insights component connection string.
creation_date str: Creation Date for the Application Insights component, in ISO 8601 format.
hockey_app_token str: Token used to authenticate communications with between Application Insights and HockeyApp.
id str: Azure resource Id
instrumentation_key str: 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 str: 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.
la_migration_date str: The date which the component got migrated to LA, in ISO 8601 format.
location str: Resource location
name str: Azure resource name
private_link_scoped_resources Sequence[PrivateLinkScopedResourceResponse]: List of linked private link scope resources.
provisioning_state str: 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.
tenant_id str: Azure Tenant Id.
type str: Azure resource type
disable_ip_masking bool: Disable IP masking.
disable_local_auth bool: Disable Non-AAD based Auth.
etag str: Resource etag
flow_type str: 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.
force_customer_storage_for_profiler bool: Force users to create their own storage account for profiler and debugger.
hockey_app_id str: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
immediate_purge_data_on30_days bool: Purge data immediately after 30 days.
ingestion_mode str: Indicates the flow of the ingestion.
public_network_access_for_ingestion str: The network access type for accessing Application Insights ingestion.
public_network_access_for_query str: The network access type for accessing Application Insights query.
request_source str: Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
retention_in_days int: Retention period in days.
sampling_percentage float: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
tags Mapping[str, str]: Resource tags
workspace_resource_id str: 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.

appId String: Application Insights Unique ID for your Application.
applicationId String: The unique ID of your application. This field mirrors the 'Name' field and cannot be changed.
applicationType String: Type of application being monitored.
connectionString String: Application Insights component connection string.
creationDate String: Creation Date for the Application Insights component, in ISO 8601 format.
hockeyAppToken String: Token used to authenticate communications with between Application Insights and HockeyApp.
id String: Azure resource Id
instrumentationKey String: 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: 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: The date which the component got migrated to LA, in ISO 8601 format.
location String: Resource location
name String: Azure resource name
privateLinkScopedResources List<Property Map>: List of linked private link scope resources.
provisioningState String: 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.
tenantId String: Azure Tenant Id.
type String: Azure resource type
disableIpMasking Boolean: Disable IP masking.
disableLocalAuth Boolean: Disable Non-AAD based Auth.
etag String: Resource etag
flowType String: 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 Boolean: Force users to create their own storage account for profiler and debugger.
hockeyAppId String: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
immediatePurgeDataOn30Days Boolean: Purge data immediately after 30 days.
ingestionMode String: Indicates the flow of the ingestion.
publicNetworkAccessForIngestion String: The network access type for accessing Application Insights ingestion.
publicNetworkAccessForQuery String: The network access type for accessing Application Insights query.
requestSource String: Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
retentionInDays Number: Retention period in days.
samplingPercentage Number: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
tags Map<String>: Resource tags
workspaceResourceId String: 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.

Supporting Types

PrivateLinkScopedResourceResponse

ResourceId string: The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope.
ScopeId string: The immutableId of the Azure Monitor Private Link Scope Resource to which the association is.

ResourceId string: The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope.
ScopeId string: The immutableId of the Azure Monitor Private Link Scope Resource to which the association is.

resourceId String: The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope.
scopeId String: The immutableId of the Azure Monitor Private Link Scope Resource to which the association is.

resourceId string: The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope.
scopeId string: The immutableId of the Azure Monitor Private Link Scope Resource to which the association is.

resource_id str: The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope.
scope_id str: The immutableId of the Azure Monitor Private Link Scope Resource to which the association is.

resourceId String: The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope.
scopeId String: The immutableId of the Azure Monitor Private Link Scope Resource to which the association is.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.insights.getComponent

On this page

On this page

Using getComponent

getComponent Result

Supporting Types

PrivateLinkScopedResourceResponse

Package Details

On this page

On this page