tables

package
v0.20241209.1115630 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 15 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/operationalinsights/2023-09-01/tables Documentation

The tables SDK allows for interaction with Azure Resource Manager operationalinsights (API Version 2023-09-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/operationalinsights/2023-09-01/tables"

Client Initialization

client := tables.NewTablesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: TablesClient.CancelSearch

ctx := context.TODO()
id := tables.NewTableID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "tableName")

read, err := client.CancelSearch(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TablesClient.CreateOrUpdate

ctx := context.TODO()
id := tables.NewTableID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "tableName")

payload := tables.Table{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: TablesClient.Delete

ctx := context.TODO()
id := tables.NewTableID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "tableName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: TablesClient.Get

ctx := context.TODO()
id := tables.NewTableID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "tableName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TablesClient.ListByWorkspace

ctx := context.TODO()
id := tables.NewWorkspaceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName")

read, err := client.ListByWorkspace(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TablesClient.Migrate

ctx := context.TODO()
id := tables.NewTableID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "tableName")

read, err := client.Migrate(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: TablesClient.Update

ctx := context.TODO()
id := tables.NewTableID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workspaceName", "tableName")

payload := tables.Table{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForColumnDataTypeHintEnum 

func PossibleValuesForColumnDataTypeHintEnum() []string

func PossibleValuesForColumnTypeEnum 

func PossibleValuesForColumnTypeEnum() []string

func PossibleValuesForProvisioningStateEnum 

func PossibleValuesForProvisioningStateEnum() []string

func PossibleValuesForSourceEnum 

func PossibleValuesForSourceEnum() []string

func PossibleValuesForTablePlanEnum 

func PossibleValuesForTablePlanEnum() []string

func PossibleValuesForTableSubTypeEnum 

func PossibleValuesForTableSubTypeEnum() []string

func PossibleValuesForTableTypeEnum 

func PossibleValuesForTableTypeEnum() []string

func ValidateTableID 

func ValidateTableID(input interface{}, key string) (warnings []string, errors []error)

ValidateTableID checks that 'input' can be parsed as a Table ID

func ValidateWorkspaceID 

func ValidateWorkspaceID(input interface{}, key string) (warnings []string, errors []error)

ValidateWorkspaceID checks that 'input' can be parsed as a Workspace ID

Types

type CancelSearchOperationResponse 

type CancelSearchOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type Column 

type Column struct {
	DataTypeHint     *ColumnDataTypeHintEnum `json:"dataTypeHint,omitempty"`
	Description      *string                 `json:"description,omitempty"`
	DisplayName      *string                 `json:"displayName,omitempty"`
	IsDefaultDisplay *bool                   `json:"isDefaultDisplay,omitempty"`
	IsHidden         *bool                   `json:"isHidden,omitempty"`
	Name             *string                 `json:"name,omitempty"`
	Type             *ColumnTypeEnum         `json:"type,omitempty"`
}

type ColumnDataTypeHintEnum 

type ColumnDataTypeHintEnum string
const (
	ColumnDataTypeHintEnumArmPath ColumnDataTypeHintEnum = "armPath"
	ColumnDataTypeHintEnumGuid    ColumnDataTypeHintEnum = "guid"
	ColumnDataTypeHintEnumIP      ColumnDataTypeHintEnum = "ip"
	ColumnDataTypeHintEnumUri     ColumnDataTypeHintEnum = "uri"
)

func (*ColumnDataTypeHintEnum) UnmarshalJSON 

func (s *ColumnDataTypeHintEnum) UnmarshalJSON(bytes []byte) error

type ColumnTypeEnum 

type ColumnTypeEnum string
const (
	ColumnTypeEnumBoolean  ColumnTypeEnum = "boolean"
	ColumnTypeEnumDateTime ColumnTypeEnum = "dateTime"
	ColumnTypeEnumDynamic  ColumnTypeEnum = "dynamic"
	ColumnTypeEnumGuid     ColumnTypeEnum = "guid"
	ColumnTypeEnumInt      ColumnTypeEnum = "int"
	ColumnTypeEnumLong     ColumnTypeEnum = "long"
	ColumnTypeEnumReal     ColumnTypeEnum = "real"
	ColumnTypeEnumString   ColumnTypeEnum = "string"
)

func (*ColumnTypeEnum) UnmarshalJSON 

func (s *ColumnTypeEnum) UnmarshalJSON(bytes []byte) error

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Table
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Table
}

type ListByWorkspaceOperationResponse 

type ListByWorkspaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *TablesListResult
}

type MigrateOperationResponse 

type MigrateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
}

