grafanaresource

package
v0.20241209.1115630 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/dashboard/2022-08-01/grafanaresource Documentation

The grafanaresource SDK allows for interaction with Azure Resource Manager dashboard (API Version 2022-08-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/dashboard/2022-08-01/grafanaresource"

Client Initialization

client := grafanaresource.NewGrafanaResourceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: GrafanaResourceClient.GrafanaCreate

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

payload := grafanaresource.ManagedGrafana{
	// ...
}


if err := client.GrafanaCreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: GrafanaResourceClient.GrafanaDelete

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

if err := client.GrafanaDeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: GrafanaResourceClient.GrafanaGet

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

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

Example Usage: GrafanaResourceClient.GrafanaList

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

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

Example Usage: GrafanaResourceClient.GrafanaListByResourceGroup

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

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

Example Usage: GrafanaResourceClient.GrafanaUpdate

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

payload := grafanaresource.ManagedGrafanaUpdateParameters{
	// ...
}


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

func PossibleValuesForApiKey() []string

func PossibleValuesForAutoGeneratedDomainNameLabelScope 

func PossibleValuesForAutoGeneratedDomainNameLabelScope() []string

func PossibleValuesForDeterministicOutboundIP 

func PossibleValuesForDeterministicOutboundIP() []string

func PossibleValuesForPrivateEndpointConnectionProvisioningState 

func PossibleValuesForPrivateEndpointConnectionProvisioningState() []string

func PossibleValuesForPrivateEndpointServiceConnectionStatus 

func PossibleValuesForPrivateEndpointServiceConnectionStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForPublicNetworkAccess 

func PossibleValuesForPublicNetworkAccess() []string

func PossibleValuesForZoneRedundancy 

func PossibleValuesForZoneRedundancy() []string

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 ApiKey 

type ApiKey string
const (
	ApiKeyDisabled ApiKey = "Disabled"
	ApiKeyEnabled  ApiKey = "Enabled"
)

func (*ApiKey) UnmarshalJSON 

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

type AutoGeneratedDomainNameLabelScope 

type AutoGeneratedDomainNameLabelScope string
const (
	AutoGeneratedDomainNameLabelScopeTenantReuse AutoGeneratedDomainNameLabelScope = "TenantReuse"
)

func (*AutoGeneratedDomainNameLabelScope) UnmarshalJSON 

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

type AzureMonitorWorkspaceIntegration 

type AzureMonitorWorkspaceIntegration struct {
	AzureMonitorWorkspaceResourceId *string `json:"azureMonitorWorkspaceResourceId,omitempty"`
}

type DeterministicOutboundIP 

type DeterministicOutboundIP string
const (
	DeterministicOutboundIPDisabled DeterministicOutboundIP = "Disabled"
	DeterministicOutboundIPEnabled  DeterministicOutboundIP = "Enabled"
)

func (*DeterministicOutboundIP) UnmarshalJSON 

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

type GrafanaCreateOperationResponse 

type GrafanaCreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedGrafana
}

type GrafanaDeleteOperationResponse 

type GrafanaDeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GrafanaGetOperationResponse 

type GrafanaGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedGrafana
}

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 GrafanaIntegrations 

type GrafanaIntegrations struct {
	AzureMonitorWorkspaceIntegrations *[]AzureMonitorWorkspaceIntegration `json:"azureMonitorWorkspaceIntegrations,omitempty"`
}

type GrafanaListByResourceGroupCompleteResult 

type GrafanaListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedGrafana
}

type GrafanaListByResourceGroupCustomPager added in v0.20240628.1153531 

type GrafanaListByResourceGroupCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *GrafanaListByResourceGroupCustomPager) NextPageLink() *odata.Link

type GrafanaListByResourceGroupOperationResponse 

type GrafanaListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedGrafana
}

type GrafanaListCompleteResult 

type GrafanaListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ManagedGrafana
}

type GrafanaListCustomPager added in v0.20240628.1153531 

type GrafanaListCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *GrafanaListCustomPager) NextPageLink() *odata.Link

type GrafanaListOperationResponse 

type GrafanaListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedGrafana
}

type GrafanaResourceClient 

type GrafanaResourceClient struct {
	Client *resourcemanager.Client
}

func NewGrafanaResourceClientWithBaseURI 

func NewGrafanaResourceClientWithBaseURI(sdkApi sdkEnv.Api) (*GrafanaResourceClient, error)

func (GrafanaResourceClient) GrafanaCreate 

func (c GrafanaResourceClient) GrafanaCreate(ctx context.Context, id GrafanaId, input ManagedGrafana) (result GrafanaCreateOperationResponse, err error)

