Azure Native v1.103.0, Jun 2 23

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

azure-native.operationalinsights.getTable

Explore with Pulumi AI

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

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:

ResourceGroupName string: The name of the resource group. The name is case insensitive.
TableName string: The name of the table.
WorkspaceName string: The name of the workspace.

ResourceGroupName string: The name of the resource group. The name is case insensitive.
TableName string: The name of the table.
WorkspaceName string: The name of the workspace.

resourceGroupName String: The name of the resource group. The name is case insensitive.
tableName String: The name of the table.
workspaceName String: The name of the workspace.

resourceGroupName string: The name of the resource group. The name is case insensitive.
tableName string: The name of the table.
workspaceName string: The name of the workspace.

resource_group_name str: 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.

resourceGroupName String: The name of the resource group. The name is case insensitive.
tableName String: The name of the table.
workspaceName String: The name of the workspace.

getTable Result

The following output properties are available:

ArchiveRetentionInDays int: 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}
LastPlanModifiedDate string: The timestamp that table plan was last modified (UTC).
Name string: The name of the resource
ProvisioningState 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.
SystemData Pulumi.AzureNative.OperationalInsights.Outputs.SystemDataResponse: 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"
Plan string: Instruct the system how to handle and charge the logs ingested to this table.
RestoredLogs Pulumi.AzureNative.OperationalInsights.Outputs.RestoredLogsResponse: Parameters of the restore operation that initiated this table.
ResultStatistics Pulumi.AzureNative.OperationalInsights.Outputs.ResultStatisticsResponse: Search job execution statistics.
RetentionInDays int: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
Schema Pulumi.AzureNative.OperationalInsights.Outputs.SchemaResponse: Table schema.
SearchResults Pulumi.AzureNative.OperationalInsights.Outputs.SearchResultsResponse: Parameters of the search job that initiated this table.
TotalRetentionInDays int: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.

ArchiveRetentionInDays int: 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}
LastPlanModifiedDate string: The timestamp that table plan was last modified (UTC).
Name string: The name of the resource
ProvisioningState 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.
SystemData SystemDataResponse: 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"
Plan string: Instruct the system how to handle and charge the logs ingested to this table.
RestoredLogs RestoredLogsResponse: Parameters of the restore operation that initiated this table.
ResultStatistics ResultStatisticsResponse: Search job execution statistics.
RetentionInDays int: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
Schema SchemaResponse: Table schema.
SearchResults SearchResultsResponse: Parameters of the search job that initiated this table.
TotalRetentionInDays int: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.

archiveRetentionInDays Integer: 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}
lastPlanModifiedDate String: The timestamp that table plan was last modified (UTC).
name String: The name of the resource
provisioningState 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.
systemData SystemDataResponse: 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"
plan String: Instruct the system how to handle and charge the logs ingested to this table.
restoredLogs RestoredLogsResponse: Parameters of the restore operation that initiated this table.
resultStatistics ResultStatisticsResponse: Search job execution statistics.
retentionInDays Integer: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
schema SchemaResponse: Table schema.
searchResults SearchResultsResponse: Parameters of the search job that initiated this table.
totalRetentionInDays Integer: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.

archiveRetentionInDays number: 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}
lastPlanModifiedDate string: The timestamp that table plan was last modified (UTC).
name string: The name of the resource
provisioningState 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.
systemData SystemDataResponse: 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"
plan string: Instruct the system how to handle and charge the logs ingested to this table.
restoredLogs RestoredLogsResponse: Parameters of the restore operation that initiated this table.
resultStatistics ResultStatisticsResponse: Search job execution statistics.
retentionInDays number: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
schema SchemaResponse: Table schema.
searchResults SearchResultsResponse: Parameters of the search job that initiated this table.
totalRetentionInDays number: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.

archive_retention_in_days int: 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_modified_date str: 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.
system_data SystemDataResponse: 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"
plan str: Instruct the system how to handle and charge the logs ingested to this table.
restored_logs RestoredLogsResponse: Parameters of the restore operation that initiated this table.
result_statistics ResultStatisticsResponse: Search job execution statistics.
retention_in_days int: The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
schema SchemaResponse: Table schema.
search_results SearchResultsResponse: Parameters of the search job that initiated this table.
total_retention_in_days int: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.

