expressroutecircuitstats

README

github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-06-01/expressroutecircuitstats Documentation

The expressroutecircuitstats SDK allows for interaction with the Azure Resource Manager Service network (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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/network/2023-06-01/expressroutecircuitstats"

Client Initialization

client := expressroutecircuitstats.NewExpressRouteCircuitStatsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ExpressRouteCircuitStatsClient.ExpressRouteCircuitsGetPeeringStats

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

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

Example Usage: ExpressRouteCircuitStatsClient.ExpressRouteCircuitsGetStats

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

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

Documentation

Index

• func ValidateExpressRouteCircuitID(input interface{}, key string) (warnings []string, errors []error)
• type ExpressRouteCircuitId
  • func NewExpressRouteCircuitID(subscriptionId string, resourceGroupName string, ...) ExpressRouteCircuitId
  • func ParseExpressRouteCircuitID(input string) (*ExpressRouteCircuitId, error)
  • func ParseExpressRouteCircuitIDInsensitively(input string) (*ExpressRouteCircuitId, error)
  • func (id *ExpressRouteCircuitId) FromParseResult(input resourceids.ParseResult) error
  • func (id ExpressRouteCircuitId) ID() string
  • func (id ExpressRouteCircuitId) Segments() []resourceids.Segment
  • func (id ExpressRouteCircuitId) String() string
• type ExpressRouteCircuitStats
• type ExpressRouteCircuitStatsClient
  • func NewExpressRouteCircuitStatsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteCircuitStatsClient, error)
  • func (c ExpressRouteCircuitStatsClient) ExpressRouteCircuitsGetPeeringStats(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId) (result ExpressRouteCircuitsGetPeeringStatsOperationResponse, err error)
  • func (c ExpressRouteCircuitStatsClient) ExpressRouteCircuitsGetStats(ctx context.Context, id ExpressRouteCircuitId) (result ExpressRouteCircuitsGetStatsOperationResponse, err error)
• type ExpressRouteCircuitsGetPeeringStatsOperationResponse
• type ExpressRouteCircuitsGetStatsOperationResponse

Functions

func ValidateExpressRouteCircuitID

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

ValidateExpressRouteCircuitID checks that 'input' can be parsed as a Express Route Circuit ID

Types

type ExpressRouteCircuitId

type ExpressRouteCircuitId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ExpressRouteCircuitName string
}

ExpressRouteCircuitId is a struct representing the Resource ID for a Express Route Circuit

func NewExpressRouteCircuitID

func NewExpressRouteCircuitID(subscriptionId string, resourceGroupName string, expressRouteCircuitName string) ExpressRouteCircuitId

NewExpressRouteCircuitID returns a new ExpressRouteCircuitId struct

func ParseExpressRouteCircuitID

func ParseExpressRouteCircuitID(input string) (*ExpressRouteCircuitId, error)

ParseExpressRouteCircuitID parses 'input' into a ExpressRouteCircuitId

func ParseExpressRouteCircuitIDInsensitively

func ParseExpressRouteCircuitIDInsensitively(input string) (*ExpressRouteCircuitId, error)

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

func (*ExpressRouteCircuitId) FromParseResult

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

func (ExpressRouteCircuitId) ID

func (id ExpressRouteCircuitId) ID() string

ID returns the formatted Express Route Circuit ID

func (ExpressRouteCircuitId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Express Route Circuit ID

func (ExpressRouteCircuitId) String

func (id ExpressRouteCircuitId) String() string

String returns a human-readable description of this Express Route Circuit ID

type ExpressRouteCircuitStats

type ExpressRouteCircuitStats struct {
	PrimarybytesIn    *int64 `json:"primarybytesIn,omitempty"`
	PrimarybytesOut   *int64 `json:"primarybytesOut,omitempty"`
	SecondarybytesIn  *int64 `json:"secondarybytesIn,omitempty"`
	SecondarybytesOut *int64 `json:"secondarybytesOut,omitempty"`
}

type ExpressRouteCircuitStatsClient

type ExpressRouteCircuitStatsClient struct {
	Client *resourcemanager.Client
}

func NewExpressRouteCircuitStatsClientWithBaseURI

func NewExpressRouteCircuitStatsClientWithBaseURI(sdkApi sdkEnv.Api) (*ExpressRouteCircuitStatsClient, error)

func (ExpressRouteCircuitStatsClient) ExpressRouteCircuitsGetPeeringStats

func (c ExpressRouteCircuitStatsClient) ExpressRouteCircuitsGetPeeringStats(ctx context.Context, id commonids.ExpressRouteCircuitPeeringId) (result ExpressRouteCircuitsGetPeeringStatsOperationResponse, err error)

ExpressRouteCircuitsGetPeeringStats ...

func (ExpressRouteCircuitStatsClient) ExpressRouteCircuitsGetStats

func (c ExpressRouteCircuitStatsClient) ExpressRouteCircuitsGetStats(ctx context.Context, id ExpressRouteCircuitId) (result ExpressRouteCircuitsGetStatsOperationResponse, err error)

ExpressRouteCircuitsGetStats ...

type ExpressRouteCircuitsGetPeeringStatsOperationResponse

type ExpressRouteCircuitsGetPeeringStatsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExpressRouteCircuitStats
}

type ExpressRouteCircuitsGetStatsOperationResponse

type ExpressRouteCircuitsGetStatsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ExpressRouteCircuitStats
}