usages

README

github.com/hashicorp/go-azure-sdk/resource-manager/automation/2021-06-22/usages Documentation

The usages SDK allows for interaction with the Azure Resource Manager Service automation (API Version 2021-06-22).

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/automation/2021-06-22/usages"

Client Initialization

client := usages.NewUsagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: UsagesClient.ListByAutomationAccount

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

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

Documentation

Index

• func ValidateAutomationAccountID(input interface{}, key string) (warnings []string, errors []error)
• type AutomationAccountId
  • func NewAutomationAccountID(subscriptionId string, resourceGroupName string, automationAccountName string) AutomationAccountId
  • func ParseAutomationAccountID(input string) (*AutomationAccountId, error)
  • func ParseAutomationAccountIDInsensitively(input string) (*AutomationAccountId, error)
  • func (id *AutomationAccountId) FromParseResult(input resourceids.ParseResult) error
  • func (id AutomationAccountId) ID() string
  • func (id AutomationAccountId) Segments() []resourceids.Segment
  • func (id AutomationAccountId) String() string
• type ListByAutomationAccountOperationResponse
• type Usage
• type UsageCounterName
• type UsageListResult
• type UsagesClient
  • func NewUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*UsagesClient, error)
  • func (c UsagesClient) ListByAutomationAccount(ctx context.Context, id AutomationAccountId) (result ListByAutomationAccountOperationResponse, err error)

Functions

func ValidateAutomationAccountID

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

ValidateAutomationAccountID checks that 'input' can be parsed as a Automation Account ID

Types

type AutomationAccountId

type AutomationAccountId struct {
	SubscriptionId        string
	ResourceGroupName     string
	AutomationAccountName string
}

AutomationAccountId is a struct representing the Resource ID for a Automation Account

func NewAutomationAccountID

func NewAutomationAccountID(subscriptionId string, resourceGroupName string, automationAccountName string) AutomationAccountId

NewAutomationAccountID returns a new AutomationAccountId struct

func ParseAutomationAccountID

func ParseAutomationAccountID(input string) (*AutomationAccountId, error)

ParseAutomationAccountID parses 'input' into a AutomationAccountId

func ParseAutomationAccountIDInsensitively

func ParseAutomationAccountIDInsensitively(input string) (*AutomationAccountId, error)

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

func (*AutomationAccountId) FromParseResult

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

func (AutomationAccountId) ID

func (id AutomationAccountId) ID() string

ID returns the formatted Automation Account ID

func (AutomationAccountId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Automation Account ID

func (AutomationAccountId) String

func (id AutomationAccountId) String() string

String returns a human-readable description of this Automation Account ID

type ListByAutomationAccountOperationResponse

type ListByAutomationAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *UsageListResult
}

type Usage

type Usage struct {
	CurrentValue   *float64          `json:"currentValue,omitempty"`
	Id             *string           `json:"id,omitempty"`
	Limit          *int64            `json:"limit,omitempty"`
	Name           *UsageCounterName `json:"name,omitempty"`
	ThrottleStatus *string           `json:"throttleStatus,omitempty"`
	Unit           *string           `json:"unit,omitempty"`
}

type UsageCounterName

type UsageCounterName struct {
	LocalizedValue *string `json:"localizedValue,omitempty"`
	Value          *string `json:"value,omitempty"`
}

type UsageListResult

type UsageListResult struct {
	Value *[]Usage `json:"value,omitempty"`
}

type UsagesClient

type UsagesClient struct {
	Client *resourcemanager.Client
}

func NewUsagesClientWithBaseURI

func NewUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*UsagesClient, error)

func (UsagesClient) ListByAutomationAccount

func (c UsagesClient) ListByAutomationAccount(ctx context.Context, id AutomationAccountId) (result ListByAutomationAccountOperationResponse, err error)

ListByAutomationAccount ...