myworkbooksapis

package
v0.20231212.1202820 Latest Latest
Warning

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

Go to latest
Published: Dec 12, 2023 License: MPL-2.0 Imports: 11 Imported by: 1

README

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

The myworkbooksapis 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-sdk/resource-manager/applicationinsights/2015-05-01/myworkbooksapis"

Client Initialization

client := myworkbooksapis.NewMyworkbooksAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MyworkbooksAPIsClient.MyWorkbooksCreateOrUpdate

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

payload := myworkbooksapis.MyWorkbook{
	// ...
}


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

Example Usage: MyworkbooksAPIsClient.MyWorkbooksDelete

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

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

Example Usage: MyworkbooksAPIsClient.MyWorkbooksGet

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

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

Example Usage: MyworkbooksAPIsClient.MyWorkbooksListByResourceGroup

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

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

Example Usage: MyworkbooksAPIsClient.MyWorkbooksListBySubscription

ctx := context.TODO()
id := myworkbooksapis.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: MyworkbooksAPIsClient.MyWorkbooksUpdate

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

payload := myworkbooksapis.MyWorkbook{
	// ...
}


read, err := client.MyWorkbooksUpdate(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 ValidateMyWorkbookID

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

ValidateMyWorkbookID checks that 'input' can be parsed as a My 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 MyWorkbook

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

type MyWorkbookId

type MyWorkbookId struct {
	SubscriptionId    string
	ResourceGroupName string
	MyWorkbookName    string
}

MyWorkbookId is a struct representing the Resource ID for a My Workbook

func NewMyWorkbookID

func NewMyWorkbookID(subscriptionId string, resourceGroupName string, myWorkbookName string) MyWorkbookId

NewMyWorkbookID returns a new MyWorkbookId struct

func ParseMyWorkbookID

func ParseMyWorkbookID(input string) (*MyWorkbookId, error)

ParseMyWorkbookID parses 'input' into a MyWorkbookId

func ParseMyWorkbookIDInsensitively

func ParseMyWorkbookIDInsensitively(input string) (*MyWorkbookId, error)

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

func (*MyWorkbookId) FromParseResult added in v0.20231127.1171502

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

func (MyWorkbookId) ID

func (id MyWorkbookId) ID() string

ID returns the formatted My Workbook ID

func (MyWorkbookId) Segments

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

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

func (MyWorkbookId) String

func (id MyWorkbookId) String() string

String returns a human-readable description of this My Workbook ID

type MyWorkbookProperties

type MyWorkbookProperties struct {
	Category       string    `json:"category"`
	DisplayName    string    `json:"displayName"`
	SerializedData string    `json:"serializedData"`
	SourceId       *string   `json:"sourceId,omitempty"`
	Tags           *[]string `json:"tags,omitempty"`
	TimeModified   *string   `json:"timeModified,omitempty"`
	UserId         *string   `json:"userId,omitempty"`
	Version        *string   `json:"version,omitempty"`
}

type MyWorkbooksCreateOrUpdateOperationResponse

type MyWorkbooksCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MyWorkbook
}

type MyWorkbooksDeleteOperationResponse

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

type MyWorkbooksGetOperationResponse

type MyWorkbooksGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MyWorkbook
}

type MyWorkbooksListByResourceGroupOperationOptions

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

func DefaultMyWorkbooksListByResourceGroupOperationOptions

func DefaultMyWorkbooksListByResourceGroupOperationOptions() MyWorkbooksListByResourceGroupOperationOptions

func (MyWorkbooksListByResourceGroupOperationOptions) ToHeaders

func (MyWorkbooksListByResourceGroupOperationOptions) ToOData

func (MyWorkbooksListByResourceGroupOperationOptions) ToQuery

type MyWorkbooksListByResourceGroupOperationResponse

type MyWorkbooksListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MyWorkbooksListResult
}

type MyWorkbooksListBySubscriptionOperationOptions

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

func DefaultMyWorkbooksListBySubscriptionOperationOptions

func DefaultMyWorkbooksListBySubscriptionOperationOptions() MyWorkbooksListBySubscriptionOperationOptions

func (MyWorkbooksListBySubscriptionOperationOptions) ToHeaders

func (MyWorkbooksListBySubscriptionOperationOptions) ToOData

func (MyWorkbooksListBySubscriptionOperationOptions) ToQuery

type MyWorkbooksListBySubscriptionOperationResponse

type MyWorkbooksListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MyWorkbooksListResult
}

type MyWorkbooksListResult

type MyWorkbooksListResult struct {
	Value *[]MyWorkbook `json:"value,omitempty"`
}

type MyWorkbooksUpdateOperationResponse

type MyWorkbooksUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MyWorkbook
}

type MyworkbooksAPIsClient

type MyworkbooksAPIsClient struct {
	Client *resourcemanager.Client
}

func NewMyworkbooksAPIsClientWithBaseURI

func NewMyworkbooksAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*MyworkbooksAPIsClient, error)

func (MyworkbooksAPIsClient) MyWorkbooksCreateOrUpdate

func (c MyworkbooksAPIsClient) MyWorkbooksCreateOrUpdate(ctx context.Context, id MyWorkbookId, input MyWorkbook) (result MyWorkbooksCreateOrUpdateOperationResponse, err error)

MyWorkbooksCreateOrUpdate ...

func (MyworkbooksAPIsClient) MyWorkbooksDelete

MyWorkbooksDelete ...

func (MyworkbooksAPIsClient) MyWorkbooksGet

MyWorkbooksGet ...

func (MyworkbooksAPIsClient) MyWorkbooksListByResourceGroup

MyWorkbooksListByResourceGroup ...

func (MyworkbooksAPIsClient) MyWorkbooksListBySubscription

MyWorkbooksListBySubscription ...

func (MyworkbooksAPIsClient) MyWorkbooksUpdate

func (c MyworkbooksAPIsClient) MyWorkbooksUpdate(ctx context.Context, id MyWorkbookId, input MyWorkbook) (result MyWorkbooksUpdateOperationResponse, err error)

MyWorkbooksUpdate ...

type SharedTypeKind

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

func (*SharedTypeKind) UnmarshalJSON

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

Jump to

Keyboard shortcuts

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