capacitypools

package
v0.20240117.1113630 Latest Latest
Warning

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

 Go to latest Published: Jan 17, 2024 License: MPL-2.0 Imports: 12 Imported by: 2

README

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

The capacitypools 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/capacitypools"

Client Initialization

client := capacitypools.NewCapacityPoolsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: CapacityPoolsClient.PoolsCreateOrUpdate

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

payload := capacitypools.CapacityPool{
	// ...
}


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

Example Usage: CapacityPoolsClient.PoolsDelete

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

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

Example Usage: CapacityPoolsClient.PoolsGet

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

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

Example Usage: CapacityPoolsClient.PoolsList

ctx := context.TODO()
id := capacitypools.NewNetAppAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue")

// alternatively `client.PoolsList(ctx, id)` can be used to do batched pagination
items, err := client.PoolsListComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: CapacityPoolsClient.PoolsUpdate

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

payload := capacitypools.CapacityPoolPatch{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForEncryptionType 

func PossibleValuesForEncryptionType() []string

func PossibleValuesForQosType 

func PossibleValuesForQosType() []string

func PossibleValuesForServiceLevel 

func PossibleValuesForServiceLevel() []string

func ValidateCapacityPoolID 

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

ValidateCapacityPoolID checks that 'input' can be parsed as a Capacity Pool ID

func ValidateNetAppAccountID 

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

ValidateNetAppAccountID checks that 'input' can be parsed as a Net App Account ID

Types

type CapacityPool 

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

type CapacityPoolId 

type CapacityPoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	NetAppAccountName string
	CapacityPoolName  string
}

CapacityPoolId is a struct representing the Resource ID for a Capacity Pool

func NewCapacityPoolID 

func NewCapacityPoolID(subscriptionId string, resourceGroupName string, netAppAccountName string, capacityPoolName string) CapacityPoolId

NewCapacityPoolID returns a new CapacityPoolId struct

func ParseCapacityPoolID 

func ParseCapacityPoolID(input string) (*CapacityPoolId, error)

ParseCapacityPoolID parses 'input' into a CapacityPoolId

func ParseCapacityPoolIDInsensitively 

func ParseCapacityPoolIDInsensitively(input string) (*CapacityPoolId, error)

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

func (*CapacityPoolId) FromParseResult added in v0.20231127.1171502 

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

func (CapacityPoolId) ID 

func (id CapacityPoolId) ID() string

ID returns the formatted Capacity Pool ID

