This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi
azure-native.operationalinsights.getTable
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi
Gets a Log Analytics workspace table. Azure REST API version: 2022-10-01.
Using getTable
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 getTable(args: GetTableArgs, opts?: InvokeOptions): Promise<GetTableResult>
function getTableOutput(args: GetTableOutputArgs, opts?: InvokeOptions): Output<GetTableResult>
def get_table(resource_group_name: Optional[str] = None,
table_name: Optional[str] = None,
workspace_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(resource_group_name: Optional[pulumi.Input[str]] = None,
table_name: Optional[pulumi.Input[str]] = None,
workspace_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTableResult]
func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput
> Note: This function is named LookupTable
in the Go SDK.
public static class GetTable
{
public static Task<GetTableResult> InvokeAsync(GetTableArgs args, InvokeOptions? opts = null)
public static Output<GetTableResult> Invoke(GetTableInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:operationalinsights:getTable
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Table
Name string - The name of the table.
- Workspace
Name string - The name of the workspace.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Table
Name string - The name of the table.
- Workspace
Name string - The name of the workspace.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- table
Name String - The name of the table.
- workspace
Name String - The name of the workspace.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- table
Name string - The name of the table.
- workspace
Name string - The name of the workspace.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- table_
name str - The name of the table.
- workspace_
name str - The name of the workspace.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- table
Name String - The name of the table.
- workspace
Name String - The name of the workspace.
getTable Result
The following output properties are available:
- Archive
Retention intIn Days - The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays)
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Last
Plan stringModified Date - The timestamp that table plan was last modified (UTC).
- Name string
- The name of the resource
- Provisioning
State string - Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
- Result
Statistics Pulumi.Azure Native. Operational Insights. Outputs. Result Statistics Response - Search job execution statistics.
- Retention
In boolDays As Default - True - Value originates from workspace retention in days, False - Customer specific.
- System
Data Pulumi.Azure Native. Operational Insights. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Total
Retention boolIn Days As Default - True - Value originates from retention in days, False - Customer specific.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Plan string
- Instruct the system how to handle and charge the logs ingested to this table.
- Restored
Logs Pulumi.Azure Native. Operational Insights. Outputs. Restored Logs Response - Parameters of the restore operation that initiated this table.
- Retention
In intDays - The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
- Schema
Pulumi.
Azure Native. Operational Insights. Outputs. Schema Response - Table schema.
- Search
Results Pulumi.Azure Native. Operational Insights. Outputs. Search Results Response - Parameters of the search job that initiated this table.
- Total
Retention intIn Days - The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention.
- Archive
Retention intIn Days - The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays)
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Last
Plan stringModified Date - The timestamp that table plan was last modified (UTC).
- Name string
- The name of the resource
- Provisioning
State string - Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
- Result
Statistics ResultStatistics Response - Search job execution statistics.
- Retention
In boolDays As Default - True - Value originates from workspace retention in days, False - Customer specific.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Total
Retention boolIn Days As Default - True - Value originates from retention in days, False - Customer specific.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Plan string
- Instruct the system how to handle and charge the logs ingested to this table.
- Restored
Logs RestoredLogs Response - Parameters of the restore operation that initiated this table.
- Retention
In intDays - The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
- Schema
Schema
Response - Table schema.
- Search
Results SearchResults Response - Parameters of the search job that initiated this table.
- Total
Retention intIn Days - The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention.
- archive
Retention IntegerIn Days - The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays)
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last
Plan StringModified Date - The timestamp that table plan was last modified (UTC).
- name String
- The name of the resource
- provisioning
State String - Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
- result
Statistics ResultStatistics Response - Search job execution statistics.
- retention
In BooleanDays As Default - True - Value originates from workspace retention in days, False - Customer specific.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- total
Retention BooleanIn Days As Default - True - Value originates from retention in days, False - Customer specific.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- plan String
- Instruct the system how to handle and charge the logs ingested to this table.
- restored
Logs RestoredLogs Response - Parameters of the restore operation that initiated this table.
- retention
In IntegerDays - The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
- schema
Schema
Response - Table schema.
- search
Results SearchResults Response - Parameters of the search job that initiated this table.
- total
Retention IntegerIn Days - The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention.
- archive
Retention numberIn Days - The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays)
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last
Plan stringModified Date - The timestamp that table plan was last modified (UTC).
- name string
- The name of the resource
- provisioning
State string - Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
- result
Statistics ResultStatistics Response - Search job execution statistics.
- retention
In booleanDays As Default - True - Value originates from workspace retention in days, False - Customer specific.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- total
Retention booleanIn Days As Default - True - Value originates from retention in days, False - Customer specific.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- plan string
- Instruct the system how to handle and charge the logs ingested to this table.
- restored
Logs RestoredLogs Response - Parameters of the restore operation that initiated this table.
- retention
In numberDays - The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
- schema
Schema
Response - Table schema.
- search
Results SearchResults Response - Parameters of the search job that initiated this table.
- total
Retention numberIn Days - The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention.
- archive_
retention_ intin_ days - The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays)
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last_
plan_ strmodified_ date - The timestamp that table plan was last modified (UTC).
- name str
- The name of the resource
- provisioning_
state str - Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
- result_
statistics ResultStatistics Response - Search job execution statistics.
- retention_
in_ booldays_ as_ default - True - Value originates from workspace retention in days, False - Customer specific.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- total_
retention_ boolin_ days_ as_ default - True - Value originates from retention in days, False - Customer specific.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- plan str
- Instruct the system how to handle and charge the logs ingested to this table.
- restored_
logs RestoredLogs Response - Parameters of the restore operation that initiated this table.
- retention_
in_ intdays - The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
- schema
Schema
Response - Table schema.
- search_
results SearchResults Response - Parameters of the search job that initiated this table.
- total_
retention_ intin_ days - The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention.
- archive
Retention NumberIn Days - The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays)
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- last
Plan StringModified Date - The timestamp that table plan was last modified (UTC).
- name String
- The name of the resource
- provisioning
State String - Table's current provisioning state. If set to 'updating', indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
- result
Statistics Property Map - Search job execution statistics.
- retention
In BooleanDays As Default - True - Value originates from workspace retention in days, False - Customer specific.
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- total
Retention BooleanIn Days As Default - True - Value originates from retention in days, False - Customer specific.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- plan String
- Instruct the system how to handle and charge the logs ingested to this table.
- restored
Logs Property Map - Parameters of the restore operation that initiated this table.
- retention
In NumberDays - The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
- schema Property Map
- Table schema.
- search
Results Property Map - Parameters of the search job that initiated this table.
- total
Retention NumberIn Days - The table total retention in days, between 4 and 4383. Setting this property to -1 will default to table retention.
Supporting Types
ColumnResponse
- Is
Default boolDisplay - Is displayed by default.
- bool
- Is column hidden.
- Data
Type stringHint - Column data type logical hint.
- Description string
- Column description.
- Display
Name string - Column display name.
- Name string
- Column name.
- Type string
- Column data type.
- Is
Default boolDisplay - Is displayed by default.
- bool
- Is column hidden.
- Data
Type stringHint - Column data type logical hint.
- Description string
- Column description.
- Display
Name string - Column display name.
- Name string
- Column name.
- Type string
- Column data type.
- is
Default BooleanDisplay - Is displayed by default.
- Boolean
- Is column hidden.
- data
Type StringHint - Column data type logical hint.
- description String
- Column description.
- display
Name String - Column display name.
- name String
- Column name.
- type String
- Column data type.
- is
Default booleanDisplay - Is displayed by default.
- boolean
- Is column hidden.
- data
Type stringHint - Column data type logical hint.
- description string
- Column description.
- display
Name string - Column display name.
- name string
- Column name.
- type string
- Column data type.
- is_
default_ booldisplay - Is displayed by default.
- bool
- Is column hidden.
- data_
type_ strhint - Column data type logical hint.
- description str
- Column description.
- display_
name str - Column display name.
- name str
- Column name.
- type str
- Column data type.
- is
Default BooleanDisplay - Is displayed by default.
- Boolean
- Is column hidden.
- data
Type StringHint - Column data type logical hint.
- description String
- Column description.
- display
Name String - Column display name.
- name String
- Column name.
- type String
- Column data type.
RestoredLogsResponse
- Azure
Async stringOperation Id - Search results table async operation id.
- End
Restore stringTime - The timestamp to end the restore by (UTC).
- Source
Table string - The table to restore data from.
- Start
Restore stringTime - The timestamp to start the restore from (UTC).
- Azure
Async stringOperation Id - Search results table async operation id.
- End
Restore stringTime - The timestamp to end the restore by (UTC).
- Source
Table string - The table to restore data from.
- Start
Restore stringTime - The timestamp to start the restore from (UTC).
- azure
Async StringOperation Id - Search results table async operation id.
- end
Restore StringTime - The timestamp to end the restore by (UTC).
- source
Table String - The table to restore data from.
- start
Restore StringTime - The timestamp to start the restore from (UTC).
- azure
Async stringOperation Id - Search results table async operation id.
- end
Restore stringTime - The timestamp to end the restore by (UTC).
- source
Table string - The table to restore data from.
- start
Restore stringTime - The timestamp to start the restore from (UTC).
- azure_
async_ stroperation_ id - Search results table async operation id.
- end_
restore_ strtime - The timestamp to end the restore by (UTC).
- source_
table str - The table to restore data from.
- start_
restore_ strtime - The timestamp to start the restore from (UTC).
- azure
Async StringOperation Id - Search results table async operation id.
- end
Restore StringTime - The timestamp to end the restore by (UTC).
- source
Table String - The table to restore data from.
- start
Restore StringTime - The timestamp to start the restore from (UTC).
ResultStatisticsResponse
- Ingested
Records int - The number of rows that were returned by the search job.
- Progress double
- Search job completion percentage.
- Scanned
Gb double - Search job: Amount of scanned data.
- Ingested
Records int - The number of rows that were returned by the search job.
- Progress float64
- Search job completion percentage.
- Scanned
Gb float64 - Search job: Amount of scanned data.
- ingested
Records Integer - The number of rows that were returned by the search job.
- progress Double
- Search job completion percentage.
- scanned
Gb Double - Search job: Amount of scanned data.
- ingested
Records number - The number of rows that were returned by the search job.
- progress number
- Search job completion percentage.
- scanned
Gb number - Search job: Amount of scanned data.
- ingested_
records int - The number of rows that were returned by the search job.
- progress float
- Search job completion percentage.
- scanned_
gb float - Search job: Amount of scanned data.
- ingested
Records Number - The number of rows that were returned by the search job.
- progress Number
- Search job completion percentage.
- scanned
Gb Number - Search job: Amount of scanned data.
SchemaResponse
- Categories List<string>
- Table category.
- Labels List<string>
- Table labels.
- Solutions List<string>
- List of solutions the table is affiliated with
- Source string
- Table's creator.
- Standard
Columns List<Pulumi.Azure Native. Operational Insights. Inputs. Column Response> - A list of table standard columns.
- Table
Sub stringType - The subtype describes what APIs can be used to interact with the table, and what features are available against it.
- Table
Type string - Table's creator.
- Columns
List<Pulumi.
Azure Native. Operational Insights. Inputs. Column Response> - A list of table custom columns.
- Description string
- Table description.
- Display
Name string - Table display name.
- Name string
- Table name.
- Categories []string
- Table category.
- Labels []string
- Table labels.
- Solutions []string
- List of solutions the table is affiliated with
- Source string
- Table's creator.
- Standard
Columns []ColumnResponse - A list of table standard columns.
- Table
Sub stringType - The subtype describes what APIs can be used to interact with the table, and what features are available against it.
- Table
Type string - Table's creator.
- Columns
[]Column
Response - A list of table custom columns.
- Description string
- Table description.
- Display
Name string - Table display name.
- Name string
- Table name.
- categories List<String>
- Table category.
- labels List<String>
- Table labels.
- solutions List<String>
- List of solutions the table is affiliated with
- source String
- Table's creator.
- standard
Columns List<ColumnResponse> - A list of table standard columns.
- table
Sub StringType - The subtype describes what APIs can be used to interact with the table, and what features are available against it.
- table
Type String - Table's creator.
- columns
List<Column
Response> - A list of table custom columns.
- description String
- Table description.
- display
Name String - Table display name.
- name String
- Table name.
- categories string[]
- Table category.
- labels string[]
- Table labels.
- solutions string[]
- List of solutions the table is affiliated with
- source string
- Table's creator.
- standard
Columns ColumnResponse[] - A list of table standard columns.
- table
Sub stringType - The subtype describes what APIs can be used to interact with the table, and what features are available against it.
- table
Type string - Table's creator.
- columns
Column
Response[] - A list of table custom columns.
- description string
- Table description.
- display
Name string - Table display name.
- name string
- Table name.
- categories Sequence[str]
- Table category.
- labels Sequence[str]
- Table labels.
- solutions Sequence[str]
- List of solutions the table is affiliated with
- source str
- Table's creator.
- standard_
columns Sequence[ColumnResponse] - A list of table standard columns.
- table_
sub_ strtype - The subtype describes what APIs can be used to interact with the table, and what features are available against it.
- table_
type str - Table's creator.
- columns
Sequence[Column
Response] - A list of table custom columns.
- description str
- Table description.
- display_
name str - Table display name.
- name str
- Table name.
- categories List<String>
- Table category.
- labels List<String>
- Table labels.
- solutions List<String>
- List of solutions the table is affiliated with
- source String
- Table's creator.
- standard
Columns List<Property Map> - A list of table standard columns.
- table
Sub StringType - The subtype describes what APIs can be used to interact with the table, and what features are available against it.
- table
Type String - Table's creator.
- columns List<Property Map>
- A list of table custom columns.
- description String
- Table description.
- display
Name String - Table display name.
- name String
- Table name.
SearchResultsResponse
- Azure
Async stringOperation Id - Search results table async operation id.
- Source
Table string - The table used in the search job.
- Description string
- Search job Description.
- End
Search stringTime - The timestamp to end the search by (UTC)
- Limit int
- Limit the search job to return up to specified number of rows.
- Query string
- Search job query.
- Start
Search stringTime - The timestamp to start the search from (UTC)
- Azure
Async stringOperation Id - Search results table async operation id.
- Source
Table string - The table used in the search job.
- Description string
- Search job Description.
- End
Search stringTime - The timestamp to end the search by (UTC)
- Limit int
- Limit the search job to return up to specified number of rows.
- Query string
- Search job query.
- Start
Search stringTime - The timestamp to start the search from (UTC)
- azure
Async StringOperation Id - Search results table async operation id.
- source
Table String - The table used in the search job.
- description String
- Search job Description.
- end
Search StringTime - The timestamp to end the search by (UTC)
- limit Integer
- Limit the search job to return up to specified number of rows.
- query String
- Search job query.
- start
Search StringTime - The timestamp to start the search from (UTC)
- azure
Async stringOperation Id - Search results table async operation id.
- source
Table string - The table used in the search job.
- description string
- Search job Description.
- end
Search stringTime - The timestamp to end the search by (UTC)
- limit number
- Limit the search job to return up to specified number of rows.
- query string
- Search job query.
- start
Search stringTime - The timestamp to start the search from (UTC)
- azure_
async_ stroperation_ id - Search results table async operation id.
- source_
table str - The table used in the search job.
- description str
- Search job Description.
- end_
search_ strtime - The timestamp to end the search by (UTC)
- limit int
- Limit the search job to return up to specified number of rows.
- query str
- Search job query.
- start_
search_ strtime - The timestamp to start the search from (UTC)
- azure
Async StringOperation Id - Search results table async operation id.
- source
Table String - The table used in the search job.
- description String
- Search job Description.
- end
Search StringTime - The timestamp to end the search by (UTC)
- limit Number
- Limit the search job to return up to specified number of rows.
- query String
- Search job query.
- start
Search StringTime - The timestamp to start the search from (UTC)
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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi