insights.azure.com/v1api20230311
APIVersion
| Value | Description |
|---|---|
| “2023-03-11” |
DataCollectionEndpoint
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/dataCollectionEndpoints_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}
Used by: DataCollectionEndpointList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | DataCollectionEndpoint_Spec Optional |
|
| status | DataCollectionEndpointResource_STATUS Optional |
DataCollectionEndpoint_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| description | Description of the data collection endpoint. | string Optional |
| identity | Managed service identity of the resource. | ManagedServiceIdentity Optional |
| kind | The kind of the resource. | DataCollectionEndpoint_Kind_Spec Optional |
| location | The geo-location where the resource lives. | string Required |
| networkAcls | Network access control rules for the endpoints. | NetworkRuleSet Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DataCollectionEndpointOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
DataCollectionEndpointResource_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| configurationAccess | The endpoint used by clients to access their configuration. | ConfigurationAccessEndpointSpec_STATUS Optional |
| description | Description of the data collection endpoint. | string Optional |
| etag | Resource entity tag (ETag). | string Optional |
| failoverConfiguration | Failover configuration on this endpoint. This property is READ-ONLY. | FailoverConfigurationSpec_STATUS Optional |
| id | Fully qualified ID of the resource. | string Optional |
| identity | Managed service identity of the resource. | ManagedServiceIdentity_STATUS Optional |
| immutableId | The immutable ID of this data collection endpoint resource. This property is READ-ONLY. | string Optional |
| kind | The kind of the resource. | DataCollectionEndpointResource_Kind_STATUS Optional |
| location | The geo-location where the resource lives. | string Optional |
| logsIngestion | The endpoint used by clients to ingest logs. | LogsIngestionEndpointSpec_STATUS Optional |
| metadata | Metadata for the resource. This property is READ-ONLY. | Metadata_STATUS Optional |
| metricsIngestion | The endpoint used by clients to ingest metrics. | MetricsIngestionEndpointSpec_STATUS Optional |
| name | The name of the resource. | string Optional |
| networkAcls | Network access control rules for the endpoints. | NetworkRuleSet_STATUS Optional |
| privateLinkScopedResources | List of Azure Monitor Private Link Scope Resources to which this data collection endpoint resource is associated. This property is READ-ONLY. | PrivateLinkScopedResource_STATUS[] Optional |
| provisioningState | The resource provisioning state. This property is READ-ONLY. | DataCollectionEndpoint_ProvisioningState_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. | string Optional |
DataCollectionEndpointList
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/dataCollectionEndpoints_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionEndpoints/{dataCollectionEndpointName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | DataCollectionEndpoint[] Optional |
DataCollectionRule
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/dataCollectionRules_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}
Used by: DataCollectionRuleList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | DataCollectionRule_Spec Optional |
|
| status | DataCollectionRuleResource_STATUS Optional |
DataCollectionRule_Spec
| Property | Description | Type |
|---|---|---|
| agentSettings | Agent settings used to modify agent behavior on a given host | AgentSettingsSpec Optional |
| 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. | string Optional |
| dataCollectionEndpointReference | The resource ID of the data collection endpoint that this rule can be used with. | genruntime.ResourceReference Optional |
| dataFlows | The specification of data flows. | DataFlow[] Optional |
| dataSources | The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. | DataSourcesSpec Optional |
| description | Description of the data collection rule. | string Optional |
| destinations | The specification of destinations. | DestinationsSpec Optional |
| identity | Managed service identity of the resource. | ManagedServiceIdentity Optional |
| kind | The kind of the resource. | DataCollectionRule_Kind_Spec Optional |
| location | The geo-location where the resource lives. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DataCollectionRuleOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| references | Defines all the references that may be used in other sections of the DCR | ReferencesSpec Optional |
| streamDeclarations | Declaration of custom streams used in this rule. | map[string]StreamDeclaration Optional |
| tags | Resource tags. | map[string]string Optional |
DataCollectionRuleResource_STATUS
| Property | Description | Type |
|---|---|---|
| agentSettings | Agent settings used to modify agent behavior on a given host | AgentSettingsSpec_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataCollectionEndpointId | The resource ID of the data collection endpoint that this rule can be used with. | string Optional |
| dataFlows | The specification of data flows. | DataFlow_STATUS[] Optional |
| dataSources | The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. | DataSourcesSpec_STATUS Optional |
| description | Description of the data collection rule. | string Optional |
| destinations | The specification of destinations. | DestinationsSpec_STATUS Optional |
| endpoints | Defines the ingestion endpoints to send data to via this rule. | EndpointsSpec_STATUS Optional |
| etag | Resource entity tag (ETag). | string Optional |
| id | Fully qualified ID of the resource. | string Optional |
| identity | Managed service identity of the resource. | ManagedServiceIdentity_STATUS Optional |
| immutableId | The immutable ID of this data collection rule. This property is READ-ONLY. | string Optional |
| kind | The kind of the resource. | DataCollectionRuleResource_Kind_STATUS Optional |
| location | The geo-location where the resource lives. | string Optional |
| metadata | Metadata about the resource | Metadata_STATUS Optional |
| name | The name of the resource. | string Optional |
| provisioningState | The resource provisioning state. | DataCollectionRule_ProvisioningState_STATUS Optional |
| references | Defines all the references that may be used in other sections of the DCR | ReferencesSpec_STATUS Optional |
| streamDeclarations | Declaration of custom streams used in this rule. | map[string]StreamDeclaration_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. | string Optional |
DataCollectionRuleAssociation
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/dataCollectionRuleAssociations_API.json - ARM URI: /{resourceUri}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{associationName}
Used by: DataCollectionRuleAssociationList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | DataCollectionRuleAssociation_Spec Optional |
|
| status | DataCollectionRuleAssociationProxyOnlyResource_STATUS Optional |
DataCollectionRuleAssociation_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| dataCollectionEndpointReference | The resource ID of the data collection endpoint that is to be associated. | genruntime.ResourceReference Optional |
| dataCollectionRuleReference | The resource ID of the data collection rule that is to be associated. | genruntime.ResourceReference Optional |
| description | Description of the association. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DataCollectionRuleAssociationOperatorSpec Optional |
| 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. This resource is an extension resource, which means that any other Azure resource can be its owner. | genruntime.ArbitraryOwnerReference Required |
DataCollectionRuleAssociationProxyOnlyResource_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataCollectionEndpointId | The resource ID of the data collection endpoint that is to be associated. | string Optional |
| dataCollectionRuleId | The resource ID of the data collection rule that is to be associated. | string Optional |
| description | Description of the association. | string Optional |
| etag | Resource entity tag (ETag). | string Optional |
| id | Fully qualified ID of the resource. | string Optional |
| metadata | Metadata about the resource | Metadata_STATUS Optional |
| name | The name of the resource. | string Optional |
| provisioningState | The resource provisioning state. | DataCollectionRuleAssociation_ProvisioningState_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| type | The type of the resource. | string Optional |
DataCollectionRuleAssociationList
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/dataCollectionRuleAssociations_API.json - ARM URI: /{resourceUri}/providers/Microsoft.Insights/dataCollectionRuleAssociations/{associationName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | DataCollectionRuleAssociation[] Optional |
DataCollectionRuleList
Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2023-03-11/dataCollectionRules_API.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | DataCollectionRule[] Optional |
DataCollectionEndpoint_Spec
Used by: DataCollectionEndpoint.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| description | Description of the data collection endpoint. | string Optional |
| identity | Managed service identity of the resource. | ManagedServiceIdentity Optional |
| kind | The kind of the resource. | DataCollectionEndpoint_Kind_Spec Optional |
| location | The geo-location where the resource lives. | string Required |
| networkAcls | Network access control rules for the endpoints. | NetworkRuleSet Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DataCollectionEndpointOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| tags | Resource tags. | map[string]string Optional |
DataCollectionEndpointResource_STATUS
Definition of ARM tracked top level resource.
Used by: DataCollectionEndpoint.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| configurationAccess | The endpoint used by clients to access their configuration. | ConfigurationAccessEndpointSpec_STATUS Optional |
| description | Description of the data collection endpoint. | string Optional |
| etag | Resource entity tag (ETag). | string Optional |
| failoverConfiguration | Failover configuration on this endpoint. This property is READ-ONLY. | FailoverConfigurationSpec_STATUS Optional |
| id | Fully qualified ID of the resource. | string Optional |
| identity | Managed service identity of the resource. | ManagedServiceIdentity_STATUS Optional |
| immutableId | The immutable ID of this data collection endpoint resource. This property is READ-ONLY. | string Optional |
| kind | The kind of the resource. | DataCollectionEndpointResource_Kind_STATUS Optional |
| location | The geo-location where the resource lives. | string Optional |
| logsIngestion | The endpoint used by clients to ingest logs. | LogsIngestionEndpointSpec_STATUS Optional |
| metadata | Metadata for the resource. This property is READ-ONLY. | Metadata_STATUS Optional |
| metricsIngestion | The endpoint used by clients to ingest metrics. | MetricsIngestionEndpointSpec_STATUS Optional |
| name | The name of the resource. | string Optional |
| networkAcls | Network access control rules for the endpoints. | NetworkRuleSet_STATUS Optional |
| privateLinkScopedResources | List of Azure Monitor Private Link Scope Resources to which this data collection endpoint resource is associated. This property is READ-ONLY. | PrivateLinkScopedResource_STATUS[] Optional |
| provisioningState | The resource provisioning state. This property is READ-ONLY. | DataCollectionEndpoint_ProvisioningState_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. | string Optional |
DataCollectionRule_Spec
Used by: DataCollectionRule.
| Property | Description | Type |
|---|---|---|
| agentSettings | Agent settings used to modify agent behavior on a given host | AgentSettingsSpec Optional |
| 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. | string Optional |
| dataCollectionEndpointReference | The resource ID of the data collection endpoint that this rule can be used with. | genruntime.ResourceReference Optional |
| dataFlows | The specification of data flows. | DataFlow[] Optional |
| dataSources | The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. | DataSourcesSpec Optional |
| description | Description of the data collection rule. | string Optional |
| destinations | The specification of destinations. | DestinationsSpec Optional |
| identity | Managed service identity of the resource. | ManagedServiceIdentity Optional |
| kind | The kind of the resource. | DataCollectionRule_Kind_Spec Optional |
| location | The geo-location where the resource lives. | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DataCollectionRuleOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| references | Defines all the references that may be used in other sections of the DCR | ReferencesSpec Optional |
| streamDeclarations | Declaration of custom streams used in this rule. | map[string]StreamDeclaration Optional |
| tags | Resource tags. | map[string]string Optional |
DataCollectionRuleAssociation_Spec
Used by: DataCollectionRuleAssociation.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| dataCollectionEndpointReference | The resource ID of the data collection endpoint that is to be associated. | genruntime.ResourceReference Optional |
| dataCollectionRuleReference | The resource ID of the data collection rule that is to be associated. | genruntime.ResourceReference Optional |
| description | Description of the association. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | DataCollectionRuleAssociationOperatorSpec Optional |
| 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. This resource is an extension resource, which means that any other Azure resource can be its owner. | genruntime.ArbitraryOwnerReference Required |
DataCollectionRuleAssociationProxyOnlyResource_STATUS
Definition of generic ARM proxy resource.
Used by: DataCollectionRuleAssociation.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataCollectionEndpointId | The resource ID of the data collection endpoint that is to be associated. | string Optional |
| dataCollectionRuleId | The resource ID of the data collection rule that is to be associated. | string Optional |
| description | Description of the association. | string Optional |
| etag | Resource entity tag (ETag). | string Optional |
| id | Fully qualified ID of the resource. | string Optional |
| metadata | Metadata about the resource | Metadata_STATUS Optional |
| name | The name of the resource. | string Optional |
| provisioningState | The resource provisioning state. | DataCollectionRuleAssociation_ProvisioningState_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| type | The type of the resource. | string Optional |
DataCollectionRuleResource_STATUS
Definition of ARM tracked top level resource.
Used by: DataCollectionRule.
| Property | Description | Type |
|---|---|---|
| agentSettings | Agent settings used to modify agent behavior on a given host | AgentSettingsSpec_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| dataCollectionEndpointId | The resource ID of the data collection endpoint that this rule can be used with. | string Optional |
| dataFlows | The specification of data flows. | DataFlow_STATUS[] Optional |
| dataSources | The specification of data sources. This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. | DataSourcesSpec_STATUS Optional |
| description | Description of the data collection rule. | string Optional |
| destinations | The specification of destinations. | DestinationsSpec_STATUS Optional |
| endpoints | Defines the ingestion endpoints to send data to via this rule. | EndpointsSpec_STATUS Optional |
| etag | Resource entity tag (ETag). | string Optional |
| id | Fully qualified ID of the resource. | string Optional |
| identity | Managed service identity of the resource. | ManagedServiceIdentity_STATUS Optional |
| immutableId | The immutable ID of this data collection rule. This property is READ-ONLY. | string Optional |
| kind | The kind of the resource. | DataCollectionRuleResource_Kind_STATUS Optional |
| location | The geo-location where the resource lives. | string Optional |
| metadata | Metadata about the resource | Metadata_STATUS Optional |
| name | The name of the resource. | string Optional |
| provisioningState | The resource provisioning state. | DataCollectionRule_ProvisioningState_STATUS Optional |
| references | Defines all the references that may be used in other sections of the DCR | ReferencesSpec_STATUS Optional |
| streamDeclarations | Declaration of custom streams used in this rule. | map[string]StreamDeclaration_STATUS Optional |
| systemData | Metadata pertaining to creation and last modification of the resource. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. | string Optional |
AgentSettingsSpec
An agent setting
Used by: DataCollectionRule_Spec.
| Property | Description | Type |
|---|---|---|
| logs | All the settings that are applicable to the logs agent (AMA) | AgentSetting[] Optional |
AgentSettingsSpec_STATUS
An agent setting
Used by: DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| logs | All the settings that are applicable to the logs agent (AMA) | AgentSetting_STATUS[] Optional |
ConfigurationAccessEndpointSpec_STATUS
Definition of the endpoint used for accessing configuration.
Used by: DataCollectionEndpointResource_STATUS.
| Property | Description | Type |
|---|---|---|
| endpoint | The endpoint. This property is READ-ONLY. | string Optional |
DataCollectionEndpoint_Kind_Spec
Used by: DataCollectionEndpoint_Spec.
| Value | Description |
|---|---|
| “Linux” | |
| “Windows” |
DataCollectionEndpoint_ProvisioningState_STATUS
Used by: DataCollectionEndpointResource_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
DataCollectionEndpointOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: DataCollectionEndpoint_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
DataCollectionEndpointResource_Kind_STATUS
Used by: DataCollectionEndpointResource_STATUS.
| Value | Description |
|---|---|
| “Linux” | |
| “Windows” |
DataCollectionRule_Kind_Spec
Used by: DataCollectionRule_Spec.
| Value | Description |
|---|---|
| “Linux” | |
| “Windows” |
DataCollectionRule_ProvisioningState_STATUS
Used by: DataCollectionRuleResource_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
DataCollectionRuleAssociation_ProvisioningState_STATUS
Used by: DataCollectionRuleAssociationProxyOnlyResource_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
DataCollectionRuleAssociationOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: DataCollectionRuleAssociation_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
DataCollectionRuleOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: DataCollectionRule_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
DataCollectionRuleResource_Kind_STATUS
Used by: DataCollectionRuleResource_STATUS.
| Value | Description |
|---|---|
| “Linux” | |
| “Windows” |
DataFlow
Definition of which streams are sent to which destinations.
Used by: DataCollectionRule_Spec.
| Property | Description | Type |
|---|---|---|
| builtInTransform | The builtIn transform to transform stream data | string Optional |
| captureOverflow | Flag to enable overflow column in LA destinations | bool Optional |
| destinations | List of destinations for this data flow. | string[] Optional |
| outputStream | The output stream of the transform. Only required if the transform changes data to a different stream. | string Optional |
| streams | List of streams for this data flow. | DataFlow_Streams[] Optional |
| transformKql | The KQL query to transform stream data. | string Optional |
DataFlow_STATUS
Definition of which streams are sent to which destinations.
Used by: DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| builtInTransform | The builtIn transform to transform stream data | string Optional |
| captureOverflow | Flag to enable overflow column in LA destinations | bool Optional |
| destinations | List of destinations for this data flow. | string[] Optional |
| outputStream | The output stream of the transform. Only required if the transform changes data to a different stream. | string Optional |
| streams | List of streams for this data flow. | DataFlow_Streams_STATUS[] Optional |
| transformKql | The KQL query to transform stream data. | string Optional |
DataSourcesSpec
Specification of data sources that will be collected.
Used by: DataCollectionRule_Spec.
| Property | Description | Type |
|---|---|---|
| dataImports | Specifications of pull based data sources | DataImportSources Optional |
| extensions | The list of Azure VM extension data source configurations. | ExtensionDataSource[] Optional |
| iisLogs | The list of IIS logs source configurations. | IisLogsDataSource[] Optional |
| logFiles | The list of Log files source configurations. | LogFilesDataSource[] Optional |
| performanceCounters | The list of performance counter data source configurations. | PerfCounterDataSource[] Optional |
| platformTelemetry | The list of platform telemetry configurations | PlatformTelemetryDataSource[] Optional |
| prometheusForwarder | The list of Prometheus forwarder data source configurations. | PrometheusForwarderDataSource[] Optional |
| syslog | The list of Syslog data source configurations. | SyslogDataSource[] Optional |
| windowsEventLogs | The list of Windows Event Log data source configurations. | WindowsEventLogDataSource[] Optional |
| windowsFirewallLogs | The list of Windows Firewall logs source configurations. | WindowsFirewallLogsDataSource[] Optional |
DataSourcesSpec_STATUS
Specification of data sources that will be collected.
Used by: DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| dataImports | Specifications of pull based data sources | DataImportSources_STATUS Optional |
| extensions | The list of Azure VM extension data source configurations. | ExtensionDataSource_STATUS[] Optional |
| iisLogs | The list of IIS logs source configurations. | IisLogsDataSource_STATUS[] Optional |
| logFiles | The list of Log files source configurations. | LogFilesDataSource_STATUS[] Optional |
| performanceCounters | The list of performance counter data source configurations. | PerfCounterDataSource_STATUS[] Optional |
| platformTelemetry | The list of platform telemetry configurations | PlatformTelemetryDataSource_STATUS[] Optional |
| prometheusForwarder | The list of Prometheus forwarder data source configurations. | PrometheusForwarderDataSource_STATUS[] Optional |
| syslog | The list of Syslog data source configurations. | SyslogDataSource_STATUS[] Optional |
| windowsEventLogs | The list of Windows Event Log data source configurations. | WindowsEventLogDataSource_STATUS[] Optional |
| windowsFirewallLogs | The list of Windows Firewall logs source configurations. | WindowsFirewallLogsDataSource_STATUS[] Optional |
DestinationsSpec
Specification of destinations that can be used in data flows.
Used by: DataCollectionRule_Spec.
| Property | Description | Type |
|---|---|---|
| azureDataExplorer | List of Azure Data Explorer destinations. | AdxDestination[] Optional |
| azureMonitorMetrics | Azure Monitor Metrics destination. | AzureMonitorMetricsDestination Optional |
| eventHubs | List of Event Hubs destinations. | EventHubDestination[] Optional |
| eventHubsDirect | List of Event Hubs Direct destinations. | EventHubDirectDestination[] Optional |
| logAnalytics | List of Log Analytics destinations. | LogAnalyticsDestination[] Optional |
| microsoftFabric | List of Microsoft Fabric destinations. | MicrosoftFabricDestination[] Optional |
| monitoringAccounts | List of monitoring account destinations. | MonitoringAccountDestination[] Optional |
| storageAccounts | List of storage accounts destinations. | StorageBlobDestination[] Optional |
| storageBlobsDirect | List of Storage Blob Direct destinations. To be used only for sending data directly to store from the agent. | StorageBlobDestination[] Optional |
| storageTablesDirect | List of Storage Table Direct destinations. | StorageTableDestination[] Optional |
DestinationsSpec_STATUS
Specification of destinations that can be used in data flows.
Used by: DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| azureDataExplorer | List of Azure Data Explorer destinations. | AdxDestination_STATUS[] Optional |
| azureMonitorMetrics | Azure Monitor Metrics destination. | AzureMonitorMetricsDestination_STATUS Optional |
| eventHubs | List of Event Hubs destinations. | EventHubDestination_STATUS[] Optional |
| eventHubsDirect | List of Event Hubs Direct destinations. | EventHubDirectDestination_STATUS[] Optional |
| logAnalytics | List of Log Analytics destinations. | LogAnalyticsDestination_STATUS[] Optional |
| microsoftFabric | List of Microsoft Fabric destinations. | MicrosoftFabricDestination_STATUS[] Optional |
| monitoringAccounts | List of monitoring account destinations. | MonitoringAccountDestination_STATUS[] Optional |
| storageAccounts | List of storage accounts destinations. | StorageBlobDestination_STATUS[] Optional |
| storageBlobsDirect | List of Storage Blob Direct destinations. To be used only for sending data directly to store from the agent. | StorageBlobDestination_STATUS[] Optional |
| storageTablesDirect | List of Storage Table Direct destinations. | StorageTableDestination_STATUS[] Optional |
EndpointsSpec_STATUS
This defines all the ingestion endpoints that can be used by this rule
Used by: DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| logsIngestion | The ingestion endpoint for logs | string Optional |
| metricsIngestion | The ingestion endpoint for metrics | string Optional |
FailoverConfigurationSpec_STATUS
Used by: DataCollectionEndpointResource_STATUS.
| Property | Description | Type |
|---|---|---|
| activeLocation | Active location where data flow will occur. | string Optional |
| locations | Locations that are configured for failover. | LocationSpec_STATUS[] Optional |
LogsIngestionEndpointSpec_STATUS
Definition of the endpoint used for ingesting logs.
Used by: DataCollectionEndpointResource_STATUS.
| Property | Description | Type |
|---|---|---|
| endpoint | The endpoint. This property is READ-ONLY. | string Optional |
ManagedServiceIdentity
Managed service identity (system assigned and/or user assigned identities)
Used by: DataCollectionEndpoint_Spec, and DataCollectionRule_Spec.
| Property | Description | Type |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType Required |
| userAssignedIdentities | UserAssignedIdentityDetails[] Optional |
ManagedServiceIdentity_STATUS
Managed service identity (system assigned and/or user assigned identities)
Used by: DataCollectionEndpointResource_STATUS, and DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| tenantId | The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. | string Optional |
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | ManagedServiceIdentityType_STATUS Optional |
| userAssignedIdentities | map[string]UserAssignedIdentity_STATUS Optional |
Metadata_STATUS
Metadata about the resource
Used by: DataCollectionEndpointResource_STATUS, DataCollectionRuleAssociationProxyOnlyResource_STATUS, and DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| provisionedBy | Azure offering managing this resource on-behalf-of customer. | string Optional |
| provisionedByImmutableId | Immutable Id of azure offering managing this resource on-behalf-of customer. | string Optional |
| provisionedByResourceId | Resource Id of azure offering managing this resource on-behalf-of customer. | string Optional |
MetricsIngestionEndpointSpec_STATUS
Definition of the endpoint used for ingesting metrics.
Used by: DataCollectionEndpointResource_STATUS.
| Property | Description | Type |
|---|---|---|
| endpoint | The endpoint. This property is READ-ONLY. | string Optional |
NetworkRuleSet
Definition of the network rules.
Used by: DataCollectionEndpoint_Spec.
| Property | Description | Type |
|---|---|---|
| publicNetworkAccess | The configuration to set whether network access from public internet to the endpoints are allowed. | NetworkRuleSet_PublicNetworkAccess Optional |
NetworkRuleSet_STATUS
Definition of the network rules.
Used by: DataCollectionEndpointResource_STATUS.
| Property | Description | Type |
|---|---|---|
| publicNetworkAccess | The configuration to set whether network access from public internet to the endpoints are allowed. | NetworkRuleSet_PublicNetworkAccess_STATUS Optional |
PrivateLinkScopedResource_STATUS
Used by: DataCollectionEndpointResource_STATUS.
| Property | Description | Type |
|---|---|---|
| resourceId | The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope. | string Optional |
| scopeId | The immutableId of the Azure Monitor Private Link Scope Resource to which the association is. | string Optional |
ReferencesSpec
This section defines all the references that may be used in other sections of the DCR
Used by: DataCollectionRule_Spec.
| Property | Description | Type |
|---|---|---|
| enrichmentData | All the enrichment data sources referenced in data flows | EnrichmentData Optional |
ReferencesSpec_STATUS
This section defines all the references that may be used in other sections of the DCR
Used by: DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| enrichmentData | All the enrichment data sources referenced in data flows | EnrichmentData_STATUS Optional |
StreamDeclaration
Declaration of a custom stream.
Used by: DataCollectionRule_Spec.
| Property | Description | Type |
|---|---|---|
| columns | List of columns used by data in this stream. | ColumnDefinition[] Optional |
StreamDeclaration_STATUS
Declaration of a custom stream.
Used by: DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| columns | List of columns used by data in this stream. | ColumnDefinition_STATUS[] Optional |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: DataCollectionEndpointResource_STATUS, DataCollectionRuleAssociationProxyOnlyResource_STATUS, and DataCollectionRuleResource_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
AdxDestination
Azure Data Explorer (Adx) destination.
Used by: DestinationsSpec.
| Property | Description | Type |
|---|---|---|
| databaseName | The name of the database to which data will be ingested. | string Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| resourceReference | The ARM resource id of the Adx resource. | genruntime.ResourceReference Optional |
AdxDestination_STATUS
Azure Data Explorer (Adx) destination.
Used by: DestinationsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| databaseName | The name of the database to which data will be ingested. | string Optional |
| ingestionUri | The ingestion uri of the Adx resource. | string Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| resourceId | The ARM resource id of the Adx resource. | string Optional |
AgentSetting
A setting used to control an agent behavior on a host machine
Used by: AgentSettingsSpec.
| Property | Description | Type |
|---|---|---|
| name | The name of the setting. Must be part of the list of supported settings | AgentSetting_Name Optional |
| value | The value of the setting | string Optional |
AgentSetting_STATUS
A setting used to control an agent behavior on a host machine
Used by: AgentSettingsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| name | The name of the setting. Must be part of the list of supported settings | AgentSetting_Name_STATUS Optional |
| value | The value of the setting | string Optional |
AzureMonitorMetricsDestination
Azure Monitor Metrics destination.
Used by: DestinationsSpec.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
AzureMonitorMetricsDestination_STATUS
Azure Monitor Metrics destination.
Used by: DestinationsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
ColumnDefinition
Definition of custom data column.
Used by: StreamDeclaration.
| Property | Description | Type |
|---|---|---|
| name | The name of the column. | string Optional |
| type | The type of the column data. | ColumnDefinition_Type Optional |
ColumnDefinition_STATUS
Definition of custom data column.
Used by: StreamDeclaration_STATUS.
| Property | Description | Type |
|---|---|---|
| name | The name of the column. | string Optional |
| type | The type of the column data. | ColumnDefinition_Type_STATUS Optional |
DataFlow_Streams
Used by: DataFlow.
| Value | Description |
|---|---|
| “Microsoft-Event” | |
| “Microsoft-InsightsMetrics” | |
| “Microsoft-Perf” | |
| “Microsoft-Syslog” | |
| “Microsoft-WindowsEvent” |
DataFlow_Streams_STATUS
Used by: DataFlow_STATUS.
| Value | Description |
|---|---|
| “Microsoft-Event” | |
| “Microsoft-InsightsMetrics” | |
| “Microsoft-Perf” | |
| “Microsoft-Syslog” | |
| “Microsoft-WindowsEvent” |
DataImportSources
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| eventHub | Definition of Event Hub configuration. | EventHubDataSource Optional |
DataImportSources_STATUS
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| eventHub | Definition of Event Hub configuration. | EventHubDataSource_STATUS Optional |
EnrichmentData
All the enrichment data sources referenced in data flows
Used by: ReferencesSpec.
| Property | Description | Type |
|---|---|---|
| storageBlobs | All the storage blobs used as enrichment data sources | StorageBlob[] Optional |
EnrichmentData_STATUS
All the enrichment data sources referenced in data flows
Used by: ReferencesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| storageBlobs | All the storage blobs used as enrichment data sources | StorageBlob_STATUS[] Optional |
EventHubDestination
Used by: DestinationsSpec.
| Property | Description | Type |
|---|---|---|
| eventHubResourceReference | The resource ID of the event hub. | genruntime.ResourceReference Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
EventHubDestination_STATUS
Used by: DestinationsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| eventHubResourceId | The resource ID of the event hub. | string Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
EventHubDirectDestination
Used by: DestinationsSpec.
| Property | Description | Type |
|---|---|---|
| eventHubResourceReference | The resource ID of the event hub. | genruntime.ResourceReference Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
EventHubDirectDestination_STATUS
Used by: DestinationsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| eventHubResourceId | The resource ID of the event hub. | string Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
ExtensionDataSource
Definition of which data will be collected from a separate VM extension that integrates with the Azure Monitor Agent. Collected from either Windows and Linux machines, depending on which extension is defined.
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| extensionName | The name of the VM extension. | string Required |
| extensionSettings | The extension settings. The format is specific for particular extension. | map[string]v1.JSON Optional |
| inputDataSources | The list of data sources this extension needs data from. | string[] Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. | ExtensionDataSource_Streams[] Optional |
ExtensionDataSource_STATUS
Definition of which data will be collected from a separate VM extension that integrates with the Azure Monitor Agent. Collected from either Windows and Linux machines, depending on which extension is defined.
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| extensionName | The name of the VM extension. | string Optional |
| extensionSettings | The extension settings. The format is specific for particular extension. | map[string]v1.JSON Optional |
| inputDataSources | The list of data sources this extension needs data from. | string[] Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. | ExtensionDataSource_Streams_STATUS[] Optional |
IisLogsDataSource
Enables IIS logs to be collected by this data collection rule.
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| logDirectories | Absolute paths file location | string[] Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | IIS streams | string[] Required |
| transformKql | The KQL query to transform the data source. | string Optional |
IisLogsDataSource_STATUS
Enables IIS logs to be collected by this data collection rule.
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| logDirectories | Absolute paths file location | string[] Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | IIS streams | string[] Optional |
| transformKql | The KQL query to transform the data source. | string Optional |
LocationSpec_STATUS
Used by: FailoverConfigurationSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| location | Name of location. | string Optional |
| provisioningStatus | The resource provisioning state in this location. | LocationSpec_ProvisioningStatus_STATUS Optional |
LogAnalyticsDestination
Log Analytics destination.
Used by: DestinationsSpec.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| workspaceResourceReference | The resource ID of the Log Analytics workspace. | genruntime.ResourceReference Optional |
LogAnalyticsDestination_STATUS
Log Analytics destination.
Used by: DestinationsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| workspaceId | The Customer ID of the Log Analytics workspace. | string Optional |
| workspaceResourceId | The resource ID of the Log Analytics workspace. | string Optional |
LogFilesDataSource
Definition of which custom log files will be collected by this data collection rule
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| filePatterns | File Patterns where the log files are located | string[] Required |
| format | The data format of the log files | LogFilesDataSource_Format Required |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| settings | The log files specific settings. | LogFileSettings Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data source | string[] Required |
| transformKql | The KQL query to transform the data source. | string Optional |
LogFilesDataSource_STATUS
Definition of which custom log files will be collected by this data collection rule
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| filePatterns | File Patterns where the log files are located | string[] Optional |
| format | The data format of the log files | LogFilesDataSource_Format_STATUS Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| settings | The log files specific settings. | LogFileSettings_STATUS Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data source | string[] Optional |
| transformKql | The KQL query to transform the data source. | string Optional |
ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
ManagedServiceIdentityType_STATUS
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
Used by: ManagedServiceIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned,UserAssigned” | |
| “UserAssigned” |
MicrosoftFabricDestination
Microsoft Fabric destination (non-Azure).
Used by: DestinationsSpec.
| Property | Description | Type |
|---|---|---|
| artifactId | The artifact id of the Microsoft Fabric resource. | string Optional |
| databaseName | The name of the database to which data will be ingested. | string Optional |
| ingestionUri | The ingestion uri of the Microsoft Fabric resource. | string Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| tenantId | The tenant id of the Microsoft Fabric resource. | string Optional |
MicrosoftFabricDestination_STATUS
Microsoft Fabric destination (non-Azure).
Used by: DestinationsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| artifactId | The artifact id of the Microsoft Fabric resource. | string Optional |
| databaseName | The name of the database to which data will be ingested. | string Optional |
| ingestionUri | The ingestion uri of the Microsoft Fabric resource. | string Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| tenantId | The tenant id of the Microsoft Fabric resource. | string Optional |
MonitoringAccountDestination
Monitoring account destination.
Used by: DestinationsSpec.
| Property | Description | Type |
|---|---|---|
| accountResourceReference | The resource ID of the monitoring account. | genruntime.ResourceReference Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
MonitoringAccountDestination_STATUS
Monitoring account destination.
Used by: DestinationsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| accountId | The immutable ID of the account. | string Optional |
| accountResourceId | The resource ID of the monitoring account. | string Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
NetworkRuleSet_PublicNetworkAccess
Used by: NetworkRuleSet.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “SecuredByPerimeter” |
NetworkRuleSet_PublicNetworkAccess_STATUS
Used by: NetworkRuleSet_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “SecuredByPerimeter” |
PerfCounterDataSource
Definition of which performance counters will be collected and how they will be collected by this data collection rule. Collected from both Windows and Linux machines where the counter is present.
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| counterSpecifiers | A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command typeperf. |
string[] Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| samplingFrequencyInSeconds | The number of seconds between consecutive counter measurements (samples). | int Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. | PerfCounterDataSource_Streams[] Optional |
| transformKql | The KQL query to transform the data source. | string Optional |
PerfCounterDataSource_STATUS
Definition of which performance counters will be collected and how they will be collected by this data collection rule. Collected from both Windows and Linux machines where the counter is present.
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| counterSpecifiers | A list of specifier names of the performance counters you want to collect. Use a wildcard (*) to collect a counter for all instances. To get a list of performance counters on Windows, run the command typeperf. |
string[] Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| samplingFrequencyInSeconds | The number of seconds between consecutive counter measurements (samples). | int Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. | PerfCounterDataSource_Streams_STATUS[] Optional |
| transformKql | The KQL query to transform the data source. | string Optional |
PlatformTelemetryDataSource
Definition of platform telemetry data source configuration
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of platform telemetry streams to collect | string[] Required |
PlatformTelemetryDataSource_STATUS
Definition of platform telemetry data source configuration
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of platform telemetry streams to collect | string[] Optional |
PrometheusForwarderDataSource
Definition of Prometheus metrics forwarding configuration.
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| labelIncludeFilter | The list of label inclusion filters in the form of label “name-value” pairs. Currently only one label is supported: microsoft_metrics_include_label. Label values are matched case-insensitively. |
map[string]string Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of streams that this data source will be sent to. | PrometheusForwarderDataSource_Streams[] Optional |
PrometheusForwarderDataSource_STATUS
Definition of Prometheus metrics forwarding configuration.
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| labelIncludeFilter | The list of label inclusion filters in the form of label “name-value” pairs. Currently only one label is supported: microsoft_metrics_include_label. Label values are matched case-insensitively. |
map[string]string Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of streams that this data source will be sent to. | PrometheusForwarderDataSource_Streams_STATUS[] Optional |
StorageBlobDestination
Used by: DestinationsSpec, and DestinationsSpec.
| Property | Description | Type |
|---|---|---|
| containerName | The container name of the Storage Blob. | string Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| storageAccountResourceReference | The resource ID of the storage account. | genruntime.ResourceReference Optional |
StorageBlobDestination_STATUS
Used by: DestinationsSpec_STATUS, and DestinationsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| containerName | The container name of the Storage Blob. | string Optional |
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| storageAccountResourceId | The resource ID of the storage account. | string Optional |
StorageTableDestination
Used by: DestinationsSpec.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| storageAccountResourceReference | The resource ID of the storage account. | genruntime.ResourceReference Optional |
| tableName | The name of the Storage Table. | string Optional |
StorageTableDestination_STATUS
Used by: DestinationsSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the destination. This name should be unique across all destinations (regardless of type) within the data collection rule. | string Optional |
| storageAccountResourceId | The resource ID of the storage account. | string Optional |
| tableName | The name of the Storage Table. | string Optional |
SyslogDataSource
Definition of which syslog data will be collected and how it will be collected. Only collected from Linux machines.
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| facilityNames | The list of facility names. | SyslogDataSource_FacilityNames[] Optional |
| logLevels | The log levels to collect. | SyslogDataSource_LogLevels[] Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. | SyslogDataSource_Streams[] Optional |
| transformKql | The KQL query to transform the data source. | string Optional |
SyslogDataSource_STATUS
Definition of which syslog data will be collected and how it will be collected. Only collected from Linux machines.
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| facilityNames | The list of facility names. | SyslogDataSource_FacilityNames_STATUS[] Optional |
| logLevels | The log levels to collect. | SyslogDataSource_LogLevels_STATUS[] Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. | SyslogDataSource_Streams_STATUS[] Optional |
| transformKql | The KQL query to transform the data source. | string Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentity_STATUS
User assigned identity properties
Used by: ManagedServiceIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID of the assigned identity. | string Optional |
| principalId | The principal ID of the assigned identity. | string Optional |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ManagedServiceIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
WindowsEventLogDataSource
Definition of which Windows Event Log events will be collected and how they will be collected. Only collected from Windows machines.
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. | WindowsEventLogDataSource_Streams[] Optional |
| transformKql | The KQL query to transform the data source. | string Optional |
| xPathQueries | A list of Windows Event Log queries in XPATH format. | string[] Optional |
WindowsEventLogDataSource_STATUS
Definition of which Windows Event Log events will be collected and how they will be collected. Only collected from Windows machines.
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| streams | List of streams that this data source will be sent to. A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. | WindowsEventLogDataSource_Streams_STATUS[] Optional |
| transformKql | The KQL query to transform the data source. | string Optional |
| xPathQueries | A list of Windows Event Log queries in XPATH format. | string[] Optional |
WindowsFirewallLogsDataSource
Enables Firewall logs to be collected by this data collection rule.
Used by: DataSourcesSpec.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| profileFilter | Firewall logs profile filter | WindowsFirewallLogsDataSource_ProfileFilter[] Optional |
| streams | Firewall logs streams | string[] Required |
WindowsFirewallLogsDataSource_STATUS
Enables Firewall logs to be collected by this data collection rule.
Used by: DataSourcesSpec_STATUS.
| Property | Description | Type |
|---|---|---|
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| profileFilter | Firewall logs profile filter | WindowsFirewallLogsDataSource_ProfileFilter_STATUS[] Optional |
| streams | Firewall logs streams | string[] Optional |
AgentSetting_Name
Used by: AgentSetting.
| Value | Description |
|---|---|
| “MaxDiskQuotaInMB” | |
| “UseTimeReceivedForForwardedEvents” |
AgentSetting_Name_STATUS
Used by: AgentSetting_STATUS.
| Value | Description |
|---|---|
| “MaxDiskQuotaInMB” | |
| “UseTimeReceivedForForwardedEvents” |
ColumnDefinition_Type
Used by: ColumnDefinition.
| Value | Description |
|---|---|
| “boolean” | |
| “datetime” | |
| “dynamic” | |
| “int” | |
| “long” | |
| “real” | |
| “string” |
ColumnDefinition_Type_STATUS
Used by: ColumnDefinition_STATUS.
| Value | Description |
|---|---|
| “boolean” | |
| “datetime” | |
| “dynamic” | |
| “int” | |
| “long” | |
| “real” | |
| “string” |
EventHubDataSource
Used by: DataImportSources.
| Property | Description | Type |
|---|---|---|
| consumerGroup | Event Hub consumer group name | string Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| stream | The stream to collect from EventHub | string Optional |
EventHubDataSource_STATUS
Used by: DataImportSources_STATUS.
| Property | Description | Type |
|---|---|---|
| consumerGroup | Event Hub consumer group name | string Optional |
| name | A friendly name for the data source. This name should be unique across all data sources (regardless of type) within the data collection rule. | string Optional |
| stream | The stream to collect from EventHub | string Optional |
ExtensionDataSource_Streams
Used by: ExtensionDataSource.
| Value | Description |
|---|---|
| “Microsoft-Event” | |
| “Microsoft-InsightsMetrics” | |
| “Microsoft-Perf” | |
| “Microsoft-Syslog” | |
| “Microsoft-WindowsEvent” |
ExtensionDataSource_Streams_STATUS
Used by: ExtensionDataSource_STATUS.
| Value | Description |
|---|---|
| “Microsoft-Event” | |
| “Microsoft-InsightsMetrics” | |
| “Microsoft-Perf” | |
| “Microsoft-Syslog” | |
| “Microsoft-WindowsEvent” |
LocationSpec_ProvisioningStatus_STATUS
Used by: LocationSpec_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
LogFilesDataSource_Format
Used by: LogFilesDataSource.
| Value | Description |
|---|---|
| “json” | |
| “text” |
LogFilesDataSource_Format_STATUS
Used by: LogFilesDataSource_STATUS.
| Value | Description |
|---|---|
| “json” | |
| “text” |
LogFileSettings
Settings for different log file formats
Used by: LogFilesDataSource.
| Property | Description | Type |
|---|---|---|
| text | Text settings | LogFileTextSettings Optional |
LogFileSettings_STATUS
Settings for different log file formats
Used by: LogFilesDataSource_STATUS.
| Property | Description | Type |
|---|---|---|
| text | Text settings | LogFileTextSettings_STATUS Optional |
PerfCounterDataSource_Streams
Used by: PerfCounterDataSource.
| Value | Description |
|---|---|
| “Microsoft-InsightsMetrics” | |
| “Microsoft-Perf” |
PerfCounterDataSource_Streams_STATUS
Used by: PerfCounterDataSource_STATUS.
| Value | Description |
|---|---|
| “Microsoft-InsightsMetrics” | |
| “Microsoft-Perf” |
PrometheusForwarderDataSource_Streams
Used by: PrometheusForwarderDataSource.
| Value | Description |
|---|---|
| “Microsoft-PrometheusMetrics” |
PrometheusForwarderDataSource_Streams_STATUS
Used by: PrometheusForwarderDataSource_STATUS.
| Value | Description |
|---|---|
| “Microsoft-PrometheusMetrics” |
StorageBlob
Used by: EnrichmentData.
| Property | Description | Type |
|---|---|---|
| blobUrl | Url of the storage blob | string Optional |
| lookupType | The type of lookup to perform on the blob | StorageBlob_LookupType Optional |
| name | The name of the enrichment data source used as an alias when referencing this data source in data flows | string Optional |
| resourceReference | Resource Id of the storage account that hosts the blob | genruntime.ResourceReference Optional |
StorageBlob_STATUS
Used by: EnrichmentData_STATUS.
| Property | Description | Type |
|---|---|---|
| blobUrl | Url of the storage blob | string Optional |
| lookupType | The type of lookup to perform on the blob | StorageBlob_LookupType_STATUS Optional |
| name | The name of the enrichment data source used as an alias when referencing this data source in data flows | string Optional |
| resourceId | Resource Id of the storage account that hosts the blob | string Optional |
SyslogDataSource_FacilityNames
Used by: SyslogDataSource.
| Value | Description |
|---|---|
| “alert” | |
| “audit” | |
| “auth” | |
| “authpriv” | |
| “clock” | |
| “cron” | |
| “daemon” | |
| “ftp” | |
| “kern” | |
| “local0” | |
| “local1” | |
| “local2” | |
| “local3” | |
| “local4” | |
| “local5” | |
| “local6” | |
| “local7” | |
| “lpr” | |
| “mail” | |
| “mark” | |
| “news” | |
| “nopri” | |
| “ntp” | |
| “*” | |
| “syslog” | |
| “user” | |
| “uucp” |
SyslogDataSource_FacilityNames_STATUS
Used by: SyslogDataSource_STATUS.
| Value | Description |
|---|---|
| “alert” | |
| “audit” | |
| “auth” | |
| “authpriv” | |
| “clock” | |
| “cron” | |
| “daemon” | |
| “ftp” | |
| “kern” | |
| “local0” | |
| “local1” | |
| “local2” | |
| “local3” | |
| “local4” | |
| “local5” | |
| “local6” | |
| “local7” | |
| “lpr” | |
| “mail” | |
| “mark” | |
| “news” | |
| “nopri” | |
| “ntp” | |
| “*” | |
| “syslog” | |
| “user” | |
| “uucp” |
SyslogDataSource_LogLevels
Used by: SyslogDataSource.
| Value | Description |
|---|---|
| “Alert” | |
| “Critical” | |
| “Debug” | |
| “Emergency” | |
| “Error” | |
| “Info” | |
| “Notice” | |
| “*” | |
| “Warning” |
SyslogDataSource_LogLevels_STATUS
Used by: SyslogDataSource_STATUS.
| Value | Description |
|---|---|
| “Alert” | |
| “Critical” | |
| “Debug” | |
| “Emergency” | |
| “Error” | |
| “Info” | |
| “Notice” | |
| “*” | |
| “Warning” |
SyslogDataSource_Streams
Used by: SyslogDataSource.
| Value | Description |
|---|---|
| “Microsoft-Syslog” |
SyslogDataSource_Streams_STATUS
Used by: SyslogDataSource_STATUS.
| Value | Description |
|---|---|
| “Microsoft-Syslog” |
WindowsEventLogDataSource_Streams
Used by: WindowsEventLogDataSource.
| Value | Description |
|---|---|
| “Microsoft-Event” | |
| “Microsoft-WindowsEvent” |
WindowsEventLogDataSource_Streams_STATUS
Used by: WindowsEventLogDataSource_STATUS.
| Value | Description |
|---|---|
| “Microsoft-Event” | |
| “Microsoft-WindowsEvent” |
WindowsFirewallLogsDataSource_ProfileFilter
Used by: WindowsFirewallLogsDataSource.
| Value | Description |
|---|---|
| “Domain” | |
| “Private” | |
| “Public” |
WindowsFirewallLogsDataSource_ProfileFilter_STATUS
Used by: WindowsFirewallLogsDataSource_STATUS.
| Value | Description |
|---|---|
| “Domain” | |
| “Private” | |
| “Public” |
LogFileTextSettings
Settings for text log files
Used by: LogFileSettings.
| Property | Description | Type |
|---|---|---|
| recordStartTimestampFormat | One of the supported timestamp formats | LogFileTextSettings_RecordStartTimestampFormat Required |
LogFileTextSettings_STATUS
Settings for text log files
Used by: LogFileSettings_STATUS.
| Property | Description | Type |
|---|---|---|
| recordStartTimestampFormat | One of the supported timestamp formats | LogFileTextSettings_RecordStartTimestampFormat_STATUS Optional |
StorageBlob_LookupType
Used by: StorageBlob.
| Value | Description |
|---|---|
| “Cidr” | |
| “String” |
StorageBlob_LookupType_STATUS
Used by: StorageBlob_STATUS.
| Value | Description |
|---|---|
| “Cidr” | |
| “String” |
LogFileTextSettings_RecordStartTimestampFormat
Used by: LogFileTextSettings.
| Value | Description |
|---|---|
| “dd/MMM/yyyy:HH:mm:ss zzz” | |
| “ddMMyy HH:mm:ss” | |
| “ISO 8601” | |
| “M/D/YYYY HH:MM:SS AM/PM” | |
| “MMM d hh:mm:ss” | |
| “Mon DD, YYYY HH:MM:SS” | |
| “YYYY-MM-DD HH:MM:SS” | |
| “yyMMdd HH:mm:ss” | |
| “yyyy-MM-ddTHH:mm:ssK” |
LogFileTextSettings_RecordStartTimestampFormat_STATUS
Used by: LogFileTextSettings_STATUS.
| Value | Description |
|---|---|
| “dd/MMM/yyyy:HH:mm:ss zzz” | |
| “ddMMyy HH:mm:ss” | |
| “ISO 8601” | |
| “M/D/YYYY HH:MM:SS AM/PM” | |
| “MMM d hh:mm:ss” | |
| “Mon DD, YYYY HH:MM:SS” | |
| “YYYY-MM-DD HH:MM:SS” | |
| “yyMMdd HH:mm:ss” | |
| “yyyy-MM-ddTHH:mm:ssK” |