workbooksapis

package
v0.20240710.1100952 Latest Latest
Warning

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

 Go to latest Published: Jul 10, 2024 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/applicationinsights/2015-05-01/workbooksapis Documentation

The workbooksapis SDK allows for interaction with the Azure Resource Manager Service applicationinsights (API Version 2015-05-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/applicationinsights/2015-05-01/workbooksapis"

Client Initialization

client := workbooksapis.NewWorkbooksAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkbooksAPIsClient.WorkbooksCreateOrUpdate

ctx := context.TODO()
id := workbooksapis.NewWorkbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workbookValue")

payload := workbooksapis.Workbook{
	// ...
}


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

Example Usage: WorkbooksAPIsClient.WorkbooksDelete

ctx := context.TODO()
id := workbooksapis.NewWorkbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workbookValue")

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

Example Usage: WorkbooksAPIsClient.WorkbooksGet

ctx := context.TODO()
id := workbooksapis.NewWorkbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workbookValue")

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

Example Usage: WorkbooksAPIsClient.WorkbooksListByResourceGroup

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

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

Example Usage: WorkbooksAPIsClient.WorkbooksUpdate

ctx := context.TODO()
id := workbooksapis.NewWorkbookID("12345678-1234-9876-4563-123456789012", "example-resource-group", "workbookValue")

payload := workbooksapis.Workbook{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForCategoryType 

func PossibleValuesForCategoryType() []string

func PossibleValuesForSharedTypeKind 

func PossibleValuesForSharedTypeKind() []string

func ValidateWorkbookID 

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

ValidateWorkbookID checks that 'input' can be parsed as a Workbook ID

Types

type CategoryType 

type CategoryType string
const (
	CategoryTypePerformance CategoryType = "performance"
	CategoryTypeRetention   CategoryType = "retention"
	CategoryTypeTSG         CategoryType = "TSG"
	CategoryTypeWorkbook    CategoryType = "workbook"
)

func (*CategoryType) UnmarshalJSON 

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

type SharedTypeKind 

type SharedTypeKind string
const (
	SharedTypeKindShared SharedTypeKind = "shared"
	SharedTypeKindUser   SharedTypeKind = "user"
)

func (*SharedTypeKind) UnmarshalJSON 

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

type Workbook 

type Workbook struct {
	Id         *string             `json:"id,omitempty"`
	Kind       *SharedTypeKind     `json:"kind,omitempty"`
	Location   *string             `json:"location,omitempty"`
	Name       *string             `json:"name,omitempty"`
	Properties *WorkbookProperties `json:"properties,omitempty"`
	Tags       *map[string]string  `json:"tags,omitempty"`
	Type       *string             `json:"type,omitempty"`
}

type WorkbookId 

type WorkbookId struct {
	SubscriptionId    string
	ResourceGroupName string
	WorkbookName      string
}

WorkbookId is a struct representing the Resource ID for a Workbook

func NewWorkbookID 

func NewWorkbookID(subscriptionId string, resourceGroupName string, workbookName string) WorkbookId

NewWorkbookID returns a new WorkbookId struct

func ParseWorkbookID 

func ParseWorkbookID(input string) (*WorkbookId, error)

ParseWorkbookID parses 'input' into a WorkbookId

func ParseWorkbookIDInsensitively 

func ParseWorkbookIDInsensitively(input string) (*WorkbookId, error)

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

func (*WorkbookId) FromParseResult 

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

func (WorkbookId) ID 

func (id WorkbookId) ID() string

ID returns the formatted Workbook ID

func (WorkbookId) Segments 

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

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

func (WorkbookId) String 

func (id WorkbookId) String() string

String returns a human-readable description of this Workbook ID

type WorkbookProperties 

type WorkbookProperties struct {
	Category         string         `json:"category"`
	Kind             SharedTypeKind `json:"kind"`
	Name             string         `json:"name"`
	SerializedData   string         `json:"serializedData"`
	SourceResourceId *string        `json:"sourceResourceId,omitempty"`
	Tags             *[]string      `json:"tags,omitempty"`
	TimeModified     *string        `json:"timeModified,omitempty"`
	UserId           string         `json:"userId"`
	Version          *string        `json:"version,omitempty"`
	WorkbookId       string         `json:"workbookId"`
}

type WorkbooksAPIsClient 

type WorkbooksAPIsClient struct {
	Client *resourcemanager.Client
}

func NewWorkbooksAPIsClientWithBaseURI 

func NewWorkbooksAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*WorkbooksAPIsClient, error)

func (WorkbooksAPIsClient) WorkbooksCreateOrUpdate 

func (c WorkbooksAPIsClient) WorkbooksCreateOrUpdate(ctx context.Context, id WorkbookId, input Workbook) (result WorkbooksCreateOrUpdateOperationResponse, err error)

WorkbooksCreateOrUpdate ...

func (WorkbooksAPIsClient) WorkbooksDelete 

func (c WorkbooksAPIsClient) WorkbooksDelete(ctx context.Context, id WorkbookId) (result WorkbooksDeleteOperationResponse, err error)

WorkbooksDelete ...

func (WorkbooksAPIsClient) WorkbooksGet 

func (c WorkbooksAPIsClient) WorkbooksGet(ctx context.Context, id WorkbookId) (result WorkbooksGetOperationResponse, err error)

WorkbooksGet ...

func (WorkbooksAPIsClient) WorkbooksListByResourceGroup 

func (c WorkbooksAPIsClient) WorkbooksListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId, options WorkbooksListByResourceGroupOperationOptions) (result WorkbooksListByResourceGroupOperationResponse, err error)

WorkbooksListByResourceGroup ...

func (WorkbooksAPIsClient) WorkbooksUpdate 

func (c WorkbooksAPIsClient) WorkbooksUpdate(ctx context.Context, id WorkbookId, input Workbook) (result WorkbooksUpdateOperationResponse, err error)

WorkbooksUpdate ...

type WorkbooksCreateOrUpdateOperationResponse 

type WorkbooksCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Workbook
}

type WorkbooksDeleteOperationResponse 

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

type WorkbooksGetOperationResponse 

type WorkbooksGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Workbook
}

type WorkbooksListByResourceGroupOperationOptions 

type WorkbooksListByResourceGroupOperationOptions struct {
	CanFetchContent *bool
	Category        *CategoryType
	Tags            *string
}

func DefaultWorkbooksListByResourceGroupOperationOptions 

func DefaultWorkbooksListByResourceGroupOperationOptions() WorkbooksListByResourceGroupOperationOptions

func (WorkbooksListByResourceGroupOperationOptions) ToHeaders 

func (o WorkbooksListByResourceGroupOperationOptions) ToHeaders() *client.Headers

func (WorkbooksListByResourceGroupOperationOptions) ToOData 

func (o WorkbooksListByResourceGroupOperationOptions) ToOData() *odata.Query

func (WorkbooksListByResourceGroupOperationOptions) ToQuery 

func (o WorkbooksListByResourceGroupOperationOptions) ToQuery() *client.QueryParams

type WorkbooksListByResourceGroupOperationResponse 

type WorkbooksListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkbooksListResult
}

type WorkbooksListResult 

type WorkbooksListResult struct {
	Value *[]Workbook `json:"value,omitempty"`
}

type WorkbooksUpdateOperationResponse 

type WorkbooksUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Workbook
}

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.