workbooktemplatesapis

README

github.com/hashicorp/go-azure-sdk/resource-manager/applicationinsights/2020-11-20/workbooktemplatesapis Documentation

The workbooktemplatesapis SDK allows for interaction with the Azure Resource Manager Service applicationinsights (API Version 2020-11-20).

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/2020-11-20/workbooktemplatesapis"

Client Initialization

client := workbooktemplatesapis.NewWorkbookTemplatesAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: WorkbookTemplatesAPIsClient.WorkbookTemplatesCreateOrUpdate

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

payload := workbooktemplatesapis.WorkbookTemplate{
	// ...
}


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

Example Usage: WorkbookTemplatesAPIsClient.WorkbookTemplatesDelete

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

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

Example Usage: WorkbookTemplatesAPIsClient.WorkbookTemplatesGet

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

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

Example Usage: WorkbookTemplatesAPIsClient.WorkbookTemplatesListByResourceGroup

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

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

Example Usage: WorkbookTemplatesAPIsClient.WorkbookTemplatesUpdate

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

payload := workbooktemplatesapis.WorkbookTemplateUpdateParameters{
	// ...
}


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

Documentation

Index

• func ValidateWorkbookTemplateID(input interface{}, key string) (warnings []string, errors []error)
• type WorkbookTemplate
• type WorkbookTemplateGallery
• type WorkbookTemplateId
  • func NewWorkbookTemplateID(subscriptionId string, resourceGroupName string, workbookTemplateName string) WorkbookTemplateId
  • func ParseWorkbookTemplateID(input string) (*WorkbookTemplateId, error)
  • func ParseWorkbookTemplateIDInsensitively(input string) (*WorkbookTemplateId, error)
  • func (id WorkbookTemplateId) ID() string
  • func (id WorkbookTemplateId) Segments() []resourceids.Segment
  • func (id WorkbookTemplateId) String() string
• type WorkbookTemplateLocalizedGallery
• type WorkbookTemplateProperties
• type WorkbookTemplateUpdateParameters
• type WorkbookTemplatesAPIsClient
  • func NewWorkbookTemplatesAPIsClientWithBaseURI(api environments.Api) (*WorkbookTemplatesAPIsClient, error)
  • func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesCreateOrUpdate(ctx context.Context, id WorkbookTemplateId, input WorkbookTemplate) (result WorkbookTemplatesCreateOrUpdateOperationResponse, err error)
  • func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesDelete(ctx context.Context, id WorkbookTemplateId) (result WorkbookTemplatesDeleteOperationResponse, err error)
  • func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesGet(ctx context.Context, id WorkbookTemplateId) (result WorkbookTemplatesGetOperationResponse, err error)
  • func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result WorkbookTemplatesListByResourceGroupOperationResponse, err error)
  • func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesUpdate(ctx context.Context, id WorkbookTemplateId, ...) (result WorkbookTemplatesUpdateOperationResponse, err error)
• type WorkbookTemplatesCreateOrUpdateOperationResponse
• type WorkbookTemplatesDeleteOperationResponse
• type WorkbookTemplatesGetOperationResponse
• type WorkbookTemplatesListByResourceGroupOperationResponse
• type WorkbookTemplatesListResult
• type WorkbookTemplatesUpdateOperationResponse

Functions

func ValidateWorkbookTemplateID

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

ValidateWorkbookTemplateID checks that 'input' can be parsed as a Workbook Template ID

Types

type WorkbookTemplate

