componentannotationsapis

package
v0.20240118.1175416 Latest Latest
Warning

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

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

README

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

The componentannotationsapis 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/componentannotationsapis"

Client Initialization

client := componentannotationsapis.NewComponentAnnotationsAPIsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ComponentAnnotationsAPIsClient.AnnotationsCreate

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

payload := componentannotationsapis.Annotation{
	// ...
}


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

Example Usage: ComponentAnnotationsAPIsClient.AnnotationsDelete

ctx := context.TODO()
id := componentannotationsapis.NewAnnotationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "componentValue", "annotationIdValue")

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

Example Usage: ComponentAnnotationsAPIsClient.AnnotationsGet

ctx := context.TODO()
id := componentannotationsapis.NewAnnotationID("12345678-1234-9876-4563-123456789012", "example-resource-group", "componentValue", "annotationIdValue")

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

Example Usage: ComponentAnnotationsAPIsClient.AnnotationsList

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

read, err := client.AnnotationsList(ctx, id, componentannotationsapis.DefaultAnnotationsListOperationOptions())
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 ValidateAnnotationID 

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

ValidateAnnotationID checks that 'input' can be parsed as a Annotation ID

func ValidateComponentID 

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

ValidateComponentID checks that 'input' can be parsed as a Component ID

Types

type Annotation 

type Annotation struct {
	AnnotationName    *string `json:"AnnotationName,omitempty"`
	Category          *string `json:"Category,omitempty"`
	EventTime         *string `json:"EventTime,omitempty"`
	Id                *string `json:"Id,omitempty"`
	Properties        *string `json:"Properties,omitempty"`
	RelatedAnnotation *string `json:"RelatedAnnotation,omitempty"`
}

func (*Annotation) GetEventTimeAsTime 

func (o *Annotation) GetEventTimeAsTime() (*time.Time, error)

func (*Annotation) SetEventTimeAsTime 

func (o *Annotation) SetEventTimeAsTime(input time.Time)

type AnnotationId 

type AnnotationId struct {
	SubscriptionId    string
	ResourceGroupName string
	ComponentName     string
	AnnotationId      string
}

AnnotationId is a struct representing the Resource ID for a Annotation

func NewAnnotationID 

func NewAnnotationID(subscriptionId string, resourceGroupName string, componentName string, annotationId string) AnnotationId

NewAnnotationID returns a new AnnotationId struct

func ParseAnnotationID 

func ParseAnnotationID(input string) (*AnnotationId, error)

ParseAnnotationID parses 'input' into a AnnotationId

func ParseAnnotationIDInsensitively 

func ParseAnnotationIDInsensitively(input string) (*AnnotationId, error)

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

func (*AnnotationId) FromParseResult added in v0.20231127.1171502 

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

func (AnnotationId) ID 

func (id AnnotationId) ID() string

ID returns the formatted Annotation ID

func (AnnotationId) Segments 

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

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

func (AnnotationId) String 

func (id AnnotationId) String() string

String returns a human-readable description of this Annotation ID

type AnnotationsCreateOperationResponse 

type AnnotationsCreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Annotation
}

type AnnotationsDeleteOperationResponse 

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

type AnnotationsGetOperationResponse 

type AnnotationsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Annotation
}

type AnnotationsListOperationOptions 

type AnnotationsListOperationOptions struct {
	End   *string
	Start *string
}

func DefaultAnnotationsListOperationOptions 

func DefaultAnnotationsListOperationOptions() AnnotationsListOperationOptions

func (AnnotationsListOperationOptions) ToHeaders 

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

func (AnnotationsListOperationOptions) ToOData 

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

func (AnnotationsListOperationOptions) ToQuery 

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

type AnnotationsListOperationResponse 

type AnnotationsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *AnnotationsListResult
}

type AnnotationsListResult 

type AnnotationsListResult struct {
	Value *[]Annotation `json:"value,omitempty"`
}

type ComponentAnnotationsAPIsClient 

type ComponentAnnotationsAPIsClient struct {
	Client *resourcemanager.Client
}

func NewComponentAnnotationsAPIsClientWithBaseURI 

func NewComponentAnnotationsAPIsClientWithBaseURI(sdkApi sdkEnv.Api) (*ComponentAnnotationsAPIsClient, error)

func (ComponentAnnotationsAPIsClient) AnnotationsCreate 

func (c ComponentAnnotationsAPIsClient) AnnotationsCreate(ctx context.Context, id ComponentId, input Annotation) (result AnnotationsCreateOperationResponse, err error)

AnnotationsCreate ...

func (ComponentAnnotationsAPIsClient) AnnotationsDelete 

func (c ComponentAnnotationsAPIsClient) AnnotationsDelete(ctx context.Context, id AnnotationId) (result AnnotationsDeleteOperationResponse, err error)

AnnotationsDelete ...

func (ComponentAnnotationsAPIsClient) AnnotationsGet 

func (c ComponentAnnotationsAPIsClient) AnnotationsGet(ctx context.Context, id AnnotationId) (result AnnotationsGetOperationResponse, err error)

AnnotationsGet ...

func (ComponentAnnotationsAPIsClient) AnnotationsList 

func (c ComponentAnnotationsAPIsClient) AnnotationsList(ctx context.Context, id ComponentId, options AnnotationsListOperationOptions) (result AnnotationsListOperationResponse, err error)

AnnotationsList ...

type ComponentId 

type ComponentId struct {
	SubscriptionId    string
	ResourceGroupName string
	ComponentName     string
}

ComponentId is a struct representing the Resource ID for a Component

func NewComponentID 

func NewComponentID(subscriptionId string, resourceGroupName string, componentName string) ComponentId

NewComponentID returns a new ComponentId struct

func ParseComponentID 

func ParseComponentID(input string) (*ComponentId, error)

ParseComponentID parses 'input' into a ComponentId

func ParseComponentIDInsensitively 

func ParseComponentIDInsensitively(input string) (*ComponentId, error)

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

func (*ComponentId) FromParseResult added in v0.20231127.1171502 

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

func (ComponentId) ID 

func (id ComponentId) ID() string

ID returns the formatted Component ID

func (ComponentId) Segments 

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

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

func (ComponentId) String 

func (id ComponentId) String() string

String returns a human-readable description of this Component 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.