operationalinsights.azure.com/v1api20210601

Package v1api20210601 contains API Schema definitions for the operationalinsights v1api20210601 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2021-06-01"

PrivateLinkScopedResource_STATUS

(Appears on:Workspace_STATUS)

The private link scope resource reference.

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_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

The private link scope resource reference.

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 (`string` alias)

(Appears on:WorkspaceProperties_ARM, Workspace_Spec)

The network access type for operating on the Log Analytics Workspace. By default it is Enabled

Value	Description
"Disabled"
"Enabled"

PublicNetworkAccessType_STATUS (`string` alias)

(Appears on:WorkspaceProperties_STATUS_ARM, Workspace_STATUS)

The network access type for operating on the Log Analytics Workspace. By default it is Enabled

Value	Description
"Disabled"
"Enabled"

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}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
Workspace_Spec

`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` WorkspaceProperties_ProvisioningState	ProvisioningState: The provisioning state of the workspace.
`publicNetworkAccessForIngestion` PublicNetworkAccessType	PublicNetworkAccessForIngestion: The network access type for accessing Log Analytics ingestion.
`publicNetworkAccessForQuery` PublicNetworkAccessType	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 of the workspace.
`tags` map[string]string	Tags: Resource tags.
`workspaceCapping` WorkspaceCapping	WorkspaceCapping: The daily volume cap for ingestion.

status
Workspace_STATUS

WorkspaceCapping

(Appears on:Workspace_Spec)

The daily volume cap for ingestion.

Field	Description
`dailyQuotaGb` float64	DailyQuotaGb: The workspace daily quota for ingestion.

WorkspaceCapping_ARM

(Appears on:WorkspaceProperties_ARM)

The daily volume cap for ingestion.

Field	Description
`dailyQuotaGb` float64	DailyQuotaGb: The workspace daily quota for ingestion.

WorkspaceCapping_DataIngestionStatus_STATUS (`string` alias)

(Appears on:WorkspaceCapping_STATUS, WorkspaceCapping_STATUS_ARM)

Value	Description
"ApproachingQuota"
"ForceOff"
"ForceOn"
"OverQuota"
"RespectQuota"
"SubscriptionSuspended"

WorkspaceCapping_STATUS

(Appears on:Workspace_STATUS)

The daily volume cap for ingestion.

Field	Description
`dailyQuotaGb` float64	DailyQuotaGb: The workspace daily quota for ingestion.
`dataIngestionStatus` WorkspaceCapping_DataIngestionStatus_STATUS	DataIngestionStatus: The status of data ingestion for this workspace.
`quotaNextResetTime` string	QuotaNextResetTime: The time when the quota will be rest.

WorkspaceCapping_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

The daily volume cap for ingestion.

Field	Description
`dailyQuotaGb` float64	DailyQuotaGb: The workspace daily quota for ingestion.
`dataIngestionStatus` WorkspaceCapping_DataIngestionStatus_STATUS	DataIngestionStatus: The status of data ingestion for this workspace.
`quotaNextResetTime` string	QuotaNextResetTime: The time when the quota will be rest.

WorkspaceFeatures

(Appears on:Workspace_Spec)

Workspace features.

Field	Description
`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.

WorkspaceFeatures_ARM

(Appears on:WorkspaceProperties_ARM)

Workspace features.

Field	Description
`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)

Workspace features.

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_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

Workspace features.

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.

WorkspaceProperties_ARM

(Appears on:Workspace_Spec_ARM)

Workspace properties.

Field	Description
`features` WorkspaceFeatures_ARM	Features: Workspace features.
`forceCmkForQuery` bool	ForceCmkForQuery: Indicates whether customer managed storage is mandatory for query management.
`provisioningState` WorkspaceProperties_ProvisioningState	ProvisioningState: The provisioning state of the workspace.
`publicNetworkAccessForIngestion` PublicNetworkAccessType	PublicNetworkAccessForIngestion: The network access type for accessing Log Analytics ingestion.
`publicNetworkAccessForQuery` PublicNetworkAccessType	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_ARM	Sku: The SKU of the workspace.
`workspaceCapping` WorkspaceCapping_ARM	WorkspaceCapping: The daily volume cap for ingestion.

WorkspaceProperties_ProvisioningState (`string` alias)

(Appears on:WorkspaceProperties_ARM, Workspace_Spec)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"ProvisioningAccount"
"Succeeded"
"Updating"

WorkspaceProperties_ProvisioningState_STATUS (`string` alias)

