grafanaplugin

README

github.com/hashicorp/go-azure-sdk/resource-manager/dashboard/2023-09-01/grafanaplugin Documentation

The grafanaplugin SDK allows for interaction with the Azure Resource Manager Service dashboard (API Version 2023-09-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/dashboard/2023-09-01/grafanaplugin"

Client Initialization

client := grafanaplugin.NewGrafanaPluginClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GrafanaPluginClient.GrafanaFetchAvailablePlugins

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

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

Documentation

Index

• func ValidateGrafanaID(input interface{}, key string) (warnings []string, errors []error)
• type GrafanaAvailablePlugin
• type GrafanaAvailablePluginOperationPredicate
  • func (p GrafanaAvailablePluginOperationPredicate) Matches(input GrafanaAvailablePlugin) bool
• type GrafanaFetchAvailablePluginsCompleteResult
• type GrafanaFetchAvailablePluginsOperationResponse
• type GrafanaId
  • func NewGrafanaID(subscriptionId string, resourceGroupName string, grafanaName string) GrafanaId
  • func ParseGrafanaID(input string) (*GrafanaId, error)
  • func ParseGrafanaIDInsensitively(input string) (*GrafanaId, error)
  • func (id *GrafanaId) FromParseResult(input resourceids.ParseResult) error
  • func (id GrafanaId) ID() string
  • func (id GrafanaId) Segments() []resourceids.Segment
  • func (id GrafanaId) String() string
• type GrafanaPluginClient
  • func NewGrafanaPluginClientWithBaseURI(sdkApi sdkEnv.Api) (*GrafanaPluginClient, error)
  • func (c GrafanaPluginClient) GrafanaFetchAvailablePlugins(ctx context.Context, id GrafanaId) (result GrafanaFetchAvailablePluginsOperationResponse, err error)
  • func (c GrafanaPluginClient) GrafanaFetchAvailablePluginsComplete(ctx context.Context, id GrafanaId) (GrafanaFetchAvailablePluginsCompleteResult, error)
  • func (c GrafanaPluginClient) GrafanaFetchAvailablePluginsCompleteMatchingPredicate(ctx context.Context, id GrafanaId, ...) (result GrafanaFetchAvailablePluginsCompleteResult, err error)

Functions

func ValidateGrafanaID

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

ValidateGrafanaID checks that 'input' can be parsed as a Grafana ID

Types

type GrafanaAvailablePlugin

type GrafanaAvailablePlugin struct {
	Name     *string `json:"name,omitempty"`
	PluginId *string `json:"pluginId,omitempty"`
}

type GrafanaAvailablePluginOperationPredicate

type GrafanaAvailablePluginOperationPredicate struct {
	Name     *string
	PluginId *string
}

func (GrafanaAvailablePluginOperationPredicate) Matches

func (p GrafanaAvailablePluginOperationPredicate) Matches(input GrafanaAvailablePlugin) bool

type GrafanaFetchAvailablePluginsCompleteResult

type GrafanaFetchAvailablePluginsCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []GrafanaAvailablePlugin
}

type GrafanaFetchAvailablePluginsOperationResponse

type GrafanaFetchAvailablePluginsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]GrafanaAvailablePlugin
}

type GrafanaId

type GrafanaId struct {
	SubscriptionId    string
	ResourceGroupName string
	GrafanaName       string
}

GrafanaId is a struct representing the Resource ID for a Grafana

func NewGrafanaID

func NewGrafanaID(subscriptionId string, resourceGroupName string, grafanaName string) GrafanaId

NewGrafanaID returns a new GrafanaId struct

func ParseGrafanaID

func ParseGrafanaID(input string) (*GrafanaId, error)

ParseGrafanaID parses 'input' into a GrafanaId

func ParseGrafanaIDInsensitively

func ParseGrafanaIDInsensitively(input string) (*GrafanaId, error)

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

func (*GrafanaId) FromParseResult

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

func (GrafanaId) ID

func (id GrafanaId) ID() string

ID returns the formatted Grafana ID

func (GrafanaId) Segments

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

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

func (GrafanaId) String

func (id GrafanaId) String() string

String returns a human-readable description of this Grafana ID

type GrafanaPluginClient

type GrafanaPluginClient struct {
	Client *resourcemanager.Client
}

func NewGrafanaPluginClientWithBaseURI

func NewGrafanaPluginClientWithBaseURI(sdkApi sdkEnv.Api) (*GrafanaPluginClient, error)

func (GrafanaPluginClient) GrafanaFetchAvailablePlugins

func (c GrafanaPluginClient) GrafanaFetchAvailablePlugins(ctx context.Context, id GrafanaId) (result GrafanaFetchAvailablePluginsOperationResponse, err error)

GrafanaFetchAvailablePlugins ...

func (GrafanaPluginClient) GrafanaFetchAvailablePluginsComplete

func (c GrafanaPluginClient) GrafanaFetchAvailablePluginsComplete(ctx context.Context, id GrafanaId) (GrafanaFetchAvailablePluginsCompleteResult, error)

GrafanaFetchAvailablePluginsComplete retrieves all the results into a single object

func (GrafanaPluginClient) GrafanaFetchAvailablePluginsCompleteMatchingPredicate

func (c GrafanaPluginClient) GrafanaFetchAvailablePluginsCompleteMatchingPredicate(ctx context.Context, id GrafanaId, predicate GrafanaAvailablePluginOperationPredicate) (result GrafanaFetchAvailablePluginsCompleteResult, err error)

GrafanaFetchAvailablePluginsCompleteMatchingPredicate retrieves all the results and then applies the predicate