archiveRetentionInDays Number: 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}
lastPlanModifiedDate String: The timestamp that table plan was last modified (UTC).
name String: The name of the resource
provisioningState 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.
systemData 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"
plan String: Instruct the system how to handle and charge the logs ingested to this table.
restoredLogs Property Map: Parameters of the restore operation that initiated this table.
resultStatistics Property Map: Search job execution statistics.
retentionInDays Number: 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.
searchResults Property Map: Parameters of the search job that initiated this table.
totalRetentionInDays Number: The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.

Supporting Types

ColumnResponse

IsDefaultDisplay bool: Is displayed by default.
IsHidden bool: Is column hidden.
DataTypeHint string: Column data type logical hint.
Description string: Column description.
DisplayName string: Column display name.
Name string: Column name.
Type string: Column data type.

IsDefaultDisplay bool: Is displayed by default.
IsHidden bool: Is column hidden.
DataTypeHint string: Column data type logical hint.
Description string: Column description.
DisplayName string: Column display name.
Name string: Column name.
Type string: Column data type.

isDefaultDisplay Boolean: Is displayed by default.
isHidden Boolean: Is column hidden.
dataTypeHint String: Column data type logical hint.
description String: Column description.
displayName String: Column display name.
name String: Column name.
type String: Column data type.

isDefaultDisplay boolean: Is displayed by default.
isHidden boolean: Is column hidden.
dataTypeHint string: Column data type logical hint.
description string: Column description.
displayName string: Column display name.
name string: Column name.
type string: Column data type.

is_default_display bool: Is displayed by default.
is_hidden bool: Is column hidden.
data_type_hint str: Column data type logical hint.
description str: Column description.
display_name str: Column display name.
name str: Column name.
type str: Column data type.

isDefaultDisplay Boolean: Is displayed by default.
isHidden Boolean: Is column hidden.
dataTypeHint String: Column data type logical hint.
description String: Column description.
displayName String: Column display name.
name String: Column name.
type String: Column data type.

RestoredLogsResponse

EndRestoreTime string: The timestamp to end the restore by (UTC).
SourceTable string: The table to restore data from.
StartRestoreTime string: The timestamp to start the restore from (UTC).

EndRestoreTime string: The timestamp to end the restore by (UTC).
SourceTable string: The table to restore data from.
StartRestoreTime string: The timestamp to start the restore from (UTC).

endRestoreTime String: The timestamp to end the restore by (UTC).
sourceTable String: The table to restore data from.
startRestoreTime String: The timestamp to start the restore from (UTC).

endRestoreTime string: The timestamp to end the restore by (UTC).
sourceTable string: The table to restore data from.
startRestoreTime string: The timestamp to start the restore from (UTC).

end_restore_time str: The timestamp to end the restore by (UTC).
source_table str: The table to restore data from.
start_restore_time str: The timestamp to start the restore from (UTC).

endRestoreTime String: The timestamp to end the restore by (UTC).
sourceTable String: The table to restore data from.
startRestoreTime String: The timestamp to start the restore from (UTC).

ResultStatisticsResponse

IngestedRecords int: The number of rows that were returned by the search job.
Progress double: Search job completion percentage.

IngestedRecords int: The number of rows that were returned by the search job.
Progress float64: Search job completion percentage.

ingestedRecords Integer: The number of rows that were returned by the search job.
progress Double: Search job completion percentage.

ingestedRecords number: The number of rows that were returned by the search job.
progress number: Search job completion percentage.

ingested_records int: The number of rows that were returned by the search job.
progress float: Search job completion percentage.

ingestedRecords Number: The number of rows that were returned by the search job.
progress Number: Search job completion percentage.

SchemaResponse

Categories List<string>: Table category.
Labels List<string>: Table labels.
RestoredLogs Pulumi.AzureNative.OperationalInsights.Inputs.RestoredLogsResponse: Parameters of the restore operation that initiated this table.
SearchResults Pulumi.AzureNative.OperationalInsights.Inputs.SearchResultsResponse: Parameters of the search job that initiated this table.
Solutions List<string>: List of solutions the table is affiliated with
Source string: Table's creator.
StandardColumns List<Pulumi.AzureNative.OperationalInsights.Inputs.ColumnResponse>: A list of table standard columns.
TableSubType string: The subtype describes what APIs can be used to interact with the table, and what features are available against it.
TableType string: Table's creator.
Columns List<Pulumi.AzureNative.OperationalInsights.Inputs.ColumnResponse>: A list of table custom columns.
Description string: Table description.
DisplayName string: Table display name.
Name string: Table name.

