vaultusages

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservices/2023-06-01/vaultusages Documentation

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

Client Initialization

client := vaultusages.NewVaultUsagesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VaultUsagesClient.UsagesListByVaults

ctx := context.TODO()
id := vaultusages.NewVaultID("12345678-1234-9876-4563-123456789012", "example-resource-group", "vaultValue")

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

Documentation

Index

• func PossibleValuesForUsagesUnit() []string
• func ValidateVaultID(input interface{}, key string) (warnings []string, errors []error)
• type NameInfo
• type UsagesListByVaultsOperationResponse
• type UsagesUnit
  • func (s *UsagesUnit) UnmarshalJSON(bytes []byte) error
• type VaultId
  • func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId
  • func ParseVaultID(input string) (*VaultId, error)
  • func ParseVaultIDInsensitively(input string) (*VaultId, error)
  • func (id VaultId) ID() string
  • func (id VaultId) Segments() []resourceids.Segment
  • func (id VaultId) String() string
• type VaultUsage
  • func (o *VaultUsage) GetNextResetTimeAsTime() (*time.Time, error)
  • func (o *VaultUsage) SetNextResetTimeAsTime(input time.Time)
• type VaultUsageList
• type VaultUsagesClient
  • func NewVaultUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*VaultUsagesClient, error)
  • func (c VaultUsagesClient) UsagesListByVaults(ctx context.Context, id VaultId) (result UsagesListByVaultsOperationResponse, err error)

Functions

func PossibleValuesForUsagesUnit

func PossibleValuesForUsagesUnit() []string

func ValidateVaultID

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

ValidateVaultID checks that 'input' can be parsed as a Vault ID

Types

type NameInfo

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

type UsagesListByVaultsOperationResponse

type UsagesListByVaultsOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VaultUsageList
}

type UsagesUnit

type UsagesUnit string

const (
	UsagesUnitBytes          UsagesUnit = "Bytes"
	UsagesUnitBytesPerSecond UsagesUnit = "BytesPerSecond"
	UsagesUnitCount          UsagesUnit = "Count"
	UsagesUnitCountPerSecond UsagesUnit = "CountPerSecond"
	UsagesUnitPercent        UsagesUnit = "Percent"
	UsagesUnitSeconds        UsagesUnit = "Seconds"
)

func (*UsagesUnit) UnmarshalJSON

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

type VaultId

type VaultId struct {
	SubscriptionId    string
	ResourceGroupName string
	VaultName         string
}

VaultId is a struct representing the Resource ID for a Vault

func NewVaultID

func NewVaultID(subscriptionId string, resourceGroupName string, vaultName string) VaultId

NewVaultID returns a new VaultId struct

func ParseVaultID

func ParseVaultID(input string) (*VaultId, error)

ParseVaultID parses 'input' into a VaultId

func ParseVaultIDInsensitively

func ParseVaultIDInsensitively(input string) (*VaultId, error)

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

func (VaultId) ID

func (id VaultId) ID() string

ID returns the formatted Vault ID

func (VaultId) Segments

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

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

func (VaultId) String

func (id VaultId) String() string

String returns a human-readable description of this Vault ID

type VaultUsage

type VaultUsage struct {
	CurrentValue  *int64      `json:"currentValue,omitempty"`
	Limit         *int64      `json:"limit,omitempty"`
	Name          *NameInfo   `json:"name,omitempty"`
	NextResetTime *string     `json:"nextResetTime,omitempty"`
	QuotaPeriod   *string     `json:"quotaPeriod,omitempty"`
	Unit          *UsagesUnit `json:"unit,omitempty"`
}

func (*VaultUsage) GetNextResetTimeAsTime

func (o *VaultUsage) GetNextResetTimeAsTime() (*time.Time, error)

func (*VaultUsage) SetNextResetTimeAsTime

func (o *VaultUsage) SetNextResetTimeAsTime(input time.Time)

type VaultUsageList

type VaultUsageList struct {
	Value *[]VaultUsage `json:"value,omitempty"`
}

type VaultUsagesClient

type VaultUsagesClient struct {
	Client *resourcemanager.Client
}

func NewVaultUsagesClientWithBaseURI

func NewVaultUsagesClientWithBaseURI(sdkApi sdkEnv.Api) (*VaultUsagesClient, error)

func (VaultUsagesClient) UsagesListByVaults

func (c VaultUsagesClient) UsagesListByVaults(ctx context.Context, id VaultId) (result UsagesListByVaultsOperationResponse, err error)

UsagesListByVaults ...