type ProvisioningStateEnum 

type ProvisioningStateEnum string
const (
	ProvisioningStateEnumDeleting   ProvisioningStateEnum = "Deleting"
	ProvisioningStateEnumInProgress ProvisioningStateEnum = "InProgress"
	ProvisioningStateEnumSucceeded  ProvisioningStateEnum = "Succeeded"
	ProvisioningStateEnumUpdating   ProvisioningStateEnum = "Updating"
)

func (*ProvisioningStateEnum) UnmarshalJSON 

func (s *ProvisioningStateEnum) UnmarshalJSON(bytes []byte) error

type RestoredLogs 

type RestoredLogs struct {
	AzureAsyncOperationId *string `json:"azureAsyncOperationId,omitempty"`
	EndRestoreTime        *string `json:"endRestoreTime,omitempty"`
	SourceTable           *string `json:"sourceTable,omitempty"`
	StartRestoreTime      *string `json:"startRestoreTime,omitempty"`
}

func (*RestoredLogs) GetEndRestoreTimeAsTime 

func (o *RestoredLogs) GetEndRestoreTimeAsTime() (*time.Time, error)

func (*RestoredLogs) GetStartRestoreTimeAsTime 

func (o *RestoredLogs) GetStartRestoreTimeAsTime() (*time.Time, error)

func (*RestoredLogs) SetEndRestoreTimeAsTime 

func (o *RestoredLogs) SetEndRestoreTimeAsTime(input time.Time)

func (*RestoredLogs) SetStartRestoreTimeAsTime 

func (o *RestoredLogs) SetStartRestoreTimeAsTime(input time.Time)

type ResultStatistics 

type ResultStatistics struct {
	IngestedRecords *int64   `json:"ingestedRecords,omitempty"`
	Progress        *float64 `json:"progress,omitempty"`
	ScannedGb       *float64 `json:"scannedGb,omitempty"`
}

type Schema 

type Schema struct {
	Categories      *[]string         `json:"categories,omitempty"`
	Columns         *[]Column         `json:"columns,omitempty"`
	Description     *string           `json:"description,omitempty"`
	DisplayName     *string           `json:"displayName,omitempty"`
	Labels          *[]string         `json:"labels,omitempty"`
	Name            *string           `json:"name,omitempty"`
	Solutions       *[]string         `json:"solutions,omitempty"`
	Source          *SourceEnum       `json:"source,omitempty"`
	StandardColumns *[]Column         `json:"standardColumns,omitempty"`
	TableSubType    *TableSubTypeEnum `json:"tableSubType,omitempty"`
	TableType       *TableTypeEnum    `json:"tableType,omitempty"`
}

type SearchResults 

type SearchResults struct {
	AzureAsyncOperationId *string `json:"azureAsyncOperationId,omitempty"`
	Description           *string `json:"description,omitempty"`
	EndSearchTime         *string `json:"endSearchTime,omitempty"`
	Limit                 *int64  `json:"limit,omitempty"`
	Query                 *string `json:"query,omitempty"`
	SourceTable           *string `json:"sourceTable,omitempty"`
	StartSearchTime       *string `json:"startSearchTime,omitempty"`
}

