storageinsights

package
v0.20241118.1115603 Latest Latest
Warning

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

Go to latest
Published: Nov 18, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/operationalinsights/2020-08-01/storageinsights Documentation

The storageinsights SDK allows for interaction with Azure Resource Manager operationalinsights (API Version 2020-08-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/2020-08-01/storageinsights"

Client Initialization

client := storageinsights.NewStorageInsightsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: StorageInsightsClient.StorageInsightConfigsCreateOrUpdate

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

payload := storageinsights.StorageInsight{
	// ...
}


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

Example Usage: StorageInsightsClient.StorageInsightConfigsDelete

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

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

Example Usage: StorageInsightsClient.StorageInsightConfigsGet

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

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

Example Usage: StorageInsightsClient.StorageInsightConfigsListByWorkspace

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

// alternatively `client.StorageInsightConfigsListByWorkspace(ctx, id)` can be used to do batched pagination
items, err := client.StorageInsightConfigsListByWorkspaceComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForStorageInsightState

func PossibleValuesForStorageInsightState() []string

func ValidateStorageInsightConfigID

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

ValidateStorageInsightConfigID checks that 'input' can be parsed as a Storage Insight Config 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 StorageAccount

type StorageAccount struct {
	Id  string `json:"id"`
	Key string `json:"key"`
}

type StorageInsight

type StorageInsight struct {
	ETag       *string                   `json:"eTag,omitempty"`
	Id         *string                   `json:"id,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *StorageInsightProperties `json:"properties,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type StorageInsightConfigId

type StorageInsightConfigId struct {
	SubscriptionId           string
	ResourceGroupName        string
	WorkspaceName            string
	StorageInsightConfigName string
}

StorageInsightConfigId is a struct representing the Resource ID for a Storage Insight Config

func NewStorageInsightConfigID

func NewStorageInsightConfigID(subscriptionId string, resourceGroupName string, workspaceName string, storageInsightConfigName string) StorageInsightConfigId

NewStorageInsightConfigID returns a new StorageInsightConfigId struct

func ParseStorageInsightConfigID

func ParseStorageInsightConfigID(input string) (*StorageInsightConfigId, error)

ParseStorageInsightConfigID parses 'input' into a StorageInsightConfigId

func ParseStorageInsightConfigIDInsensitively

func ParseStorageInsightConfigIDInsensitively(input string) (*StorageInsightConfigId, error)

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

func (*StorageInsightConfigId) FromParseResult

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

func (StorageInsightConfigId) ID

ID returns the formatted Storage Insight Config ID

func (StorageInsightConfigId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Storage Insight Config ID

func (StorageInsightConfigId) String

func (id StorageInsightConfigId) String() string

String returns a human-readable description of this Storage Insight Config ID

type StorageInsightConfigsCreateOrUpdateOperationResponse

type StorageInsightConfigsCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageInsight
}

type StorageInsightConfigsDeleteOperationResponse

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

type StorageInsightConfigsGetOperationResponse

type StorageInsightConfigsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *StorageInsight
}

type StorageInsightConfigsListByWorkspaceCompleteResult

type StorageInsightConfigsListByWorkspaceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []StorageInsight
}

type StorageInsightConfigsListByWorkspaceCustomPager added in v0.20240628.1153531

type StorageInsightConfigsListByWorkspaceCustomPager struct {
	NextLink *odata.Link `json:"@odata.nextLink"`
}

type StorageInsightConfigsListByWorkspaceOperationResponse

type StorageInsightConfigsListByWorkspaceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]StorageInsight
}

type StorageInsightOperationPredicate

type StorageInsightOperationPredicate struct {
	ETag *string
	Id   *string
	Name *string
	Type *string
}

func (StorageInsightOperationPredicate) Matches

type StorageInsightProperties

type StorageInsightProperties struct {
	Containers     *[]string             `json:"containers,omitempty"`
	Status         *StorageInsightStatus `json:"status,omitempty"`
	StorageAccount StorageAccount        `json:"storageAccount"`
	Tables         *[]string             `json:"tables,omitempty"`
}

type StorageInsightState

type StorageInsightState string
const (
	StorageInsightStateERROR StorageInsightState = "ERROR"
	StorageInsightStateOK    StorageInsightState = "OK"
)

func (*StorageInsightState) UnmarshalJSON

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

type StorageInsightStatus

type StorageInsightStatus struct {
	Description *string             `json:"description,omitempty"`
	State       StorageInsightState `json:"state"`
}

type StorageInsightsClient

type StorageInsightsClient struct {
	Client *resourcemanager.Client
}

func NewStorageInsightsClientWithBaseURI

func NewStorageInsightsClientWithBaseURI(sdkApi sdkEnv.Api) (*StorageInsightsClient, error)

func (StorageInsightsClient) StorageInsightConfigsCreateOrUpdate

StorageInsightConfigsCreateOrUpdate ...

func (StorageInsightsClient) StorageInsightConfigsDelete

StorageInsightConfigsDelete ...

func (StorageInsightsClient) StorageInsightConfigsGet

StorageInsightConfigsGet ...

func (StorageInsightsClient) StorageInsightConfigsListByWorkspace

func (c StorageInsightsClient) StorageInsightConfigsListByWorkspace(ctx context.Context, id WorkspaceId) (result StorageInsightConfigsListByWorkspaceOperationResponse, err error)

StorageInsightConfigsListByWorkspace ...

func (StorageInsightsClient) StorageInsightConfigsListByWorkspaceComplete

func (c StorageInsightsClient) StorageInsightConfigsListByWorkspaceComplete(ctx context.Context, id WorkspaceId) (StorageInsightConfigsListByWorkspaceCompleteResult, error)

StorageInsightConfigsListByWorkspaceComplete retrieves all the results into a single object

func (StorageInsightsClient) StorageInsightConfigsListByWorkspaceCompleteMatchingPredicate

func (c StorageInsightsClient) StorageInsightConfigsListByWorkspaceCompleteMatchingPredicate(ctx context.Context, id WorkspaceId, predicate StorageInsightOperationPredicate) (result StorageInsightConfigsListByWorkspaceCompleteResult, err error)

StorageInsightConfigsListByWorkspaceCompleteMatchingPredicate retrieves all the results and then applies the predicate

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL