azure-native.operationalinsights.getWorkspace
Explore with Pulumi AI
Gets a workspace instance. Azure REST API version: 2022-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:
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Workspace
Name string The name of the workspace.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Workspace
Name string The name of the workspace.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- workspace
Name String The name of the workspace.
- resource
Group stringName The name of the resource group. The name is case insensitive.
- workspace
Name string The name of the workspace.
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- workspace_
name str The name of the workspace.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- workspace
Name String The name of the workspace.
getWorkspace Result
The following output properties are available:
- Created
Date string Workspace creation date.
- Customer
Id 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
- Modified
Date string Workspace modification date.
- Name string
The name of the resource
- Private
Link List<Pulumi.Scoped Resources Azure Native. Operational Insights. Outputs. Private Link Scoped Resource Response> List of linked private link scope resources.
- Provisioning
State string The provisioning state of the workspace.
- System
Data Pulumi.Azure Native. Operational Insights. Outputs. System Data Response Metadata pertaining to creation and last modification of the resource.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Default
Data stringCollection Rule Resource Id The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
- Etag string
The etag of the workspace.
- Features
Pulumi.
Azure Native. Operational Insights. Outputs. Workspace Features Response Workspace features.
- Force
Cmk boolFor Query Indicates whether customer managed storage is mandatory for query management.
- Identity
Pulumi.
Azure Native. Operational Insights. Outputs. Identity Response The identity of the resource.
- Public
Network stringAccess For Ingestion The network access type for accessing Log Analytics ingestion.
- Public
Network stringAccess For Query The network access type for accessing Log Analytics query.
- Retention
In intDays The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
- Sku
Pulumi.
Azure Native. Operational Insights. Outputs. Workspace Sku Response The SKU of the workspace.
- Dictionary<string, string>
Resource tags.
- Workspace
Capping Pulumi.Azure Native. Operational Insights. Outputs. Workspace Capping Response The daily volume cap for ingestion.
- Created
Date string Workspace creation date.
- Customer
Id 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
- Modified
Date string Workspace modification date.
- Name string
The name of the resource
- Private
Link []PrivateScoped Resources Link Scoped Resource Response List of linked private link scope resources.
- Provisioning
State string The provisioning state of the workspace.
- System
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Default
Data stringCollection Rule Resource Id The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
- Etag string
The etag of the workspace.
- Features
Workspace
Features Response Workspace features.
- Force
Cmk boolFor Query Indicates whether customer managed storage is mandatory for query management.
- Identity
Identity
Response The identity of the resource.
- Public
Network stringAccess For Ingestion The network access type for accessing Log Analytics ingestion.
- Public
Network stringAccess For Query The network access type for accessing Log Analytics query.
- Retention
In intDays The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
- Sku
Workspace
Sku Response The SKU of the workspace.
- map[string]string
Resource tags.
- Workspace
Capping WorkspaceCapping Response The daily volume cap for ingestion.
- created
Date String Workspace creation date.
- customer
Id 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
- modified
Date String Workspace modification date.
- name String
The name of the resource
- private
Link List<PrivateScoped Resources Link Scoped Resource Response> List of linked private link scope resources.
- provisioning
State String The provisioning state of the workspace.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- default
Data StringCollection Rule Resource Id The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
- etag String
The etag of the workspace.
- features
Workspace
Features Response Workspace features.
- force
Cmk BooleanFor Query Indicates whether customer managed storage is mandatory for query management.
- identity
Identity
Response The identity of the resource.
- public
Network StringAccess For Ingestion The network access type for accessing Log Analytics ingestion.
- public
Network StringAccess For Query The network access type for accessing Log Analytics query.
- retention
In IntegerDays The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
- sku
Workspace
Sku Response The SKU of the workspace.
- Map<String,String>
Resource tags.
- workspace
Capping WorkspaceCapping Response The daily volume cap for ingestion.
- created
Date string Workspace creation date.
- customer
Id 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
- modified
Date string Workspace modification date.
- name string
The name of the resource
- private
Link PrivateScoped Resources Link Scoped Resource Response[] List of linked private link scope resources.
- provisioning
State string The provisioning state of the workspace.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- default
Data stringCollection Rule Resource Id The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
- etag string
The etag of the workspace.
- features
Workspace
Features Response Workspace features.
- force
Cmk booleanFor Query Indicates whether customer managed storage is mandatory for query management.
- identity
Identity
Response The identity of the resource.
- public
Network stringAccess For Ingestion The network access type for accessing Log Analytics ingestion.
- public
Network stringAccess For Query The network access type for accessing Log Analytics query.
- retention
In numberDays The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
- sku
Workspace
Sku Response The SKU of the workspace.
- {[key: string]: string}
Resource tags.
- workspace
Capping WorkspaceCapping Response 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_ Sequence[Privatescoped_ resources Link Scoped Resource Response] List of linked private link scope resources.
- provisioning_
state str The provisioning state of the workspace.
- system_
data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- default_
data_ strcollection_ rule_ resource_ id The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
- etag str
The etag of the workspace.
- features
Workspace
Features Response Workspace features.
- force_
cmk_ boolfor_ query Indicates whether customer managed storage is mandatory for query management.
- identity
Identity
Response The identity of the resource.
- public_
network_ straccess_ for_ ingestion The network access type for accessing Log Analytics ingestion.
- public_
network_ straccess_ for_ query The network access type for accessing Log Analytics query.
- retention_
in_ intdays The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
- sku
Workspace
Sku Response The SKU of the workspace.
- Mapping[str, str]
Resource tags.
- workspace_
capping WorkspaceCapping Response The daily volume cap for ingestion.
- created
Date String Workspace creation date.
- customer
Id 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
- modified
Date String Workspace modification date.
- name String
The name of the resource
- private
Link List<Property Map>Scoped Resources List of linked private link scope resources.
- provisioning
State String The provisioning state of the workspace.
- system
Data Property Map Metadata pertaining to creation and last modification of the resource.
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- default
Data StringCollection Rule Resource Id The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
- etag String
The etag of the workspace.
- features Property Map
Workspace features.
- force
Cmk BooleanFor Query Indicates whether customer managed storage is mandatory for query management.
- identity Property Map
The identity of the resource.
- public
Network StringAccess For Ingestion The network access type for accessing Log Analytics ingestion.
- public
Network StringAccess For Query The network access type for accessing Log Analytics query.
- retention
In NumberDays 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.
- Map<String>
Resource tags.
- workspace
Capping Property Map The daily volume cap for ingestion.
Supporting Types
IdentityResponse
- Principal
Id string The principal ID of resource identity.
- Tenant
Id string The tenant ID of resource.
- Type string
Type of managed service identity.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Operational Insights. Inputs. User Identity Properties Response> The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- Principal
Id string The principal ID of resource identity.
- Tenant
Id string The tenant ID of resource.
- Type string
Type of managed service identity.
- User
Assigned map[string]UserIdentities Identity Properties Response The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal
Id String The principal ID of resource identity.
- tenant
Id String The tenant ID of resource.
- type String
Type of managed service identity.
- user
Assigned Map<String,UserIdentities Identity Properties Response> The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal
Id string The principal ID of resource identity.
- tenant
Id string The tenant ID of resource.
- type string
Type of managed service identity.
- user
Assigned {[key: string]: UserIdentities Identity Properties Response} The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal_
id str The principal ID of resource identity.
- tenant_
id str The tenant ID of resource.
- type str
Type of managed service identity.
- user_
assigned_ Mapping[str, Useridentities Identity Properties Response] The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
- principal
Id String The principal ID of resource identity.
- tenant
Id String The tenant ID of resource.
- type String
Type of managed service identity.
- user
Assigned Map<Property Map>Identities The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
PrivateLinkScopedResourceResponse
- Resource
Id string The full resource Id of the private link scope resource.
- Scope
Id string The private link scope unique Identifier.
- Resource
Id string The full resource Id of the private link scope resource.
- Scope
Id string The private link scope unique Identifier.
- resource
Id String The full resource Id of the private link scope resource.
- scope
Id String The private link scope unique Identifier.
- resource
Id string The full resource Id of the private link scope resource.
- scope
Id 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.
- resource
Id String The full resource Id of the private link scope resource.
- scope
Id String The private link scope unique Identifier.
SystemDataResponse
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type The type of identity that last modified the resource.
- created_
at str The timestamp of resource creation (UTC).
- created_
by str The identity that created the resource.
- created_
by_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
UserIdentityPropertiesResponse
- Client
Id string The client id of user assigned identity.
- Principal
Id string The principal id of user assigned identity.
- Client
Id string The client id of user assigned identity.
- Principal
Id string The principal id of user assigned identity.
- client
Id String The client id of user assigned identity.
- principal
Id String The principal id of user assigned identity.
- client
Id string The client id of user assigned identity.
- principal
Id string The principal id of user assigned identity.
- client_
id str The client id of user assigned identity.
- principal_
id str The principal id of user assigned identity.
- client
Id String The client id of user assigned identity.
- principal
Id String The principal id of user assigned identity.
WorkspaceCappingResponse
- Data
Ingestion stringStatus The status of data ingestion for this workspace.
- Quota
Next stringReset Time The time when the quota will be rest.
- Daily
Quota doubleGb The workspace daily quota for ingestion.
- Data
Ingestion stringStatus The status of data ingestion for this workspace.
- Quota
Next stringReset Time The time when the quota will be rest.
- Daily
Quota float64Gb The workspace daily quota for ingestion.
- data
Ingestion StringStatus The status of data ingestion for this workspace.
- quota
Next StringReset Time The time when the quota will be rest.
- daily
Quota DoubleGb The workspace daily quota for ingestion.
- data
Ingestion stringStatus The status of data ingestion for this workspace.
- quota
Next stringReset Time The time when the quota will be rest.
- daily
Quota numberGb The workspace daily quota for ingestion.
- data_
ingestion_ strstatus The status of data ingestion for this workspace.
- quota_
next_ strreset_ time The time when the quota will be rest.
- daily_
quota_ floatgb The workspace daily quota for ingestion.
- data
Ingestion StringStatus The status of data ingestion for this workspace.
- quota
Next StringReset Time The time when the quota will be rest.
- daily
Quota NumberGb The workspace daily quota for ingestion.
WorkspaceFeaturesResponse
- Cluster
Resource stringId Dedicated LA cluster resourceId that is linked to the workspaces.
- Disable
Local boolAuth Disable Non-AAD based Auth.
- Enable
Data boolExport Flag that indicate if data should be exported.
- Enable
Log boolAccess Using Only Resource Permissions Flag that indicate which permission to use - resource or workspace or both.
- Immediate
Purge boolData On30Days Flag that describes if we want to remove the data after 30 days.
- Cluster
Resource stringId Dedicated LA cluster resourceId that is linked to the workspaces.
- Disable
Local boolAuth Disable Non-AAD based Auth.
- Enable
Data boolExport Flag that indicate if data should be exported.
- Enable
Log boolAccess Using Only Resource Permissions Flag that indicate which permission to use - resource or workspace or both.
- Immediate
Purge boolData On30Days Flag that describes if we want to remove the data after 30 days.
- cluster
Resource StringId Dedicated LA cluster resourceId that is linked to the workspaces.
- disable
Local BooleanAuth Disable Non-AAD based Auth.
- enable
Data BooleanExport Flag that indicate if data should be exported.
- enable
Log BooleanAccess Using Only Resource Permissions Flag that indicate which permission to use - resource or workspace or both.
- immediate
Purge BooleanData On30Days Flag that describes if we want to remove the data after 30 days.
- cluster
Resource stringId Dedicated LA cluster resourceId that is linked to the workspaces.
- disable
Local booleanAuth Disable Non-AAD based Auth.
- enable
Data booleanExport Flag that indicate if data should be exported.
- enable
Log booleanAccess Using Only Resource Permissions Flag that indicate which permission to use - resource or workspace or both.
- immediate
Purge booleanData On30Days Flag that describes if we want to remove the data after 30 days.
- cluster_
resource_ strid Dedicated LA cluster resourceId that is linked to the workspaces.
- disable_
local_ boolauth Disable Non-AAD based Auth.
- enable_
data_ boolexport Flag that indicate if data should be exported.
- enable_
log_ boolaccess_ using_ only_ resource_ permissions Flag that indicate which permission to use - resource or workspace or both.
- immediate_
purge_ booldata_ on30_ days Flag that describes if we want to remove the data after 30 days.
- cluster
Resource StringId Dedicated LA cluster resourceId that is linked to the workspaces.
- disable
Local BooleanAuth Disable Non-AAD based Auth.
- enable
Data BooleanExport Flag that indicate if data should be exported.
- enable
Log BooleanAccess Using Only Resource Permissions Flag that indicate which permission to use - resource or workspace or both.
- immediate
Purge BooleanData On30Days Flag that describes if we want to remove the data after 30 days.
WorkspaceSkuResponse
- Last
Sku stringUpdate The last time when the sku was updated.
- Name string
The name of the SKU.
- Capacity
Reservation intLevel The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
- Last
Sku stringUpdate The last time when the sku was updated.
- Name string
The name of the SKU.
- Capacity
Reservation intLevel The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
- last
Sku StringUpdate The last time when the sku was updated.
- name String
The name of the SKU.
- capacity
Reservation IntegerLevel The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
- last
Sku stringUpdate The last time when the sku was updated.
- name string
The name of the SKU.
- capacity
Reservation numberLevel The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
- last_
sku_ strupdate The last time when the sku was updated.
- name str
The name of the SKU.
- capacity_
reservation_ intlevel The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
- last
Sku StringUpdate The last time when the sku was updated.
- name String
The name of the SKU.
- capacity
Reservation NumberLevel The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0