type WorkbookTemplate struct {
	Id         *string                     `json:"id,omitempty"`
	Location   string                      `json:"location"`
	Name       *string                     `json:"name,omitempty"`
	Properties *WorkbookTemplateProperties `json:"properties,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type WorkbookTemplateGallery

type WorkbookTemplateGallery struct {
	Category     *string `json:"category,omitempty"`
	Name         *string `json:"name,omitempty"`
	Order        *int64  `json:"order,omitempty"`
	ResourceType *string `json:"resourceType,omitempty"`
	Type         *string `json:"type,omitempty"`
}

type WorkbookTemplateId

type WorkbookTemplateId struct {
	SubscriptionId       string
	ResourceGroupName    string
	WorkbookTemplateName string
}

WorkbookTemplateId is a struct representing the Resource ID for a Workbook Template

func NewWorkbookTemplateID

func NewWorkbookTemplateID(subscriptionId string, resourceGroupName string, workbookTemplateName string) WorkbookTemplateId

NewWorkbookTemplateID returns a new WorkbookTemplateId struct

func ParseWorkbookTemplateID

func ParseWorkbookTemplateID(input string) (*WorkbookTemplateId, error)

ParseWorkbookTemplateID parses 'input' into a WorkbookTemplateId

func ParseWorkbookTemplateIDInsensitively

func ParseWorkbookTemplateIDInsensitively(input string) (*WorkbookTemplateId, error)

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

func (WorkbookTemplateId) ID

func (id WorkbookTemplateId) ID() string

ID returns the formatted Workbook Template ID

func (WorkbookTemplateId) Segments

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

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

func (WorkbookTemplateId) String

func (id WorkbookTemplateId) String() string

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

type WorkbookTemplateLocalizedGallery

type WorkbookTemplateLocalizedGallery struct {
	Galleries    *[]WorkbookTemplateGallery `json:"galleries,omitempty"`
	TemplateData *interface{}               `json:"templateData,omitempty"`
}

type WorkbookTemplateProperties

type WorkbookTemplateProperties struct {
	Author       *string                                        `json:"author,omitempty"`
	Galleries    []WorkbookTemplateGallery                      `json:"galleries"`
	Localized    *map[string][]WorkbookTemplateLocalizedGallery `json:"localized,omitempty"`
	Priority     *int64                                         `json:"priority,omitempty"`
	TemplateData interface{}                                    `json:"templateData"`
}

type WorkbookTemplateUpdateParameters

type WorkbookTemplateUpdateParameters struct {
	Properties *WorkbookTemplateProperties `json:"properties,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
}

type WorkbookTemplatesAPIsClient

type WorkbookTemplatesAPIsClient struct {
	Client *resourcemanager.Client
}

func NewWorkbookTemplatesAPIsClientWithBaseURI

func NewWorkbookTemplatesAPIsClientWithBaseURI(api environments.Api) (*WorkbookTemplatesAPIsClient, error)

func (WorkbookTemplatesAPIsClient) WorkbookTemplatesCreateOrUpdate

func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesCreateOrUpdate(ctx context.Context, id WorkbookTemplateId, input WorkbookTemplate) (result WorkbookTemplatesCreateOrUpdateOperationResponse, err error)

WorkbookTemplatesCreateOrUpdate ...

func (WorkbookTemplatesAPIsClient) WorkbookTemplatesDelete

func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesDelete(ctx context.Context, id WorkbookTemplateId) (result WorkbookTemplatesDeleteOperationResponse, err error)

WorkbookTemplatesDelete ...

func (WorkbookTemplatesAPIsClient) WorkbookTemplatesGet

func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesGet(ctx context.Context, id WorkbookTemplateId) (result WorkbookTemplatesGetOperationResponse, err error)

WorkbookTemplatesGet ...

func (WorkbookTemplatesAPIsClient) WorkbookTemplatesListByResourceGroup

func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result WorkbookTemplatesListByResourceGroupOperationResponse, err error)

WorkbookTemplatesListByResourceGroup ...

func (WorkbookTemplatesAPIsClient) WorkbookTemplatesUpdate

func (c WorkbookTemplatesAPIsClient) WorkbookTemplatesUpdate(ctx context.Context, id WorkbookTemplateId, input WorkbookTemplateUpdateParameters) (result WorkbookTemplatesUpdateOperationResponse, err error)

WorkbookTemplatesUpdate ...

type WorkbookTemplatesCreateOrUpdateOperationResponse

type WorkbookTemplatesCreateOrUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkbookTemplate
}

type WorkbookTemplatesDeleteOperationResponse

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

type WorkbookTemplatesGetOperationResponse

type WorkbookTemplatesGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkbookTemplate
}

type WorkbookTemplatesListByResourceGroupOperationResponse

type WorkbookTemplatesListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkbookTemplatesListResult
}

type WorkbookTemplatesListResult

type WorkbookTemplatesListResult struct {
	Value *[]WorkbookTemplate `json:"value,omitempty"`
}

type WorkbookTemplatesUpdateOperationResponse

type WorkbookTemplatesUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *WorkbookTemplate
}