Categories []string: Table category.
Labels []string: Table labels.
RestoredLogs RestoredLogsResponse: Parameters of the restore operation that initiated this table.
SearchResults SearchResultsResponse: Parameters of the search job that initiated this table.
Solutions []string: List of solutions the table is affiliated with
Source string: Table's creator.
StandardColumns []ColumnResponse: A list of table standard columns.
TableSubType string: The subtype describes what APIs can be used to interact with the table, and what features are available against it.
TableType string: Table's creator.
Columns []ColumnResponse: A list of table custom columns.
Description string: Table description.
DisplayName string: Table display name.
Name string: Table name.

categories List<String>: Table category.
labels List<String>: Table labels.
restoredLogs RestoredLogsResponse: Parameters of the restore operation that initiated this table.
searchResults SearchResultsResponse: Parameters of the search job that initiated this table.
solutions List<String>: List of solutions the table is affiliated with
source String: Table's creator.
standardColumns List<ColumnResponse>: A list of table standard columns.
tableSubType String: The subtype describes what APIs can be used to interact with the table, and what features are available against it.
tableType String: Table's creator.
columns List<ColumnResponse>: A list of table custom columns.
description String: Table description.
displayName String: Table display name.
name String: Table name.

categories string[]: Table category.
labels string[]: Table labels.
restoredLogs RestoredLogsResponse: Parameters of the restore operation that initiated this table.
searchResults SearchResultsResponse: Parameters of the search job that initiated this table.
solutions string[]: List of solutions the table is affiliated with
source string: Table's creator.
standardColumns ColumnResponse[]: A list of table standard columns.
tableSubType string: The subtype describes what APIs can be used to interact with the table, and what features are available against it.
tableType string: Table's creator.
columns ColumnResponse[]: A list of table custom columns.
description string: Table description.
displayName string: Table display name.
name string: Table name.

categories Sequence[str]: Table category.
labels Sequence[str]: Table labels.
restored_logs RestoredLogsResponse: Parameters of the restore operation that initiated this table.
search_results SearchResultsResponse: Parameters of the search job that initiated this table.
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_type str: 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[ColumnResponse]: 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.
restoredLogs Property Map: Parameters of the restore operation that initiated this table.
searchResults Property Map: Parameters of the search job that initiated this table.
solutions List<String>: List of solutions the table is affiliated with
source String: Table's creator.
standardColumns List<Property Map>: A list of table standard columns.
tableSubType String: The subtype describes what APIs can be used to interact with the table, and what features are available against it.
tableType String: Table's creator.
columns List<Property Map>: A list of table custom columns.
description String: Table description.
displayName String: Table display name.
name String: Table name.

SearchResultsResponse

SourceTable string: The table used in the search job.
Description string: Search job Description.
EndSearchTime string: 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.
StartSearchTime string: The timestamp to start the search from (UTC)

SourceTable string: The table used in the search job.
Description string: Search job Description.
EndSearchTime string: 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.
StartSearchTime string: The timestamp to start the search from (UTC)

sourceTable String: The table used in the search job.
description String: Search job Description.
endSearchTime String: 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.
startSearchTime String: The timestamp to start the search from (UTC)

sourceTable string: The table used in the search job.
description string: Search job Description.
endSearchTime string: 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.
startSearchTime string: The timestamp to start the search from (UTC)

source_table str: The table used in the search job.
description str: Search job Description.
end_search_time str: 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_time str: The timestamp to start the search from (UTC)

sourceTable String: The table used in the search job.
description String: Search job Description.
endSearchTime String: 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.
startSearchTime String: The timestamp to start the search from (UTC)

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: 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_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

Package Details

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

Azure Native v1.103.0 published on Friday, Jun 2, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.operationalinsights.getTable

On this page

On this page

Using getTable

getTable Result

Supporting Types

ColumnResponse

RestoredLogsResponse

ResultStatisticsResponse

SchemaResponse

SearchResultsResponse

SystemDataResponse

Package Details

On this page

On this page