func (*SearchResults) GetEndSearchTimeAsTime 

func (o *SearchResults) GetEndSearchTimeAsTime() (*time.Time, error)

func (*SearchResults) GetStartSearchTimeAsTime 

func (o *SearchResults) GetStartSearchTimeAsTime() (*time.Time, error)

func (*SearchResults) SetEndSearchTimeAsTime 

func (o *SearchResults) SetEndSearchTimeAsTime(input time.Time)

func (*SearchResults) SetStartSearchTimeAsTime 

func (o *SearchResults) SetStartSearchTimeAsTime(input time.Time)

type SourceEnum 

type SourceEnum string
const (
	SourceEnumCustomer  SourceEnum = "customer"
	SourceEnumMicrosoft SourceEnum = "microsoft"
)

func (*SourceEnum) UnmarshalJSON 

func (s *SourceEnum) UnmarshalJSON(bytes []byte) error

type Table 

type Table struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *TableProperties       `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type TableId 

type TableId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
	TableName         string
}

TableId is a struct representing the Resource ID for a Table

func NewTableID 

func NewTableID(subscriptionId string, resourceGroupName string, workspaceName string, tableName string) TableId

NewTableID returns a new TableId struct

func ParseTableID 

func ParseTableID(input string) (*TableId, error)

ParseTableID parses 'input' into a TableId

func ParseTableIDInsensitively 

func ParseTableIDInsensitively(input string) (*TableId, error)

ParseTableIDInsensitively parses 'input' case-insensitively into a TableId note: this method should only be used for API response data and not user input

func (*TableId) FromParseResult 

func (id *TableId) FromParseResult(input resourceids.ParseResult) error

func (TableId) ID 

func (id TableId) ID() string

ID returns the formatted Table ID

func (TableId) Segments 

func (id TableId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Table ID

func (TableId) String 

func (id TableId) String() string

String returns a human-readable description of this Table ID

type TablePlanEnum 

type TablePlanEnum string
const (
	TablePlanEnumAnalytics TablePlanEnum = "Analytics"
	TablePlanEnumBasic     TablePlanEnum = "Basic"
)

func (*TablePlanEnum) UnmarshalJSON 

func (s *TablePlanEnum) UnmarshalJSON(bytes []byte) error

type TableProperties 

type TableProperties struct {
	ArchiveRetentionInDays        *int64                 `json:"archiveRetentionInDays,omitempty"`
	LastPlanModifiedDate          *string                `json:"lastPlanModifiedDate,omitempty"`
	Plan                          *TablePlanEnum         `json:"plan,omitempty"`
	ProvisioningState             *ProvisioningStateEnum `json:"provisioningState,omitempty"`
	RestoredLogs                  *RestoredLogs          `json:"restoredLogs,omitempty"`
	ResultStatistics              *ResultStatistics      `json:"resultStatistics,omitempty"`
	RetentionInDays               *int64                 `json:"retentionInDays,omitempty"`
	RetentionInDaysAsDefault      *bool                  `json:"retentionInDaysAsDefault,omitempty"`
	Schema                        *Schema                `json:"schema,omitempty"`
	SearchResults                 *SearchResults         `json:"searchResults,omitempty"`
	TotalRetentionInDays          *int64                 `json:"totalRetentionInDays,omitempty"`
	TotalRetentionInDaysAsDefault *bool                  `json:"totalRetentionInDaysAsDefault,omitempty"`
}

type TableSubTypeEnum 

type TableSubTypeEnum string
const (
	TableSubTypeEnumAny                     TableSubTypeEnum = "Any"
	TableSubTypeEnumClassic                 TableSubTypeEnum = "Classic"
	TableSubTypeEnumDataCollectionRuleBased TableSubTypeEnum = "DataCollectionRuleBased"
)

func (*TableSubTypeEnum) UnmarshalJSON 

func (s *TableSubTypeEnum) UnmarshalJSON(bytes []byte) error

type TableTypeEnum 

type TableTypeEnum string
const (
	TableTypeEnumCustomLog     TableTypeEnum = "CustomLog"
	TableTypeEnumMicrosoft     TableTypeEnum = "Microsoft"
	TableTypeEnumRestoredLogs  TableTypeEnum = "RestoredLogs"
	TableTypeEnumSearchResults TableTypeEnum = "SearchResults"
)

func (*TableTypeEnum) UnmarshalJSON 

func (s *TableTypeEnum) UnmarshalJSON(bytes []byte) error

type TablesClient 

type TablesClient struct {
	Client *resourcemanager.Client
}

func NewTablesClientWithBaseURI 

func NewTablesClientWithBaseURI(sdkApi sdkEnv.Api) (*TablesClient, error)

func (TablesClient) CancelSearch 

func (c TablesClient) CancelSearch(ctx context.Context, id TableId) (result CancelSearchOperationResponse, err error)

CancelSearch ...

func (TablesClient) CreateOrUpdate 

func (c TablesClient) CreateOrUpdate(ctx context.Context, id TableId, input Table) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (TablesClient) CreateOrUpdateThenPoll 

func (c TablesClient) CreateOrUpdateThenPoll(ctx context.Context, id TableId, input Table) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (TablesClient) Delete 

func (c TablesClient) Delete(ctx context.Context, id TableId) (result DeleteOperationResponse, err error)

Delete ...

func (TablesClient) DeleteThenPoll 

func (c TablesClient) DeleteThenPoll(ctx context.Context, id TableId) error

DeleteThenPoll performs Delete then polls until it's completed

func (TablesClient) Get 

func (c TablesClient) Get(ctx context.Context, id TableId) (result GetOperationResponse, err error)

Get ...

func (TablesClient) ListByWorkspace 

func (c TablesClient) ListByWorkspace(ctx context.Context, id WorkspaceId) (result ListByWorkspaceOperationResponse, err error)

ListByWorkspace ...

func (TablesClient) Migrate 

func (c TablesClient) Migrate(ctx context.Context, id TableId) (result MigrateOperationResponse, err error)

Migrate ...

func (TablesClient) Update 

func (c TablesClient) Update(ctx context.Context, id TableId, input Table) (result UpdateOperationResponse, err error)

Update ...

func (TablesClient) UpdateThenPoll 

func (c TablesClient) UpdateThenPoll(ctx context.Context, id TableId, input Table) error

UpdateThenPoll performs Update then polls until it's completed

type TablesListResult 

type TablesListResult struct {
	Value *[]Table `json:"value,omitempty"`
}

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Table
}

type WorkspaceId 

type WorkspaceId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkspaceName     string
}

WorkspaceId is a struct representing the Resource ID for a Workspace

func NewWorkspaceID 

func NewWorkspaceID(subscriptionId string, resourceGroupName string, workspaceName string) WorkspaceId

NewWorkspaceID returns a new WorkspaceId struct

func ParseWorkspaceID 

func ParseWorkspaceID(input string) (*WorkspaceId, error)

ParseWorkspaceID parses 'input' into a WorkspaceId

func ParseWorkspaceIDInsensitively 

func ParseWorkspaceIDInsensitively(input string) (*WorkspaceId, error)

ParseWorkspaceIDInsensitively parses 'input' case-insensitively into a WorkspaceId note: this method should only be used for API response data and not user input

func (*WorkspaceId) FromParseResult 

func (id *WorkspaceId) FromParseResult(input resourceids.ParseResult) error

func (WorkspaceId) ID 

func (id WorkspaceId) ID() string

ID returns the formatted Workspace ID

func (WorkspaceId) Segments 

func (id WorkspaceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Workspace ID

func (WorkspaceId) String 

func (id WorkspaceId) String() string

String returns a human-readable description of this Workspace ID

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.