operationalinsights.azure.com/v1beta20210601
operationalinsights.azure.com/v1beta20210601
Package v1beta20210601 contains API Schema definitions for the operationalinsights v1beta20210601 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2021-06-01" |
PrivateLinkScopedResource_Status
(Appears on:Workspace_Status)
Field | Description |
---|---|
resourceId string |
ResourceId: The full resource Id of the private link scope resource. |
scopeId string |
ScopeId: The private link scope unique Identifier. |
PrivateLinkScopedResource_StatusARM
(Appears on:WorkspaceProperties_StatusARM)
Field | Description |
---|---|
resourceId string |
ResourceId: The full resource Id of the private link scope resource. |
scopeId string |
ScopeId: The private link scope unique Identifier. |
PublicNetworkAccessType_Status
(string
alias)
(Appears on:WorkspaceProperties_StatusARM, Workspace_Status)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
Workspace
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.OperationalInsights.json#/resourceDefinitions/workspaces
Field | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||
spec Workspaces_Spec |
|
||||||||||||||||||||||||||
status Workspace_Status |
WorkspaceCapping
(Appears on:Workspaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.OperationalInsights.json#/definitions/WorkspaceCapping
Field | Description |
---|---|
dailyQuotaGb float64 |
DailyQuotaGb: The workspace daily quota for ingestion. |
WorkspaceCappingARM
(Appears on:WorkspacePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.OperationalInsights.json#/definitions/WorkspaceCapping
Field | Description |
---|---|
dailyQuotaGb float64 |
DailyQuotaGb: The workspace daily quota for ingestion. |
WorkspaceCappingStatusDataIngestionStatus
(string
alias)
(Appears on:WorkspaceCapping_Status, WorkspaceCapping_StatusARM)
Value | Description |
---|---|
"ApproachingQuota" |
|
"ForceOff" |
|
"ForceOn" |
|
"OverQuota" |
|
"RespectQuota" |
|
"SubscriptionSuspended" |
WorkspaceCapping_Status
(Appears on:Workspace_Status)
Field | Description |
---|---|
dailyQuotaGb float64 |
DailyQuotaGb: The workspace daily quota for ingestion. |
dataIngestionStatus WorkspaceCappingStatusDataIngestionStatus |
DataIngestionStatus: The status of data ingestion for this workspace. |
quotaNextResetTime string |
QuotaNextResetTime: The time when the quota will be rest. |
WorkspaceCapping_StatusARM
(Appears on:WorkspaceProperties_StatusARM)
Field | Description |
---|---|
dailyQuotaGb float64 |
DailyQuotaGb: The workspace daily quota for ingestion. |
dataIngestionStatus WorkspaceCappingStatusDataIngestionStatus |
DataIngestionStatus: The status of data ingestion for this workspace. |
quotaNextResetTime string |
QuotaNextResetTime: The time when the quota will be rest. |
WorkspaceFeatures
(Appears on:Workspaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.OperationalInsights.json#/definitions/WorkspaceFeatures
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
AdditionalProperties: Unmatched properties from the message are deserialized this collection |
clusterResourceReference genruntime.ResourceReference |
ClusterResourceReference: Dedicated LA cluster resourceId that is linked to the workspaces. |
disableLocalAuth bool |
DisableLocalAuth: Disable Non-AAD based Auth. |
enableDataExport bool |
EnableDataExport: Flag that indicate if data should be exported. |
enableLogAccessUsingOnlyResourcePermissions bool |
EnableLogAccessUsingOnlyResourcePermissions: Flag that indicate which permission to use - resource or workspace or both. |
immediatePurgeDataOn30Days bool |
ImmediatePurgeDataOn30Days: Flag that describes if we want to remove the data after 30 days. |
WorkspaceFeaturesARM
(Appears on:WorkspacePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.OperationalInsights.json#/definitions/WorkspaceFeatures
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
AdditionalProperties: Unmatched properties from the message are deserialized this collection |
clusterResourceId string |
|
disableLocalAuth bool |
DisableLocalAuth: Disable Non-AAD based Auth. |
enableDataExport bool |
EnableDataExport: Flag that indicate if data should be exported. |
enableLogAccessUsingOnlyResourcePermissions bool |
EnableLogAccessUsingOnlyResourcePermissions: Flag that indicate which permission to use - resource or workspace or both. |
immediatePurgeDataOn30Days bool |
ImmediatePurgeDataOn30Days: Flag that describes if we want to remove the data after 30 days. |
WorkspaceFeatures_Status
(Appears on:Workspace_Status)
Field | Description |
---|---|
clusterResourceId string |
ClusterResourceId: Dedicated LA cluster resourceId that is linked to the workspaces. |
disableLocalAuth bool |
DisableLocalAuth: Disable Non-AAD based Auth. |
enableDataExport bool |
EnableDataExport: Flag that indicate if data should be exported. |
enableLogAccessUsingOnlyResourcePermissions bool |
EnableLogAccessUsingOnlyResourcePermissions: Flag that indicate which permission to use - resource or workspace or both. |
immediatePurgeDataOn30Days bool |
ImmediatePurgeDataOn30Days: Flag that describes if we want to remove the data after 30 days. |
WorkspaceFeatures_StatusARM
(Appears on:WorkspaceProperties_StatusARM)
Field | Description |
---|---|
clusterResourceId string |
ClusterResourceId: Dedicated LA cluster resourceId that is linked to the workspaces. |
disableLocalAuth bool |
DisableLocalAuth: Disable Non-AAD based Auth. |
enableDataExport bool |
EnableDataExport: Flag that indicate if data should be exported. |
enableLogAccessUsingOnlyResourcePermissions bool |
EnableLogAccessUsingOnlyResourcePermissions: Flag that indicate which permission to use - resource or workspace or both. |
immediatePurgeDataOn30Days bool |
ImmediatePurgeDataOn30Days: Flag that describes if we want to remove the data after 30 days. |
WorkspacePropertiesARM
(Appears on:Workspaces_SpecARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.OperationalInsights.json#/definitions/WorkspaceProperties
Field | Description |
---|---|
features WorkspaceFeaturesARM |
Features: Workspace features. |
forceCmkForQuery bool |
ForceCmkForQuery: Indicates whether customer managed storage is mandatory for query management. |
provisioningState WorkspacePropertiesProvisioningState |
ProvisioningState: The provisioning state of the workspace. |
publicNetworkAccessForIngestion WorkspacePropertiesPublicNetworkAccessForIngestion |
PublicNetworkAccessForIngestion: The network access type for accessing Log Analytics ingestion. |
publicNetworkAccessForQuery WorkspacePropertiesPublicNetworkAccessForQuery |
PublicNetworkAccessForQuery: The network access type for accessing Log Analytics query. |
retentionInDays int |
RetentionInDays: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. |
sku WorkspaceSkuARM |
Sku: The SKU (tier) of a workspace. |
workspaceCapping WorkspaceCappingARM |
WorkspaceCapping: The daily volume cap for ingestion. |
WorkspacePropertiesProvisioningState
(string
alias)
(Appears on:WorkspacePropertiesARM, Workspaces_Spec)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"ProvisioningAccount" |
|
"Succeeded" |
|
"Updating" |
WorkspacePropertiesPublicNetworkAccessForIngestion
(string
alias)
(Appears on:WorkspacePropertiesARM, Workspaces_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
WorkspacePropertiesPublicNetworkAccessForQuery
(string
alias)
(Appears on:WorkspacePropertiesARM, Workspaces_Spec)
Value | Description |
---|---|
"Disabled" |
|
"Enabled" |
WorkspacePropertiesStatusProvisioningState
(string
alias)
(Appears on:WorkspaceProperties_StatusARM, Workspace_Status)
Value | Description |
---|---|
"Canceled" |
|
"Creating" |
|
"Deleting" |
|
"Failed" |
|
"ProvisioningAccount" |
|
"Succeeded" |
|
"Updating" |
WorkspaceProperties_StatusARM
(Appears on:Workspace_StatusARM)
Field | Description |
---|---|
createdDate string |
CreatedDate: Workspace creation date. |
customerId string |
CustomerId: This is a read-only property. Represents the ID associated with the workspace. |
features WorkspaceFeatures_StatusARM |
Features: Workspace features. |
forceCmkForQuery bool |
ForceCmkForQuery: Indicates whether customer managed storage is mandatory for query management. |
modifiedDate string |
ModifiedDate: Workspace modification date. |
privateLinkScopedResources []PrivateLinkScopedResource_StatusARM |
PrivateLinkScopedResources: List of linked private link scope resources. |
provisioningState WorkspacePropertiesStatusProvisioningState |
ProvisioningState: The provisioning state of the workspace. |
publicNetworkAccessForIngestion PublicNetworkAccessType_Status |
PublicNetworkAccessForIngestion: The network access type for accessing Log Analytics ingestion. |
publicNetworkAccessForQuery PublicNetworkAccessType_Status |
PublicNetworkAccessForQuery: The network access type for accessing Log Analytics query. |
retentionInDays int |
RetentionInDays: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. |
sku WorkspaceSku_StatusARM |
Sku: The SKU of the workspace. |
workspaceCapping WorkspaceCapping_StatusARM |
WorkspaceCapping: The daily volume cap for ingestion. |
WorkspaceSku
(Appears on:Workspaces_Spec)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.OperationalInsights.json#/definitions/WorkspaceSku
Field | Description |
---|---|
capacityReservationLevel int |
CapacityReservationLevel: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. |
name WorkspaceSkuName |
Name: The name of the SKU. |
WorkspaceSkuARM
(Appears on:WorkspacePropertiesARM)
Generated from: https://schema.management.azure.com/schemas/2021-06-01/Microsoft.OperationalInsights.json#/definitions/WorkspaceSku
Field | Description |
---|---|
capacityReservationLevel int |
CapacityReservationLevel: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. |
name WorkspaceSkuName |
Name: The name of the SKU. |
WorkspaceSkuName
(string
alias)
(Appears on:WorkspaceSku, WorkspaceSkuARM)
Value | Description |
---|---|
"CapacityReservation" |
|
"Free" |
|
"LACluster" |
|
"PerGB2018" |
|
"PerNode" |
|
"Premium" |
|
"Standalone" |
|
"Standard" |
WorkspaceSkuStatusCapacityReservationLevel
(int
alias)
(Appears on:WorkspaceSku_Status, WorkspaceSku_StatusARM)
Value | Description |
---|---|
100 |
|
1000 |
|
200 |
|
2000 |
|
300 |
|
400 |
|
500 |
|
5000 |
WorkspaceSkuStatusName
(string
alias)
(Appears on:WorkspaceSku_Status, WorkspaceSku_StatusARM)
Value | Description |
---|---|
"CapacityReservation" |
|
"Free" |
|
"LACluster" |
|
"PerGB2018" |
|
"PerNode" |
|
"Premium" |
|
"Standalone" |
|
"Standard" |
WorkspaceSku_Status
(Appears on:Workspace_Status)
Field | Description |
---|---|
capacityReservationLevel WorkspaceSkuStatusCapacityReservationLevel |
CapacityReservationLevel: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. |
lastSkuUpdate string |
LastSkuUpdate: The last time when the sku was updated. |
name WorkspaceSkuStatusName |
Name: The name of the SKU. |
WorkspaceSku_StatusARM
(Appears on:WorkspaceProperties_StatusARM)
Field | Description |
---|---|
capacityReservationLevel WorkspaceSkuStatusCapacityReservationLevel |
CapacityReservationLevel: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. |
lastSkuUpdate string |
LastSkuUpdate: The last time when the sku was updated. |
name WorkspaceSkuStatusName |
Name: The name of the SKU. |
Workspace_Status
(Appears on:Workspace)
Field | Description |
---|---|
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
createdDate string |
CreatedDate: Workspace creation date. |
customerId string |
CustomerId: This is a read-only property. Represents the ID associated with the workspace. |
etag string |
Etag: The etag of the workspace. |
features WorkspaceFeatures_Status |
Features: Workspace features. |
forceCmkForQuery bool |
ForceCmkForQuery: Indicates whether customer managed storage is mandatory for query management. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
modifiedDate string |
ModifiedDate: Workspace modification date. |
name string |
Name: The name of the resource |
privateLinkScopedResources []PrivateLinkScopedResource_Status |
PrivateLinkScopedResources: List of linked private link scope resources. |
provisioningState WorkspacePropertiesStatusProvisioningState |
ProvisioningState: The provisioning state of the workspace. |
publicNetworkAccessForIngestion PublicNetworkAccessType_Status |
PublicNetworkAccessForIngestion: The network access type for accessing Log Analytics ingestion. |
publicNetworkAccessForQuery PublicNetworkAccessType_Status |
PublicNetworkAccessForQuery: The network access type for accessing Log Analytics query. |
retentionInDays int |
RetentionInDays: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. |
sku WorkspaceSku_Status |
Sku: The SKU of the workspace. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
workspaceCapping WorkspaceCapping_Status |
WorkspaceCapping: The daily volume cap for ingestion. |
Workspace_StatusARM
Field | Description |
---|---|
etag string |
Etag: The etag of the workspace. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
properties WorkspaceProperties_StatusARM |
Properties: Workspace properties. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
Workspaces_Spec
(Appears on:Workspace)
Field | Description |
---|---|
azureName string |
AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. |
etag string |
Etag: The etag of the workspace. |
features WorkspaceFeatures |
Features: Workspace features. |
forceCmkForQuery bool |
ForceCmkForQuery: Indicates whether customer managed storage is mandatory for query management. |
location string |
Location: The geo-location where the resource lives |
owner genruntime.KnownResourceReference |
Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource |
provisioningState WorkspacePropertiesProvisioningState |
ProvisioningState: The provisioning state of the workspace. |
publicNetworkAccessForIngestion WorkspacePropertiesPublicNetworkAccessForIngestion |
PublicNetworkAccessForIngestion: The network access type for accessing Log Analytics ingestion. |
publicNetworkAccessForQuery WorkspacePropertiesPublicNetworkAccessForQuery |
PublicNetworkAccessForQuery: The network access type for accessing Log Analytics query. |
retentionInDays int |
RetentionInDays: The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details. |
sku WorkspaceSku |
Sku: The SKU (tier) of a workspace. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |
workspaceCapping WorkspaceCapping |
WorkspaceCapping: The daily volume cap for ingestion. |
Workspaces_SpecARM
Field | Description |
---|---|
etag string |
Etag: The etag of the workspace. |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the workspace. |
properties WorkspacePropertiesARM |
Properties: Workspace properties. |
tags map[string]string |
Tags: Name-value pairs to add to the resource |