usages

README

github.com/hashicorp/go-azure-sdk/resource-manager/purview/2021-12-01/usages Documentation

The usages SDK allows for interaction with the Azure Resource Manager Service purview (API Version 2021-12-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/purview/2021-12-01/usages"

Client Initialization

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

Example Usage: UsagesClient.Get

ctx := context.TODO()
id := usages.NewLocationID("12345678-1234-9876-4563-123456789012", "locationValue")

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

Documentation

Index

• func ValidateLocationID(input interface{}, key string) (warnings []string, errors []error)
• type GetOperationOptions
  • func DefaultGetOperationOptions() GetOperationOptions
• type GetOperationResponse
• type LocationId
  • func NewLocationID(subscriptionId string, locationName string) LocationId
  • func ParseLocationID(input string) (*LocationId, error)
  • func ParseLocationIDInsensitively(input string) (*LocationId, error)
  • func (id LocationId) ID() string
  • func (id LocationId) Segments() []resourceids.Segment
  • func (id LocationId) String() string
• type QuotaName
• type Usage
• type UsageList
• type UsagesClient
  • func NewUsagesClientWithBaseURI(endpoint string) UsagesClient
  • func (c UsagesClient) Get(ctx context.Context, id LocationId, options GetOperationOptions) (result GetOperationResponse, err error)

Functions

func ValidateLocationID

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

ValidateLocationID checks that 'input' can be parsed as a Location ID

Types

type GetOperationOptions

type GetOperationOptions struct {
	Filter *string
}

func DefaultGetOperationOptions

func DefaultGetOperationOptions() GetOperationOptions

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	Model        *UsageList
}

type LocationId

type LocationId struct {
	SubscriptionId string
	LocationName   string
}

LocationId is a struct representing the Resource ID for a Location

func NewLocationID

func NewLocationID(subscriptionId string, locationName string) LocationId

NewLocationID returns a new LocationId struct

func ParseLocationID

func ParseLocationID(input string) (*LocationId, error)

ParseLocationID parses 'input' into a LocationId

func ParseLocationIDInsensitively

func ParseLocationIDInsensitively(input string) (*LocationId, error)

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

func (LocationId) ID

func (id LocationId) ID() string

ID returns the formatted Location ID

func (LocationId) Segments

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

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

func (LocationId) String

func (id LocationId) String() string

String returns a human-readable description of this Location ID

type QuotaName

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

type Usage

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

type UsageList

type UsageList struct {
	NextLink *string  `json:"nextLink,omitempty"`
	Value    *[]Usage `json:"value,omitempty"`
}

type UsagesClient

type UsagesClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewUsagesClientWithBaseURI

func NewUsagesClientWithBaseURI(endpoint string) UsagesClient

func (UsagesClient) Get

func (c UsagesClient) Get(ctx context.Context, id LocationId, options GetOperationOptions) (result GetOperationResponse, err error)

Get ...