func (CapacityPoolId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Capacity Pool ID

func (CapacityPoolId) String 

func (id CapacityPoolId) String() string

String returns a human-readable description of this Capacity Pool ID

type CapacityPoolOperationPredicate 

type CapacityPoolOperationPredicate struct {
	Etag     *string
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (CapacityPoolOperationPredicate) Matches 

func (p CapacityPoolOperationPredicate) Matches(input CapacityPool) bool

type CapacityPoolPatch 

type CapacityPoolPatch struct {
	Id         *string              `json:"id,omitempty"`
	Location   *string              `json:"location,omitempty"`
	Name       *string              `json:"name,omitempty"`
	Properties *PoolPatchProperties `json:"properties,omitempty"`
	Tags       *map[string]string   `json:"tags,omitempty"`
	Type       *string              `json:"type,omitempty"`
}

type CapacityPoolsClient 

type CapacityPoolsClient struct {
	Client *resourcemanager.Client
}

func NewCapacityPoolsClientWithBaseURI 

func NewCapacityPoolsClientWithBaseURI(sdkApi sdkEnv.Api) (*CapacityPoolsClient, error)

func (CapacityPoolsClient) PoolsCreateOrUpdate 

func (c CapacityPoolsClient) PoolsCreateOrUpdate(ctx context.Context, id CapacityPoolId, input CapacityPool) (result PoolsCreateOrUpdateOperationResponse, err error)

PoolsCreateOrUpdate ...

func (CapacityPoolsClient) PoolsCreateOrUpdateThenPoll 

func (c CapacityPoolsClient) PoolsCreateOrUpdateThenPoll(ctx context.Context, id CapacityPoolId, input CapacityPool) error

PoolsCreateOrUpdateThenPoll performs PoolsCreateOrUpdate then polls until it's completed

func (CapacityPoolsClient) PoolsDelete 

func (c CapacityPoolsClient) PoolsDelete(ctx context.Context, id CapacityPoolId) (result PoolsDeleteOperationResponse, err error)

PoolsDelete ...

func (CapacityPoolsClient) PoolsDeleteThenPoll 

func (c CapacityPoolsClient) PoolsDeleteThenPoll(ctx context.Context, id CapacityPoolId) error

PoolsDeleteThenPoll performs PoolsDelete then polls until it's completed

func (CapacityPoolsClient) PoolsGet 

func (c CapacityPoolsClient) PoolsGet(ctx context.Context, id CapacityPoolId) (result PoolsGetOperationResponse, err error)

PoolsGet ...

func (CapacityPoolsClient) PoolsList 

func (c CapacityPoolsClient) PoolsList(ctx context.Context, id NetAppAccountId) (result PoolsListOperationResponse, err error)

PoolsList ...

func (CapacityPoolsClient) PoolsListComplete 

func (c CapacityPoolsClient) PoolsListComplete(ctx context.Context, id NetAppAccountId) (PoolsListCompleteResult, error)

PoolsListComplete retrieves all the results into a single object

func (CapacityPoolsClient) PoolsListCompleteMatchingPredicate 

func (c CapacityPoolsClient) PoolsListCompleteMatchingPredicate(ctx context.Context, id NetAppAccountId, predicate CapacityPoolOperationPredicate) (result PoolsListCompleteResult, err error)

PoolsListCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (CapacityPoolsClient) PoolsUpdate 

func (c CapacityPoolsClient) PoolsUpdate(ctx context.Context, id CapacityPoolId, input CapacityPoolPatch) (result PoolsUpdateOperationResponse, err error)

PoolsUpdate ...

func (CapacityPoolsClient) PoolsUpdateThenPoll 

func (c CapacityPoolsClient) PoolsUpdateThenPoll(ctx context.Context, id CapacityPoolId, input CapacityPoolPatch) error

PoolsUpdateThenPoll performs PoolsUpdate then polls until it's completed

type EncryptionType 

type EncryptionType string
const (
	EncryptionTypeDouble EncryptionType = "Double"
	EncryptionTypeSingle EncryptionType = "Single"
)

func (*EncryptionType) UnmarshalJSON 

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

type NetAppAccountId 

type NetAppAccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	NetAppAccountName string
}

NetAppAccountId is a struct representing the Resource ID for a Net App Account

func NewNetAppAccountID 

func NewNetAppAccountID(subscriptionId string, resourceGroupName string, netAppAccountName string) NetAppAccountId

NewNetAppAccountID returns a new NetAppAccountId struct

func ParseNetAppAccountID 

func ParseNetAppAccountID(input string) (*NetAppAccountId, error)

ParseNetAppAccountID parses 'input' into a NetAppAccountId

func ParseNetAppAccountIDInsensitively 

func ParseNetAppAccountIDInsensitively(input string) (*NetAppAccountId, error)

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

func (*NetAppAccountId) FromParseResult added in v0.20231127.1171502 

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

func (NetAppAccountId) ID 

func (id NetAppAccountId) ID() string

ID returns the formatted Net App Account ID

func (NetAppAccountId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Net App Account ID

func (NetAppAccountId) String 

func (id NetAppAccountId) String() string

String returns a human-readable description of this Net App Account ID

type PoolPatchProperties 

type PoolPatchProperties struct {
	CoolAccess *bool    `json:"coolAccess,omitempty"`
	QosType    *QosType `json:"qosType,omitempty"`
	Size       *int64   `json:"size,omitempty"`
}

type PoolProperties 

type PoolProperties struct {
	CoolAccess              *bool           `json:"coolAccess,omitempty"`
	EncryptionType          *EncryptionType `json:"encryptionType,omitempty"`
	PoolId                  *string         `json:"poolId,omitempty"`
	ProvisioningState       *string         `json:"provisioningState,omitempty"`
	QosType                 *QosType        `json:"qosType,omitempty"`
	ServiceLevel            ServiceLevel    `json:"serviceLevel"`
	Size                    int64           `json:"size"`
	TotalThroughputMibps    *float64        `json:"totalThroughputMibps,omitempty"`
	UtilizedThroughputMibps *float64        `json:"utilizedThroughputMibps,omitempty"`
}

type PoolsCreateOrUpdateOperationResponse 

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

type PoolsDeleteOperationResponse 

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

type PoolsGetOperationResponse 

type PoolsGetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CapacityPool
}

type PoolsListCompleteResult 

type PoolsListCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []CapacityPool
}

type PoolsListOperationResponse 

type PoolsListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]CapacityPool
}

type PoolsUpdateOperationResponse 

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

type QosType 

type QosType string
const (
	QosTypeAuto   QosType = "Auto"
	QosTypeManual QosType = "Manual"
)

func (*QosType) UnmarshalJSON 

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

type ServiceLevel 

type ServiceLevel string
const (
	ServiceLevelPremium     ServiceLevel = "Premium"
	ServiceLevelStandard    ServiceLevel = "Standard"
	ServiceLevelStandardZRS ServiceLevel = "StandardZRS"
	ServiceLevelUltra       ServiceLevel = "Ultra"
)

func (*ServiceLevel) UnmarshalJSON 

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

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.