GrafanaCreate ...

func (GrafanaResourceClient) GrafanaCreateThenPoll 

func (c GrafanaResourceClient) GrafanaCreateThenPoll(ctx context.Context, id GrafanaId, input ManagedGrafana) error

GrafanaCreateThenPoll performs GrafanaCreate then polls until it's completed

func (GrafanaResourceClient) GrafanaDelete 

func (c GrafanaResourceClient) GrafanaDelete(ctx context.Context, id GrafanaId) (result GrafanaDeleteOperationResponse, err error)

GrafanaDelete ...

func (GrafanaResourceClient) GrafanaDeleteThenPoll 

func (c GrafanaResourceClient) GrafanaDeleteThenPoll(ctx context.Context, id GrafanaId) error

GrafanaDeleteThenPoll performs GrafanaDelete then polls until it's completed

func (GrafanaResourceClient) GrafanaGet 

func (c GrafanaResourceClient) GrafanaGet(ctx context.Context, id GrafanaId) (result GrafanaGetOperationResponse, err error)

GrafanaGet ...

func (GrafanaResourceClient) GrafanaList 

func (c GrafanaResourceClient) GrafanaList(ctx context.Context, id commonids.SubscriptionId) (result GrafanaListOperationResponse, err error)

GrafanaList ...

func (GrafanaResourceClient) GrafanaListByResourceGroup 

func (c GrafanaResourceClient) GrafanaListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result GrafanaListByResourceGroupOperationResponse, err error)

GrafanaListByResourceGroup ...

func (GrafanaResourceClient) GrafanaListByResourceGroupComplete 

func (c GrafanaResourceClient) GrafanaListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (GrafanaListByResourceGroupCompleteResult, error)

GrafanaListByResourceGroupComplete retrieves all the results into a single object

func (GrafanaResourceClient) GrafanaListByResourceGroupCompleteMatchingPredicate 

func (c GrafanaResourceClient) GrafanaListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate ManagedGrafanaOperationPredicate) (result GrafanaListByResourceGroupCompleteResult, err error)

GrafanaListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GrafanaResourceClient) GrafanaListComplete 

func (c GrafanaResourceClient) GrafanaListComplete(ctx context.Context, id commonids.SubscriptionId) (GrafanaListCompleteResult, error)

GrafanaListComplete retrieves all the results into a single object

func (GrafanaResourceClient) GrafanaListCompleteMatchingPredicate 

func (c GrafanaResourceClient) GrafanaListCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate ManagedGrafanaOperationPredicate) (result GrafanaListCompleteResult, err error)

GrafanaListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (GrafanaResourceClient) GrafanaUpdate 

func (c GrafanaResourceClient) GrafanaUpdate(ctx context.Context, id GrafanaId, input ManagedGrafanaUpdateParameters) (result GrafanaUpdateOperationResponse, err error)

GrafanaUpdate ...

type GrafanaUpdateOperationResponse 

type GrafanaUpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ManagedGrafana
}

type ManagedGrafana 

type ManagedGrafana struct {
	Id         *string                                  `json:"id,omitempty"`
	Identity   *identity.LegacySystemAndUserAssignedMap `json:"identity,omitempty"`
	Location   *string                                  `json:"location,omitempty"`
	Name       *string                                  `json:"name,omitempty"`
	Properties *ManagedGrafanaProperties                `json:"properties,omitempty"`
	Sku        *ResourceSku                             `json:"sku,omitempty"`
	SystemData *systemdata.SystemData                   `json:"systemData,omitempty"`
	Tags       *map[string]string                       `json:"tags,omitempty"`
	Type       *string                                  `json:"type,omitempty"`
}

type ManagedGrafanaOperationPredicate 

type ManagedGrafanaOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (ManagedGrafanaOperationPredicate) Matches 

func (p ManagedGrafanaOperationPredicate) Matches(input ManagedGrafana) bool

type ManagedGrafanaProperties 

type ManagedGrafanaProperties struct {
	ApiKey                            *ApiKey                            `json:"apiKey,omitempty"`
	AutoGeneratedDomainNameLabelScope *AutoGeneratedDomainNameLabelScope `json:"autoGeneratedDomainNameLabelScope,omitempty"`
	DeterministicOutboundIP           *DeterministicOutboundIP           `json:"deterministicOutboundIP,omitempty"`
	Endpoint                          *string                            `json:"endpoint,omitempty"`
	GrafanaIntegrations               *GrafanaIntegrations               `json:"grafanaIntegrations,omitempty"`
	GrafanaVersion                    *string                            `json:"grafanaVersion,omitempty"`
	OutboundIPs                       *[]string                          `json:"outboundIPs,omitempty"`
	PrivateEndpointConnections        *[]PrivateEndpointConnection       `json:"privateEndpointConnections,omitempty"`
	ProvisioningState                 *ProvisioningState                 `json:"provisioningState,omitempty"`
	PublicNetworkAccess               *PublicNetworkAccess               `json:"publicNetworkAccess,omitempty"`
	ZoneRedundancy                    *ZoneRedundancy                    `json:"zoneRedundancy,omitempty"`
}

