azure-native.operationalinsights.getWorkspace

Explore with Pulumi AI

Gets a workspace instance. API Version: 2020-10-01.

Using getWorkspace

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>
def get_workspace(resource_group_name: Optional[str] = None,
                  workspace_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                  workspace_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

> Note: This function is named LookupWorkspace in the Go SDK.

public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:operationalinsights:getWorkspace
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string

The name of the resource group. The name is case insensitive.

WorkspaceName string

The name of the workspace.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

WorkspaceName string

The name of the workspace.

resourceGroupName String

The name of the resource group. The name is case insensitive.

workspaceName String

The name of the workspace.

resourceGroupName string

The name of the resource group. The name is case insensitive.

workspaceName string

The name of the workspace.

resource_group_name str

The name of the resource group. The name is case insensitive.

workspace_name str

The name of the workspace.

resourceGroupName String

The name of the resource group. The name is case insensitive.

workspaceName String

The name of the workspace.

getWorkspace Result

The following output properties are available:

CreatedDate string

Workspace creation date.

CustomerId string

This is a read-only property. Represents the ID associated with the workspace.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Location string

The geo-location where the resource lives

ModifiedDate string

Workspace modification date.

Name string

The name of the resource

PrivateLinkScopedResources List<Pulumi.AzureNative.OperationalInsights.Outputs.PrivateLinkScopedResourceResponse>

List of linked private link scope resources.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ETag string

The ETag of the workspace.

Features Pulumi.AzureNative.OperationalInsights.Outputs.WorkspaceFeaturesResponse

Workspace features.

ForceCmkForQuery bool

Indicates whether customer managed storage is mandatory for query management.

ProvisioningState string

The provisioning state of the workspace.

PublicNetworkAccessForIngestion string

The network access type for accessing Log Analytics ingestion.

PublicNetworkAccessForQuery string

The network access type for accessing Log Analytics query.

RetentionInDays int

The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.

Sku Pulumi.AzureNative.OperationalInsights.Outputs.WorkspaceSkuResponse

The SKU of the workspace.

Tags Dictionary<string, string>

Resource tags.

WorkspaceCapping Pulumi.AzureNative.OperationalInsights.Outputs.WorkspaceCappingResponse

The daily volume cap for ingestion.

CreatedDate string

Workspace creation date.

CustomerId string

This is a read-only property. Represents the ID associated with the workspace.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Location string

The geo-location where the resource lives

ModifiedDate string

Workspace modification date.

Name string

The name of the resource

PrivateLinkScopedResources []PrivateLinkScopedResourceResponse

List of linked private link scope resources.

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ETag string

The ETag of the workspace.

Features WorkspaceFeaturesResponse

Workspace features.

ForceCmkForQuery bool

Indicates whether customer managed storage is mandatory for query management.

ProvisioningState string

The provisioning state of the workspace.

PublicNetworkAccessForIngestion string

The network access type for accessing Log Analytics ingestion.

PublicNetworkAccessForQuery string

The network access type for accessing Log Analytics query.

RetentionInDays int

The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.

Sku WorkspaceSkuResponse

The SKU of the workspace.

Tags map[string]string

Resource tags.

WorkspaceCapping WorkspaceCappingResponse

The daily volume cap for ingestion.

createdDate String

Workspace creation date.

customerId String

This is a read-only property. Represents the ID associated with the workspace.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location String

The geo-location where the resource lives

modifiedDate String

Workspace modification date.

name String

The name of the resource

privateLinkScopedResources List<PrivateLinkScopedResourceResponse>

List of linked private link scope resources.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

eTag String

The ETag of the workspace.

features WorkspaceFeaturesResponse

Workspace features.

forceCmkForQuery Boolean

Indicates whether customer managed storage is mandatory for query management.

provisioningState String

The provisioning state of the workspace.

publicNetworkAccessForIngestion String

The network access type for accessing Log Analytics ingestion.

publicNetworkAccessForQuery String

The network access type for accessing Log Analytics query.

retentionInDays Integer

The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.

sku WorkspaceSkuResponse

The SKU of the workspace.

tags Map<String,String>

Resource tags.

workspaceCapping WorkspaceCappingResponse

The daily volume cap for ingestion.

createdDate string

Workspace creation date.

customerId string

This is a read-only property. Represents the ID associated with the workspace.

id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location string

The geo-location where the resource lives

modifiedDate string

Workspace modification date.

name string

The name of the resource

privateLinkScopedResources PrivateLinkScopedResourceResponse[]

List of linked private link scope resources.

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

eTag string

The ETag of the workspace.

features WorkspaceFeaturesResponse

Workspace features.

forceCmkForQuery boolean

Indicates whether customer managed storage is mandatory for query management.

provisioningState string

The provisioning state of the workspace.

publicNetworkAccessForIngestion string

The network access type for accessing Log Analytics ingestion.

publicNetworkAccessForQuery string

The network access type for accessing Log Analytics query.

retentionInDays number

The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.

sku WorkspaceSkuResponse

The SKU of the workspace.

tags {[key: string]: string}

Resource tags.

workspaceCapping WorkspaceCappingResponse

The daily volume cap for ingestion.

created_date str

Workspace creation date.

customer_id str

This is a read-only property. Represents the ID associated with the workspace.

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location str

The geo-location where the resource lives

modified_date str

Workspace modification date.

name str

The name of the resource

private_link_scoped_resources Sequence[PrivateLinkScopedResourceResponse]

List of linked private link scope resources.

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

e_tag str

The ETag of the workspace.

features WorkspaceFeaturesResponse

Workspace features.

force_cmk_for_query bool

Indicates whether customer managed storage is mandatory for query management.

provisioning_state str

The provisioning state of the workspace.

public_network_access_for_ingestion str

The network access type for accessing Log Analytics ingestion.

public_network_access_for_query str

The network access type for accessing Log Analytics query.

retention_in_days int

The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.

sku WorkspaceSkuResponse

The SKU of the workspace.

tags Mapping[str, str]

Resource tags.

workspace_capping WorkspaceCappingResponse

The daily volume cap for ingestion.

createdDate String

Workspace creation date.

customerId String

This is a read-only property. Represents the ID associated with the workspace.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location String

The geo-location where the resource lives

modifiedDate String

Workspace modification date.

name String

The name of the resource

privateLinkScopedResources List<Property Map>

List of linked private link scope resources.

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

eTag String

The ETag of the workspace.

features Property Map

Workspace features.

forceCmkForQuery Boolean

Indicates whether customer managed storage is mandatory for query management.

provisioningState String

The provisioning state of the workspace.

publicNetworkAccessForIngestion String

The network access type for accessing Log Analytics ingestion.

publicNetworkAccessForQuery String

The network access type for accessing Log Analytics query.

retentionInDays Number

The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.

sku Property Map

The SKU of the workspace.

tags Map<String>

Resource tags.

workspaceCapping Property Map

The daily volume cap for ingestion.

Supporting Types

PrivateLinkScopedResourceResponse

ResourceId string

The full resource Id of the private link scope resource.

ScopeId string

The private link scope unique Identifier.

ResourceId string

The full resource Id of the private link scope resource.

ScopeId string

The private link scope unique Identifier.

resourceId String

The full resource Id of the private link scope resource.

scopeId String

The private link scope unique Identifier.

resourceId string

The full resource Id of the private link scope resource.

scopeId string

The private link scope unique Identifier.

resource_id str

The full resource Id of the private link scope resource.

scope_id str

The private link scope unique Identifier.

resourceId String

The full resource Id of the private link scope resource.

scopeId String

The private link scope unique Identifier.

WorkspaceCappingResponse

DataIngestionStatus string

The status of data ingestion for this workspace.

QuotaNextResetTime string

The time when the quota will be rest.

DailyQuotaGb double

The workspace daily quota for ingestion.

DataIngestionStatus string

The status of data ingestion for this workspace.

QuotaNextResetTime string

The time when the quota will be rest.

DailyQuotaGb float64

The workspace daily quota for ingestion.

dataIngestionStatus String

The status of data ingestion for this workspace.

quotaNextResetTime String

The time when the quota will be rest.

dailyQuotaGb Double

The workspace daily quota for ingestion.

dataIngestionStatus string

The status of data ingestion for this workspace.

quotaNextResetTime string

The time when the quota will be rest.

dailyQuotaGb number

The workspace daily quota for ingestion.

data_ingestion_status str

The status of data ingestion for this workspace.

quota_next_reset_time str

The time when the quota will be rest.

daily_quota_gb float

The workspace daily quota for ingestion.

dataIngestionStatus String

The status of data ingestion for this workspace.

quotaNextResetTime String

The time when the quota will be rest.

dailyQuotaGb Number

The workspace daily quota for ingestion.

WorkspaceFeaturesResponse

ClusterResourceId string

Dedicated LA cluster resourceId that is linked to the workspaces.

DisableLocalAuth bool

Disable Non-AAD based Auth.

EnableDataExport bool

Flag that indicate if data should be exported.

EnableLogAccessUsingOnlyResourcePermissions bool

Flag that indicate which permission to use - resource or workspace or both.

ImmediatePurgeDataOn30Days bool

Flag that describes if we want to remove the data after 30 days.

ClusterResourceId string

Dedicated LA cluster resourceId that is linked to the workspaces.

DisableLocalAuth bool

Disable Non-AAD based Auth.

EnableDataExport bool

Flag that indicate if data should be exported.

EnableLogAccessUsingOnlyResourcePermissions bool

Flag that indicate which permission to use - resource or workspace or both.

ImmediatePurgeDataOn30Days bool

Flag that describes if we want to remove the data after 30 days.

clusterResourceId String

Dedicated LA cluster resourceId that is linked to the workspaces.

disableLocalAuth Boolean

Disable Non-AAD based Auth.

enableDataExport Boolean

Flag that indicate if data should be exported.

enableLogAccessUsingOnlyResourcePermissions Boolean

Flag that indicate which permission to use - resource or workspace or both.

immediatePurgeDataOn30Days Boolean

Flag that describes if we want to remove the data after 30 days.

clusterResourceId string

Dedicated LA cluster resourceId that is linked to the workspaces.

disableLocalAuth boolean

Disable Non-AAD based Auth.

enableDataExport boolean

Flag that indicate if data should be exported.

enableLogAccessUsingOnlyResourcePermissions boolean

Flag that indicate which permission to use - resource or workspace or both.

immediatePurgeDataOn30Days boolean

Flag that describes if we want to remove the data after 30 days.

cluster_resource_id str

Dedicated LA cluster resourceId that is linked to the workspaces.

disable_local_auth bool

Disable Non-AAD based Auth.

enable_data_export bool

Flag that indicate if data should be exported.

enable_log_access_using_only_resource_permissions bool

Flag that indicate which permission to use - resource or workspace or both.

immediate_purge_data_on30_days bool

Flag that describes if we want to remove the data after 30 days.

clusterResourceId String

Dedicated LA cluster resourceId that is linked to the workspaces.

disableLocalAuth Boolean

Disable Non-AAD based Auth.

enableDataExport Boolean

Flag that indicate if data should be exported.

enableLogAccessUsingOnlyResourcePermissions Boolean

Flag that indicate which permission to use - resource or workspace or both.

immediatePurgeDataOn30Days Boolean

Flag that describes if we want to remove the data after 30 days.

WorkspaceSkuResponse

LastSkuUpdate string

The last time when the sku was updated.

Name string

The name of the SKU.

CapacityReservationLevel int

The capacity reservation level for this workspace, when CapacityReservation sku is selected.

LastSkuUpdate string

The last time when the sku was updated.

Name string

The name of the SKU.

CapacityReservationLevel int

The capacity reservation level for this workspace, when CapacityReservation sku is selected.

lastSkuUpdate String

The last time when the sku was updated.

name String

The name of the SKU.

capacityReservationLevel Integer

The capacity reservation level for this workspace, when CapacityReservation sku is selected.

lastSkuUpdate string

The last time when the sku was updated.

name string

The name of the SKU.

capacityReservationLevel number

The capacity reservation level for this workspace, when CapacityReservation sku is selected.

last_sku_update str

The last time when the sku was updated.

name str

The name of the SKU.

capacity_reservation_level int

The capacity reservation level for this workspace, when CapacityReservation sku is selected.

lastSkuUpdate String

The last time when the sku was updated.

name String

The name of the SKU.

capacityReservationLevel Number

The capacity reservation level for this workspace, when CapacityReservation sku is selected.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0