volumequotarules

package
v0.20231002.1065327 Latest Latest
Warning

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

 Go to latest Published: Oct 2, 2023 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

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

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 added in v0.20230712.1163130 

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 added in v0.20230712.1163130 

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

type UpdateOperationResponse 

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

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) 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) 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"`
}

type VolumeQuotaRulesClient 

type VolumeQuotaRulesClient struct {
	Client *resourcemanager.Client
}

func NewVolumeQuotaRulesClientWithBaseURI 

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

func (VolumeQuotaRulesClient) Create 

func (c VolumeQuotaRulesClient) Create(ctx context.Context, id VolumeQuotaRuleId, input VolumeQuotaRule) (result CreateOperationResponse, err error)

Create ...

func (VolumeQuotaRulesClient) CreateThenPoll 

func (c VolumeQuotaRulesClient) CreateThenPoll(ctx context.Context, id VolumeQuotaRuleId, input VolumeQuotaRule) error

CreateThenPoll performs Create then polls until it's completed

func (VolumeQuotaRulesClient) Delete 

func (c VolumeQuotaRulesClient) Delete(ctx context.Context, id VolumeQuotaRuleId) (result DeleteOperationResponse, err error)

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 

func (c VolumeQuotaRulesClient) Get(ctx context.Context, id VolumeQuotaRuleId) (result GetOperationResponse, err error)

Get ...

func (VolumeQuotaRulesClient) ListByVolume 

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

ListByVolume ...

func (VolumeQuotaRulesClient) Update 

func (c VolumeQuotaRulesClient) Update(ctx context.Context, id VolumeQuotaRuleId, input VolumeQuotaRulePatch) (result UpdateOperationResponse, err error)

Update ...

func (VolumeQuotaRulesClient) UpdateThenPoll 

func (c VolumeQuotaRulesClient) UpdateThenPoll(ctx context.Context, id VolumeQuotaRuleId, input VolumeQuotaRulePatch) error

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"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.