monitoredresources

README

github.com/hashicorp/go-azure-sdk/resource-manager/elastic/2023-06-01/monitoredresources Documentation

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

Client Initialization

client := monitoredresources.NewMonitoredResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MonitoredResourcesClient.List

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

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

Documentation

Index

• func PossibleValuesForSendingLogs() []string
• func ValidateMonitorID(input interface{}, key string) (warnings []string, errors []error)
• type ListCompleteResult
• type ListOperationResponse
• type MonitorId
  • func NewMonitorID(subscriptionId string, resourceGroupName string, monitorName string) MonitorId
  • func ParseMonitorID(input string) (*MonitorId, error)
  • func ParseMonitorIDInsensitively(input string) (*MonitorId, error)
  • func (id MonitorId) ID() string
  • func (id MonitorId) Segments() []resourceids.Segment
  • func (id MonitorId) String() string
• type MonitoredResource
• type MonitoredResourceOperationPredicate
  • func (p MonitoredResourceOperationPredicate) Matches(input MonitoredResource) bool
• type MonitoredResourcesClient
  • func NewMonitoredResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*MonitoredResourcesClient, error)
  • func (c MonitoredResourcesClient) List(ctx context.Context, id MonitorId) (result ListOperationResponse, err error)
  • func (c MonitoredResourcesClient) ListComplete(ctx context.Context, id MonitorId) (ListCompleteResult, error)
  • func (c MonitoredResourcesClient) ListCompleteMatchingPredicate(ctx context.Context, id MonitorId, ...) (result ListCompleteResult, err error)
• type SendingLogs
  • func (s *SendingLogs) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForSendingLogs

func PossibleValuesForSendingLogs() []string

func ValidateMonitorID

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

ValidateMonitorID checks that 'input' can be parsed as a Monitor ID

Types

type ListCompleteResult

type ListCompleteResult struct {
	Items []MonitoredResource
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]MonitoredResource
}

type MonitorId

type MonitorId struct {
	SubscriptionId    string
	ResourceGroupName string
	MonitorName       string
}

MonitorId is a struct representing the Resource ID for a Monitor

func NewMonitorID

func NewMonitorID(subscriptionId string, resourceGroupName string, monitorName string) MonitorId

NewMonitorID returns a new MonitorId struct

func ParseMonitorID

func ParseMonitorID(input string) (*MonitorId, error)

ParseMonitorID parses 'input' into a MonitorId

func ParseMonitorIDInsensitively

func ParseMonitorIDInsensitively(input string) (*MonitorId, error)

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

func (MonitorId) ID

func (id MonitorId) ID() string

ID returns the formatted Monitor ID

func (MonitorId) Segments

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

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

func (MonitorId) String

func (id MonitorId) String() string

String returns a human-readable description of this Monitor ID

type MonitoredResource

type MonitoredResource struct {
	Id                  *string      `json:"id,omitempty"`
	ReasonForLogsStatus *string      `json:"reasonForLogsStatus,omitempty"`
	SendingLogs         *SendingLogs `json:"sendingLogs,omitempty"`
}

type MonitoredResourceOperationPredicate

type MonitoredResourceOperationPredicate struct {
	Id                  *string
	ReasonForLogsStatus *string
}

func (MonitoredResourceOperationPredicate) Matches

func (p MonitoredResourceOperationPredicate) Matches(input MonitoredResource) bool

type MonitoredResourcesClient

type MonitoredResourcesClient struct {
	Client *resourcemanager.Client
}

func NewMonitoredResourcesClientWithBaseURI

func NewMonitoredResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*MonitoredResourcesClient, error)

func (MonitoredResourcesClient) List

func (c MonitoredResourcesClient) List(ctx context.Context, id MonitorId) (result ListOperationResponse, err error)

List ...

func (MonitoredResourcesClient) ListComplete

func (c MonitoredResourcesClient) ListComplete(ctx context.Context, id MonitorId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (MonitoredResourcesClient) ListCompleteMatchingPredicate

func (c MonitoredResourcesClient) ListCompleteMatchingPredicate(ctx context.Context, id MonitorId, predicate MonitoredResourceOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type SendingLogs

type SendingLogs string

const (
	SendingLogsFalse SendingLogs = "False"
	SendingLogsTrue  SendingLogs = "True"
)

func (*SendingLogs) UnmarshalJSON

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