operationalinsights.azure.com/v1api20210601
APIVersion
| Value | Description |
|---|---|
| “2021-06-01” |
Workspace
Generator information: - Generated from: /operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json - ARM URI: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
Used by: WorkspaceList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Workspace_Spec Optional |
|
| status | Workspace_STATUS Optional |
Workspace_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 |
| etag | The etag of the workspace. | string Optional |
| features | Workspace features. | WorkspaceFeatures Optional |
| forceCmkForQuery | Indicates whether customer managed storage is mandatory for query management. | bool 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 | WorkspaceOperatorSpec 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 |
| provisioningState | The provisioning state of the workspace. | WorkspaceProperties_ProvisioningState Optional |
| publicNetworkAccessForIngestion | The network access type for accessing Log Analytics ingestion. | PublicNetworkAccessType Optional |
| publicNetworkAccessForQuery | The network access type for accessing Log Analytics query. | PublicNetworkAccessType Optional |
| retentionInDays | The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. | int Optional |
| sku | The SKU of the workspace. | WorkspaceSku Optional |
| tags | Resource tags. | map[string]string Optional |
| workspaceCapping | The daily volume cap for ingestion. | WorkspaceCapping Optional |
Workspace_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdDate | Workspace creation date. | string Optional |
| customerId | This is a read-only property. Represents the ID associated with the workspace. | string Optional |
| etag | The etag of the workspace. | string Optional |
| features | Workspace features. | WorkspaceFeatures_STATUS Optional |
| forceCmkForQuery | Indicates whether customer managed storage is mandatory for query management. | bool Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| modifiedDate | Workspace modification date. | string Optional |
| name | The name of the resource | string Optional |
| privateLinkScopedResources | List of linked private link scope resources. | PrivateLinkScopedResource_STATUS[] Optional |
| provisioningState | The provisioning state of the workspace. | WorkspaceProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccessForIngestion | The network access type for accessing Log Analytics ingestion. | PublicNetworkAccessType_STATUS Optional |
| publicNetworkAccessForQuery | The network access type for accessing Log Analytics query. | PublicNetworkAccessType_STATUS Optional |
| retentionInDays | The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. | int Optional |
| sku | The SKU of the workspace. | WorkspaceSku_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| workspaceCapping | The daily volume cap for ingestion. | WorkspaceCapping_STATUS Optional |
WorkspaceList
Generator information: - Generated from: /operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2021-06-01/Workspaces.json - ARM URI: /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Workspace[] Optional |
Workspace_Spec
Used by: Workspace.
| 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 |
| etag | The etag of the workspace. | string Optional |
| features | Workspace features. | WorkspaceFeatures Optional |
| forceCmkForQuery | Indicates whether customer managed storage is mandatory for query management. | bool 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 | WorkspaceOperatorSpec 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 |
| provisioningState | The provisioning state of the workspace. | WorkspaceProperties_ProvisioningState Optional |
| publicNetworkAccessForIngestion | The network access type for accessing Log Analytics ingestion. | PublicNetworkAccessType Optional |
| publicNetworkAccessForQuery | The network access type for accessing Log Analytics query. | PublicNetworkAccessType Optional |
| retentionInDays | The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. | int Optional |
| sku | The SKU of the workspace. | WorkspaceSku Optional |
| tags | Resource tags. | map[string]string Optional |
| workspaceCapping | The daily volume cap for ingestion. | WorkspaceCapping Optional |
Workspace_STATUS
The top level Workspace resource container.
Used by: Workspace.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createdDate | Workspace creation date. | string Optional |
| customerId | This is a read-only property. Represents the ID associated with the workspace. | string Optional |
| etag | The etag of the workspace. | string Optional |
| features | Workspace features. | WorkspaceFeatures_STATUS Optional |
| forceCmkForQuery | Indicates whether customer managed storage is mandatory for query management. | bool Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| location | The geo-location where the resource lives | string Optional |
| modifiedDate | Workspace modification date. | string Optional |
| name | The name of the resource | string Optional |
| privateLinkScopedResources | List of linked private link scope resources. | PrivateLinkScopedResource_STATUS[] Optional |
| provisioningState | The provisioning state of the workspace. | WorkspaceProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccessForIngestion | The network access type for accessing Log Analytics ingestion. | PublicNetworkAccessType_STATUS Optional |
| publicNetworkAccessForQuery | The network access type for accessing Log Analytics query. | PublicNetworkAccessType_STATUS Optional |
| retentionInDays | The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. | int Optional |
| sku | The SKU of the workspace. | WorkspaceSku_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
| workspaceCapping | The daily volume cap for ingestion. | WorkspaceCapping_STATUS Optional |
PrivateLinkScopedResource_STATUS
The private link scope resource reference.
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| resourceId | The full resource Id of the private link scope resource. | string Optional |
| scopeId | The private link scope unique Identifier. | string Optional |
PublicNetworkAccessType
The network access type for operating on the Log Analytics Workspace. By default it is Enabled
Used by: Workspace_Spec, and Workspace_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
PublicNetworkAccessType_STATUS
The network access type for operating on the Log Analytics Workspace. By default it is Enabled
Used by: Workspace_STATUS, and Workspace_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
WorkspaceCapping
The daily volume cap for ingestion.
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| dailyQuotaGb | The workspace daily quota for ingestion. | float64 Optional |
WorkspaceCapping_STATUS
The daily volume cap for ingestion.
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| dailyQuotaGb | The workspace daily quota for ingestion. | float64 Optional |
| dataIngestionStatus | The status of data ingestion for this workspace. | WorkspaceCapping_DataIngestionStatus_STATUS Optional |
| quotaNextResetTime | The time when the quota will be rest. | string Optional |
WorkspaceFeatures
Workspace features.
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| clusterResourceReference | Dedicated LA cluster resourceId that is linked to the workspaces. | genruntime.ResourceReference Optional |
| disableLocalAuth | Disable Non-AAD based Auth. | bool Optional |
| enableDataExport | Flag that indicate if data should be exported. | bool Optional |
| enableLogAccessUsingOnlyResourcePermissions | Flag that indicate which permission to use - resource or workspace or both. | bool Optional |
| immediatePurgeDataOn30Days | Flag that describes if we want to remove the data after 30 days. | bool Optional |
WorkspaceFeatures_STATUS
Workspace features.
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| clusterResourceId | Dedicated LA cluster resourceId that is linked to the workspaces. | string Optional |
| disableLocalAuth | Disable Non-AAD based Auth. | bool Optional |
| enableDataExport | Flag that indicate if data should be exported. | bool Optional |
| enableLogAccessUsingOnlyResourcePermissions | Flag that indicate which permission to use - resource or workspace or both. | bool Optional |
| immediatePurgeDataOn30Days | Flag that describes if we want to remove the data after 30 days. | bool Optional |
WorkspaceOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Workspace_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 |
WorkspaceProperties_ProvisioningState
Used by: Workspace_Spec.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “ProvisioningAccount” | |
| “Succeeded” | |
| “Updating” |
WorkspaceProperties_ProvisioningState_STATUS
Used by: Workspace_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “ProvisioningAccount” | |
| “Succeeded” | |
| “Updating” |
WorkspaceSku
The SKU (tier) of a workspace.
Used by: Workspace_Spec.
| Property | Description | Type |
|---|---|---|
| capacityReservationLevel | The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. | WorkspaceSku_CapacityReservationLevel Optional |
| name | The name of the SKU. | WorkspaceSku_Name Required |
WorkspaceSku_STATUS
The SKU (tier) of a workspace.
Used by: Workspace_STATUS.
| Property | Description | Type |
|---|---|---|
| capacityReservationLevel | The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. | WorkspaceSku_CapacityReservationLevel_STATUS Optional |
| lastSkuUpdate | The last time when the sku was updated. | string Optional |
| name | The name of the SKU. | WorkspaceSku_Name_STATUS Optional |
WorkspaceCapping_DataIngestionStatus_STATUS
Used by: WorkspaceCapping_STATUS.
| Value | Description |
|---|---|
| “ApproachingQuota” | |
| “ForceOff” | |
| “ForceOn” | |
| “OverQuota” | |
| “RespectQuota” | |
| “SubscriptionSuspended” |
WorkspaceSku_CapacityReservationLevel
Used by: WorkspaceSku.
| Value | Description |
|---|---|
| 100 | |
| 200 | |
| 300 | |
| 400 | |
| 500 | |
| 1000 | |
| 2000 | |
| 5000 |
WorkspaceSku_CapacityReservationLevel_STATUS
Used by: WorkspaceSku_STATUS.
| Value | Description |
|---|---|
| 100 | |
| 200 | |
| 300 | |
| 400 | |
| 500 | |
| 1000 | |
| 2000 | |
| 5000 |
WorkspaceSku_Name
Used by: WorkspaceSku.
| Value | Description |
|---|---|
| “CapacityReservation” | |
| “Free” | |
| “LACluster” | |
| “PerGB2018” | |
| “PerNode” | |
| “Premium” | |
| “Standalone” | |
| “Standard” |
WorkspaceSku_Name_STATUS
Used by: WorkspaceSku_STATUS.
| Value | Description |
|---|---|
| “CapacityReservation” | |
| “Free” | |
| “LACluster” | |
| “PerGB2018” | |
| “PerNode” | |
| “Premium” | |
| “Standalone” | |
| “Standard” |