type ManagedGrafanaPropertiesUpdateParameters 

type ManagedGrafanaPropertiesUpdateParameters struct {
	ApiKey                  *ApiKey                  `json:"apiKey,omitempty"`
	DeterministicOutboundIP *DeterministicOutboundIP `json:"deterministicOutboundIP,omitempty"`
	GrafanaIntegrations     *GrafanaIntegrations     `json:"grafanaIntegrations,omitempty"`
	PublicNetworkAccess     *PublicNetworkAccess     `json:"publicNetworkAccess,omitempty"`
	ZoneRedundancy          *ZoneRedundancy          `json:"zoneRedundancy,omitempty"`
}

type ManagedGrafanaUpdateParameters 

type ManagedGrafanaUpdateParameters struct {
	Identity   *identity.LegacySystemAndUserAssignedMap  `json:"identity,omitempty"`
	Properties *ManagedGrafanaPropertiesUpdateParameters `json:"properties,omitempty"`
	Tags       *map[string]string                        `json:"tags,omitempty"`
}

type PrivateEndpoint 

type PrivateEndpoint struct {
	Id *string `json:"id,omitempty"`
}

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	Id         *string                              `json:"id,omitempty"`
	Name       *string                              `json:"name,omitempty"`
	Properties *PrivateEndpointConnectionProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData               `json:"systemData,omitempty"`
	Type       *string                              `json:"type,omitempty"`
}

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	GroupIds                          *[]string                                   `json:"groupIds,omitempty"`
	PrivateEndpoint                   *PrivateEndpoint                            `json:"privateEndpoint,omitempty"`
	PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState           `json:"privateLinkServiceConnectionState"`
	ProvisioningState                 *PrivateEndpointConnectionProvisioningState `json:"provisioningState,omitempty"`
}

type PrivateEndpointConnectionProvisioningState 

type PrivateEndpointConnectionProvisioningState string
const (
	PrivateEndpointConnectionProvisioningStateCreating  PrivateEndpointConnectionProvisioningState = "Creating"
	PrivateEndpointConnectionProvisioningStateDeleting  PrivateEndpointConnectionProvisioningState = "Deleting"
	PrivateEndpointConnectionProvisioningStateFailed    PrivateEndpointConnectionProvisioningState = "Failed"
	PrivateEndpointConnectionProvisioningStateSucceeded PrivateEndpointConnectionProvisioningState = "Succeeded"
)

func (*PrivateEndpointConnectionProvisioningState) UnmarshalJSON 

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

type PrivateEndpointServiceConnectionStatus 

type PrivateEndpointServiceConnectionStatus string
const (
	PrivateEndpointServiceConnectionStatusApproved PrivateEndpointServiceConnectionStatus = "Approved"
	PrivateEndpointServiceConnectionStatusPending  PrivateEndpointServiceConnectionStatus = "Pending"
	PrivateEndpointServiceConnectionStatusRejected PrivateEndpointServiceConnectionStatus = "Rejected"
)

func (*PrivateEndpointServiceConnectionStatus) UnmarshalJSON 

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

type PrivateLinkServiceConnectionState 

type PrivateLinkServiceConnectionState struct {
	ActionsRequired *string                                 `json:"actionsRequired,omitempty"`
	Description     *string                                 `json:"description,omitempty"`
	Status          *PrivateEndpointServiceConnectionStatus `json:"status,omitempty"`
}

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type PublicNetworkAccess 

type PublicNetworkAccess string
const (
	PublicNetworkAccessDisabled PublicNetworkAccess = "Disabled"
	PublicNetworkAccessEnabled  PublicNetworkAccess = "Enabled"
)

func (*PublicNetworkAccess) UnmarshalJSON 

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

type ResourceSku 

type ResourceSku struct {
	Name string `json:"name"`
}

type ZoneRedundancy 

type ZoneRedundancy string
const (
	ZoneRedundancyDisabled ZoneRedundancy = "Disabled"
	ZoneRedundancyEnabled  ZoneRedundancy = "Enabled"
)

func (*ZoneRedundancy) UnmarshalJSON 

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

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.