(Appears on:WorkspaceProperties_STATUS_ARM, Workspace_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"ProvisioningAccount"
"Succeeded"
"Updating"

WorkspaceProperties_STATUS_ARM

(Appears on:Workspace_STATUS_ARM)

Workspace properties.

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_STATUS_ARM	Features: Workspace features.
`forceCmkForQuery` bool	ForceCmkForQuery: Indicates whether customer managed storage is mandatory for query management.
`modifiedDate` string	ModifiedDate: Workspace modification date.
`privateLinkScopedResources` []PrivateLinkScopedResource_STATUS_ARM	PrivateLinkScopedResources: List of linked private link scope resources.
`provisioningState` WorkspaceProperties_ProvisioningState_STATUS	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_ARM	Sku: The SKU of the workspace.
`workspaceCapping` WorkspaceCapping_STATUS_ARM	WorkspaceCapping: The daily volume cap for ingestion.

WorkspaceSku

(Appears on:Workspace_Spec)

The SKU (tier) of a workspace.

Field	Description
`capacityReservationLevel` WorkspaceSku_CapacityReservationLevel	CapacityReservationLevel: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
`name` WorkspaceSku_Name	Name: The name of the SKU.

WorkspaceSku_ARM

(Appears on:WorkspaceProperties_ARM)

The SKU (tier) of a workspace.

Field	Description
`capacityReservationLevel` WorkspaceSku_CapacityReservationLevel	CapacityReservationLevel: The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
`name` WorkspaceSku_Name	Name: The name of the SKU.

WorkspaceSku_CapacityReservationLevel (`int` alias)

(Appears on:WorkspaceSku, WorkspaceSku_ARM)

Value	Description
100
1000
200
2000
300
400
500
5000

WorkspaceSku_CapacityReservationLevel_STATUS (`int` alias)

(Appears on:WorkspaceSku_STATUS, WorkspaceSku_STATUS_ARM)

Value	Description
100
1000
200
2000
300
400
500
5000

WorkspaceSku_Name (`string` alias)

(Appears on:WorkspaceSku, WorkspaceSku_ARM)

Value	Description
"CapacityReservation"
"Free"
"LACluster"
"PerGB2018"
"PerNode"
"Premium"
"Standalone"
"Standard"

WorkspaceSku_Name_STATUS (`string` alias)

(Appears on:WorkspaceSku_STATUS, WorkspaceSku_STATUS_ARM)

Value	Description
"CapacityReservation"
"Free"
"LACluster"
"PerGB2018"
"PerNode"
"Premium"
"Standalone"
"Standard"

WorkspaceSku_STATUS

(Appears on:Workspace_STATUS)

The SKU (tier) of a workspace.

Field	Description
`capacityReservationLevel` WorkspaceSku_CapacityReservationLevel_STATUS	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` WorkspaceSku_Name_STATUS	Name: The name of the SKU.

WorkspaceSku_STATUS_ARM

(Appears on:WorkspaceProperties_STATUS_ARM)

The SKU (tier) of a workspace.

Field	Description
`capacityReservationLevel` WorkspaceSku_CapacityReservationLevel_STATUS	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` WorkspaceSku_Name_STATUS	Name: The name of the SKU.

Workspace_STATUS

(Appears on:Workspace)

The top level Workspace resource container.

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}
`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` WorkspaceProperties_ProvisioningState_STATUS	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_STATUS_ARM

The top level Workspace resource container.

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}
`location` string	Location: The geo-location where the resource lives
`name` string	Name: The name of the resource
`properties` WorkspaceProperties_STATUS_ARM	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”

Workspace_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` WorkspaceProperties_ProvisioningState	ProvisioningState: The provisioning state of the workspace.
`publicNetworkAccessForIngestion` PublicNetworkAccessType	PublicNetworkAccessForIngestion: The network access type for accessing Log Analytics ingestion.
`publicNetworkAccessForQuery` PublicNetworkAccessType	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 of the workspace.
`tags` map[string]string	Tags: Resource tags.
`workspaceCapping` WorkspaceCapping	WorkspaceCapping: The daily volume cap for ingestion.

Workspace_Spec_ARM

Field	Description
`etag` string	Etag: The etag of the workspace.
`location` string	Location: The geo-location where the resource lives
`name` string
`properties` WorkspaceProperties_ARM	Properties: Workspace properties.
`tags` map[string]string	Tags: Resource tags.

operationalinsights.azure.com/v1api20210601