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 |
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 |
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 |
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 |
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” |
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 |
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.
| 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.
| 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, and DataCollectionRuleAssociationProxyOnlyResource_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 |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: DataCollectionEndpointResource_STATUS, and DataCollectionRuleAssociationProxyOnlyResource_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 |
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 |
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” |
NetworkRuleSet_PublicNetworkAccess
Used by: NetworkRuleSet.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “SecuredByPerimeter” |
NetworkRuleSet_PublicNetworkAccess_STATUS
Used by: NetworkRuleSet_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” | |
| “SecuredByPerimeter” |
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 |
LocationSpec_ProvisioningStatus_STATUS
Used by: LocationSpec_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |