backupusagesummaries

README

github.com/hashicorp/go-azure-sdk/resource-manager/recoveryservicesbackup/2024-04-01/backupusagesummaries Documentation

The backupusagesummaries SDK allows for interaction with Azure Resource Manager recoveryservicesbackup (API Version 2024-04-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/recoveryservicesbackup/2024-04-01/backupusagesummaries"

Client Initialization

client := backupusagesummaries.NewBackupUsageSummariesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BackupUsageSummariesClient.List

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

read, err := client.List(ctx, id, backupusagesummaries.DefaultListOperationOptions())
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 BackupManagementUsage
  • func (o *BackupManagementUsage) GetNextResetTimeAsTime() (*time.Time, error)
  • func (o *BackupManagementUsage) SetNextResetTimeAsTime(input time.Time)
• type BackupManagementUsageList
• type BackupUsageSummariesClient
  • func NewBackupUsageSummariesClientWithBaseURI(endpoint string) BackupUsageSummariesClient
  • func (c BackupUsageSummariesClient) List(ctx context.Context, id VaultId, options ListOperationOptions) (result ListOperationResponse, err error)
• type ListOperationOptions
  • func DefaultListOperationOptions() ListOperationOptions
• type ListOperationResponse
• type NameInfo
• type UsagesUnit
• 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) FromParseResult(input resourceids.ParseResult) error
  • func (id VaultId) ID() string
  • func (id VaultId) Segments() []resourceids.Segment
  • func (id VaultId) String() string

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 BackupManagementUsage

type BackupManagementUsage 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 (*BackupManagementUsage) GetNextResetTimeAsTime

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

func (*BackupManagementUsage) SetNextResetTimeAsTime

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

type BackupManagementUsageList

type BackupManagementUsageList struct {
	Value *[]BackupManagementUsage `json:"value,omitempty"`
}

type BackupUsageSummariesClient

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

func NewBackupUsageSummariesClientWithBaseURI

func NewBackupUsageSummariesClientWithBaseURI(endpoint string) BackupUsageSummariesClient

func (BackupUsageSummariesClient) List

func (c BackupUsageSummariesClient) List(ctx context.Context, id VaultId, options ListOperationOptions) (result ListOperationResponse, err error)

List ...

type ListOperationOptions

type ListOperationOptions struct {
	Filter *string
}

func DefaultListOperationOptions

func DefaultListOperationOptions() ListOperationOptions

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *BackupManagementUsageList
}

type NameInfo

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

type UsagesUnit

type UsagesUnit string

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

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) FromParseResult

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

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