monitoringconfig

package
v0.20241009.1142232 Latest Latest
Warning

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

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

README

github.com/hashicorp/go-azure-sdk/resource-manager/databoxedge/2023-07-01/monitoringconfig Documentation

The monitoringconfig SDK allows for interaction with Azure Resource Manager databoxedge (API Version 2023-07-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/databoxedge/2023-07-01/monitoringconfig"

Client Initialization

client := monitoringconfig.NewMonitoringConfigClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: MonitoringConfigClient.CreateOrUpdate

ctx := context.TODO()
id := monitoringconfig.NewRoleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceName", "roleName")

payload := monitoringconfig.MonitoringMetricConfiguration{
	// ...
}


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

Example Usage: MonitoringConfigClient.Delete

ctx := context.TODO()
id := monitoringconfig.NewRoleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceName", "roleName")

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

Example Usage: MonitoringConfigClient.Get

ctx := context.TODO()
id := monitoringconfig.NewRoleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceName", "roleName")

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

Example Usage: MonitoringConfigClient.List

ctx := context.TODO()
id := monitoringconfig.NewRoleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "dataBoxEdgeDeviceName", "roleName")

// 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

Constants

This section is empty.

Variables

This section is empty.

Functions

func ValidateRoleID 

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

ValidateRoleID checks that 'input' can be parsed as a Role ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MonitoringMetricConfiguration
}

type DeleteOperationResponse 

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

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *MonitoringMetricConfiguration
}

type ListCompleteResult 

type ListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []MonitoringMetricConfiguration
}

type ListCustomPager added in v0.20240628.1153531 

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

type ListOperationResponse 

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

type MetricConfiguration 

type MetricConfiguration struct {
	CounterSets     []MetricCounterSet `json:"counterSets"`
	MdmAccount      *string            `json:"mdmAccount,omitempty"`
	MetricNameSpace *string            `json:"metricNameSpace,omitempty"`
	ResourceId      string             `json:"resourceId"`
}

type MetricCounter 

type MetricCounter struct {
	AdditionalDimensions *[]MetricDimension `json:"additionalDimensions,omitempty"`
	DimensionFilter      *[]MetricDimension `json:"dimensionFilter,omitempty"`
	Instance             *string            `json:"instance,omitempty"`
	Name                 string             `json:"name"`
}

type MetricCounterSet 

type MetricCounterSet struct {
	Counters []MetricCounter `json:"counters"`
}

type MetricDimension 

type MetricDimension struct {
	SourceName string `json:"sourceName"`
	SourceType string `json:"sourceType"`
}

type MonitoringConfigClient 

type MonitoringConfigClient struct {
	Client *resourcemanager.Client
}

func NewMonitoringConfigClientWithBaseURI 

func NewMonitoringConfigClientWithBaseURI(sdkApi sdkEnv.Api) (*MonitoringConfigClient, error)

func (MonitoringConfigClient) CreateOrUpdate 

func (c MonitoringConfigClient) CreateOrUpdate(ctx context.Context, id RoleId, input MonitoringMetricConfiguration) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (MonitoringConfigClient) CreateOrUpdateThenPoll 

func (c MonitoringConfigClient) CreateOrUpdateThenPoll(ctx context.Context, id RoleId, input MonitoringMetricConfiguration) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (MonitoringConfigClient) Delete 

func (c MonitoringConfigClient) Delete(ctx context.Context, id RoleId) (result DeleteOperationResponse, err error)

Delete ...

func (MonitoringConfigClient) DeleteThenPoll 

func (c MonitoringConfigClient) DeleteThenPoll(ctx context.Context, id RoleId) error

DeleteThenPoll performs Delete then polls until it's completed

func (MonitoringConfigClient) Get 

func (c MonitoringConfigClient) Get(ctx context.Context, id RoleId) (result GetOperationResponse, err error)

Get ...

func (MonitoringConfigClient) List 

func (c MonitoringConfigClient) List(ctx context.Context, id RoleId) (result ListOperationResponse, err error)

List ...

func (MonitoringConfigClient) ListComplete 

func (c MonitoringConfigClient) ListComplete(ctx context.Context, id RoleId) (ListCompleteResult, error)

ListComplete retrieves all the results into a single object

func (MonitoringConfigClient) ListCompleteMatchingPredicate 

func (c MonitoringConfigClient) ListCompleteMatchingPredicate(ctx context.Context, id RoleId, predicate MonitoringMetricConfigurationOperationPredicate) (result ListCompleteResult, err error)

ListCompleteMatchingPredicate retrieves all the results and then applies the predicate

type MonitoringMetricConfiguration 

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

type MonitoringMetricConfigurationOperationPredicate 

type MonitoringMetricConfigurationOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (MonitoringMetricConfigurationOperationPredicate) Matches 

func (p MonitoringMetricConfigurationOperationPredicate) Matches(input MonitoringMetricConfiguration) bool

type MonitoringMetricConfigurationProperties 

type MonitoringMetricConfigurationProperties struct {
	MetricConfigurations []MetricConfiguration `json:"metricConfigurations"`
}

type RoleId 

type RoleId struct {
	SubscriptionId        string
	ResourceGroupName     string
	DataBoxEdgeDeviceName string
	RoleName              string
}

RoleId is a struct representing the Resource ID for a Role

func NewRoleID 

func NewRoleID(subscriptionId string, resourceGroupName string, dataBoxEdgeDeviceName string, roleName string) RoleId

NewRoleID returns a new RoleId struct

func ParseRoleID 

func ParseRoleID(input string) (*RoleId, error)

ParseRoleID parses 'input' into a RoleId

func ParseRoleIDInsensitively 

func ParseRoleIDInsensitively(input string) (*RoleId, error)

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

func (*RoleId) FromParseResult 

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

func (RoleId) ID 

func (id RoleId) ID() string

ID returns the formatted Role ID

func (RoleId) Segments 

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

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

func (RoleId) String 

func (id RoleId) String() string

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