volumequotarules

package
v0.20240425.1225320 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 25, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2023-05-01/volumequotarules Documentation

The volumequotarules SDK allows for interaction with the Azure Resource Manager Service netapp (API Version 2023-05-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/netapp/2023-05-01/volumequotarules"

Client Initialization

client := volumequotarules.NewVolumeQuotaRulesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: VolumeQuotaRulesClient.Create

ctx := context.TODO()
id := volumequotarules.NewVolumeQuotaRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue", "volumeQuotaRuleValue")

payload := volumequotarules.VolumeQuotaRule{
	// ...
}


if err := client.CreateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: VolumeQuotaRulesClient.Delete

ctx := context.TODO()
id := volumequotarules.NewVolumeQuotaRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue", "volumeQuotaRuleValue")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: VolumeQuotaRulesClient.Get

ctx := context.TODO()
id := volumequotarules.NewVolumeQuotaRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue", "volumeQuotaRuleValue")

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

Example Usage: VolumeQuotaRulesClient.ListByVolume

ctx := context.TODO()
id := volumequotarules.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue")

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

Example Usage: VolumeQuotaRulesClient.Update

ctx := context.TODO()
id := volumequotarules.NewVolumeQuotaRuleID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue", "volumeQuotaRuleValue")

payload := volumequotarules.VolumeQuotaRulePatch{
	// ...
}


if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForProvisioningState

func PossibleValuesForProvisioningState() []string

func PossibleValuesForType

func PossibleValuesForType() []string

func ValidateVolumeID

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

ValidateVolumeID checks that 'input' can be parsed as a Volume ID

func ValidateVolumeQuotaRuleID

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

ValidateVolumeQuotaRuleID checks that 'input' can be parsed as a Volume Quota Rule ID

Types

type CreateOperationResponse

type CreateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VolumeQuotaRule
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VolumeQuotaRule
}

type ListByVolumeOperationResponse

type ListByVolumeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VolumeQuotaRulesList
}

type ProvisioningState

type ProvisioningState string
const (
	ProvisioningStateAccepted  ProvisioningState = "Accepted"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStatePatching  ProvisioningState = "Patching"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON

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

type Type

type Type string
const (
	TypeDefaultGroupQuota    Type = "DefaultGroupQuota"
	TypeDefaultUserQuota     Type = "DefaultUserQuota"
	TypeIndividualGroupQuota Type = "IndividualGroupQuota"
	TypeIndividualUserQuota  Type = "IndividualUserQuota"
)

func (*Type) UnmarshalJSON

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

type UpdateOperationResponse

type UpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *VolumeQuotaRule
}

type VolumeId

type VolumeId struct {
	SubscriptionId    string
	ResourceGroupName string
	NetAppAccountName string
	CapacityPoolName  string
	VolumeName        string
}

VolumeId is a struct representing the Resource ID for a Volume

func NewVolumeID

func NewVolumeID(subscriptionId string, resourceGroupName string, netAppAccountName string, capacityPoolName string, volumeName string) VolumeId

NewVolumeID returns a new VolumeId struct

func ParseVolumeID

func ParseVolumeID(input string) (*VolumeId, error)

ParseVolumeID parses 'input' into a VolumeId

func ParseVolumeIDInsensitively

func ParseVolumeIDInsensitively(input string) (*VolumeId, error)

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

func (*VolumeId) FromParseResult

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

func (VolumeId) ID

func (id VolumeId) ID() string

ID returns the formatted Volume ID

func (VolumeId) Segments

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

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

func (VolumeId) String

func (id VolumeId) String() string

String returns a human-readable description of this Volume ID

type VolumeQuotaRule

type VolumeQuotaRule struct {
	Id         *string                     `json:"id,omitempty"`
	Location   string                      `json:"location"`
	Name       *string                     `json:"name,omitempty"`
	Properties *VolumeQuotaRulesProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData      `json:"systemData,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type VolumeQuotaRuleId

type VolumeQuotaRuleId struct {
	SubscriptionId      string
	ResourceGroupName   string
	NetAppAccountName   string
	CapacityPoolName    string
	VolumeName          string
	VolumeQuotaRuleName string
}

VolumeQuotaRuleId is a struct representing the Resource ID for a Volume Quota Rule

func NewVolumeQuotaRuleID

func NewVolumeQuotaRuleID(subscriptionId string, resourceGroupName string, netAppAccountName string, capacityPoolName string, volumeName string, volumeQuotaRuleName string) VolumeQuotaRuleId

NewVolumeQuotaRuleID returns a new VolumeQuotaRuleId struct

func ParseVolumeQuotaRuleID

func ParseVolumeQuotaRuleID(input string) (*VolumeQuotaRuleId, error)

ParseVolumeQuotaRuleID parses 'input' into a VolumeQuotaRuleId

func ParseVolumeQuotaRuleIDInsensitively

func ParseVolumeQuotaRuleIDInsensitively(input string) (*VolumeQuotaRuleId, error)

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

func (*VolumeQuotaRuleId) FromParseResult

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

func (VolumeQuotaRuleId) ID

func (id VolumeQuotaRuleId) ID() string

ID returns the formatted Volume Quota Rule ID

func (VolumeQuotaRuleId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Volume Quota Rule ID

func (VolumeQuotaRuleId) String

func (id VolumeQuotaRuleId) String() string

String returns a human-readable description of this Volume Quota Rule ID

type VolumeQuotaRulePatch

type VolumeQuotaRulePatch struct {
	Properties *VolumeQuotaRulesProperties `json:"properties,omitempty"`
	Tags       *map[string]string          `json:"tags,omitempty"`
}

type VolumeQuotaRulesClient

type VolumeQuotaRulesClient struct {
	Client *resourcemanager.Client
}

func NewVolumeQuotaRulesClientWithBaseURI

func NewVolumeQuotaRulesClientWithBaseURI(sdkApi sdkEnv.Api) (*VolumeQuotaRulesClient, error)

func (VolumeQuotaRulesClient) Create

Create ...

func (VolumeQuotaRulesClient) CreateThenPoll

CreateThenPoll performs Create then polls until it's completed

func (VolumeQuotaRulesClient) Delete

Delete ...

func (VolumeQuotaRulesClient) DeleteThenPoll

func (c VolumeQuotaRulesClient) DeleteThenPoll(ctx context.Context, id VolumeQuotaRuleId) error

DeleteThenPoll performs Delete then polls until it's completed

func (VolumeQuotaRulesClient) Get

Get ...

func (VolumeQuotaRulesClient) ListByVolume

func (c VolumeQuotaRulesClient) ListByVolume(ctx context.Context, id VolumeId) (result ListByVolumeOperationResponse, err error)

ListByVolume ...

func (VolumeQuotaRulesClient) Update

Update ...

func (VolumeQuotaRulesClient) UpdateThenPoll

UpdateThenPoll performs Update then polls until it's completed

type VolumeQuotaRulesList

type VolumeQuotaRulesList struct {
	Value *[]VolumeQuotaRule `json:"value,omitempty"`
}

type VolumeQuotaRulesProperties

type VolumeQuotaRulesProperties struct {
	ProvisioningState *ProvisioningState `json:"provisioningState,omitempty"`
	QuotaSizeInKiBs   *int64             `json:"quotaSizeInKiBs,omitempty"`
	QuotaTarget       *string            `json:"quotaTarget,omitempty"`
	QuotaType         *Type              `json:"quotaType,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL