README ¶
github.com/hashicorp/go-azure-sdk/resource-manager/netapp/2021-10-01/subvolumes
Documentation
The subvolumes
SDK allows for interaction with the Azure Resource Manager Service netapp
(API Version 2021-10-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/2021-10-01/subvolumes"
Client Initialization
client := subvolumes.NewSubVolumesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: SubVolumesClient.Create
ctx := context.TODO()
id := subvolumes.NewSubVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue", "subVolumeValue")
payload := subvolumes.SubvolumeInfo{
// ...
}
if err := client.CreateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Example Usage: SubVolumesClient.Delete
ctx := context.TODO()
id := subvolumes.NewSubVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue", "subVolumeValue")
if err := client.DeleteThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: SubVolumesClient.Get
ctx := context.TODO()
id := subvolumes.NewSubVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue", "subVolumeValue")
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: SubVolumesClient.GetMetadata
ctx := context.TODO()
id := subvolumes.NewSubVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue", "subVolumeValue")
if err := client.GetMetadataThenPoll(ctx, id); err != nil {
// handle the error
}
Example Usage: SubVolumesClient.ListByVolume
ctx := context.TODO()
id := subvolumes.NewVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue")
// alternatively `client.ListByVolume(ctx, id)` can be used to do batched pagination
items, err := client.ListByVolumeComplete(ctx, id)
if err != nil {
// handle the error
}
for _, item := range items {
// do something
}
Example Usage: SubVolumesClient.Update
ctx := context.TODO()
id := subvolumes.NewSubVolumeID("12345678-1234-9876-4563-123456789012", "example-resource-group", "netAppAccountValue", "capacityPoolValue", "volumeValue", "subVolumeValue")
payload := subvolumes.SubvolumePatchRequest{
// ...
}
if err := client.UpdateThenPoll(ctx, id, payload); err != nil {
// handle the error
}
Documentation ¶
Index ¶
- func ValidateSubVolumeID(input interface{}, key string) (warnings []string, errors []error)
- func ValidateVolumeID(input interface{}, key string) (warnings []string, errors []error)
- type CreateOperationResponse
- type DeleteOperationResponse
- type GetMetadataOperationResponse
- type GetOperationResponse
- type ListByVolumeCompleteResult
- type ListByVolumeOperationResponse
- type SubVolumeId
- type SubVolumesClient
- func (c SubVolumesClient) Create(ctx context.Context, id SubVolumeId, input SubvolumeInfo) (result CreateOperationResponse, err error)
- func (c SubVolumesClient) CreateThenPoll(ctx context.Context, id SubVolumeId, input SubvolumeInfo) error
- func (c SubVolumesClient) Delete(ctx context.Context, id SubVolumeId) (result DeleteOperationResponse, err error)
- func (c SubVolumesClient) DeleteThenPoll(ctx context.Context, id SubVolumeId) error
- func (c SubVolumesClient) Get(ctx context.Context, id SubVolumeId) (result GetOperationResponse, err error)
- func (c SubVolumesClient) GetMetadata(ctx context.Context, id SubVolumeId) (result GetMetadataOperationResponse, err error)
- func (c SubVolumesClient) GetMetadataThenPoll(ctx context.Context, id SubVolumeId) error
- func (c SubVolumesClient) ListByVolume(ctx context.Context, id VolumeId) (resp ListByVolumeOperationResponse, err error)
- func (c SubVolumesClient) ListByVolumeComplete(ctx context.Context, id VolumeId) (ListByVolumeCompleteResult, error)
- func (c SubVolumesClient) ListByVolumeCompleteMatchingPredicate(ctx context.Context, id VolumeId, predicate SubvolumeInfoOperationPredicate) (resp ListByVolumeCompleteResult, err error)
- func (c SubVolumesClient) Update(ctx context.Context, id SubVolumeId, input SubvolumePatchRequest) (result UpdateOperationResponse, err error)
- func (c SubVolumesClient) UpdateThenPoll(ctx context.Context, id SubVolumeId, input SubvolumePatchRequest) error
- type SubvolumeInfo
- type SubvolumeInfoOperationPredicate
- type SubvolumeModel
- type SubvolumeModelProperties
- func (o *SubvolumeModelProperties) GetAccessedTimeStampAsTime() (*time.Time, error)
- func (o *SubvolumeModelProperties) GetChangedTimeStampAsTime() (*time.Time, error)
- func (o *SubvolumeModelProperties) GetCreationTimeStampAsTime() (*time.Time, error)
- func (o *SubvolumeModelProperties) GetModifiedTimeStampAsTime() (*time.Time, error)
- func (o *SubvolumeModelProperties) SetAccessedTimeStampAsTime(input time.Time)
- func (o *SubvolumeModelProperties) SetChangedTimeStampAsTime(input time.Time)
- func (o *SubvolumeModelProperties) SetCreationTimeStampAsTime(input time.Time)
- func (o *SubvolumeModelProperties) SetModifiedTimeStampAsTime(input time.Time)
- type SubvolumePatchParams
- type SubvolumePatchRequest
- type SubvolumeProperties
- type UpdateOperationResponse
- type VolumeId
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateSubVolumeID ¶
ValidateSubVolumeID checks that 'input' can be parsed as a Sub Volume ID
func ValidateVolumeID ¶
ValidateVolumeID checks that 'input' can be parsed as a Volume ID
Types ¶
type CreateOperationResponse ¶
type CreateOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type DeleteOperationResponse ¶
type DeleteOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type GetMetadataOperationResponse ¶
type GetMetadataOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
type GetOperationResponse ¶
type GetOperationResponse struct { HttpResponse *http.Response Model *SubvolumeInfo }
type ListByVolumeCompleteResult ¶
type ListByVolumeCompleteResult struct {
Items []SubvolumeInfo
}
type ListByVolumeOperationResponse ¶
type ListByVolumeOperationResponse struct { HttpResponse *http.Response Model *[]SubvolumeInfo // contains filtered or unexported fields }
func (ListByVolumeOperationResponse) HasMore ¶
func (r ListByVolumeOperationResponse) HasMore() bool
func (ListByVolumeOperationResponse) LoadMore ¶
func (r ListByVolumeOperationResponse) LoadMore(ctx context.Context) (resp ListByVolumeOperationResponse, err error)
type SubVolumeId ¶
type SubVolumeId struct { SubscriptionId string ResourceGroupName string NetAppAccountName string CapacityPoolName string VolumeName string SubVolumeName string }
SubVolumeId is a struct representing the Resource ID for a Sub Volume
func NewSubVolumeID ¶
func NewSubVolumeID(subscriptionId string, resourceGroupName string, netAppAccountName string, capacityPoolName string, volumeName string, subVolumeName string) SubVolumeId
NewSubVolumeID returns a new SubVolumeId struct
func ParseSubVolumeID ¶
func ParseSubVolumeID(input string) (*SubVolumeId, error)
ParseSubVolumeID parses 'input' into a SubVolumeId
func ParseSubVolumeIDInsensitively ¶
func ParseSubVolumeIDInsensitively(input string) (*SubVolumeId, error)
ParseSubVolumeIDInsensitively parses 'input' case-insensitively into a SubVolumeId note: this method should only be used for API response data and not user input
func (SubVolumeId) Segments ¶
func (id SubVolumeId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Sub Volume ID
func (SubVolumeId) String ¶
func (id SubVolumeId) String() string
String returns a human-readable description of this Sub Volume ID
type SubVolumesClient ¶
func NewSubVolumesClientWithBaseURI ¶
func NewSubVolumesClientWithBaseURI(endpoint string) SubVolumesClient
func (SubVolumesClient) Create ¶
func (c SubVolumesClient) Create(ctx context.Context, id SubVolumeId, input SubvolumeInfo) (result CreateOperationResponse, err error)
Create ...
func (SubVolumesClient) CreateThenPoll ¶
func (c SubVolumesClient) CreateThenPoll(ctx context.Context, id SubVolumeId, input SubvolumeInfo) error
CreateThenPoll performs Create then polls until it's completed
func (SubVolumesClient) Delete ¶
func (c SubVolumesClient) Delete(ctx context.Context, id SubVolumeId) (result DeleteOperationResponse, err error)
Delete ...
func (SubVolumesClient) DeleteThenPoll ¶
func (c SubVolumesClient) DeleteThenPoll(ctx context.Context, id SubVolumeId) error
DeleteThenPoll performs Delete then polls until it's completed
func (SubVolumesClient) Get ¶
func (c SubVolumesClient) Get(ctx context.Context, id SubVolumeId) (result GetOperationResponse, err error)
Get ...
func (SubVolumesClient) GetMetadata ¶
func (c SubVolumesClient) GetMetadata(ctx context.Context, id SubVolumeId) (result GetMetadataOperationResponse, err error)
GetMetadata ...
func (SubVolumesClient) GetMetadataThenPoll ¶
func (c SubVolumesClient) GetMetadataThenPoll(ctx context.Context, id SubVolumeId) error
GetMetadataThenPoll performs GetMetadata then polls until it's completed
func (SubVolumesClient) ListByVolume ¶
func (c SubVolumesClient) ListByVolume(ctx context.Context, id VolumeId) (resp ListByVolumeOperationResponse, err error)
ListByVolume ...
func (SubVolumesClient) ListByVolumeComplete ¶
func (c SubVolumesClient) ListByVolumeComplete(ctx context.Context, id VolumeId) (ListByVolumeCompleteResult, error)
ListByVolumeComplete retrieves all of the results into a single object
func (SubVolumesClient) ListByVolumeCompleteMatchingPredicate ¶
func (c SubVolumesClient) ListByVolumeCompleteMatchingPredicate(ctx context.Context, id VolumeId, predicate SubvolumeInfoOperationPredicate) (resp ListByVolumeCompleteResult, err error)
ListByVolumeCompleteMatchingPredicate retrieves all of the results and then applied the predicate
func (SubVolumesClient) Update ¶
func (c SubVolumesClient) Update(ctx context.Context, id SubVolumeId, input SubvolumePatchRequest) (result UpdateOperationResponse, err error)
Update ...
func (SubVolumesClient) UpdateThenPoll ¶
func (c SubVolumesClient) UpdateThenPoll(ctx context.Context, id SubVolumeId, input SubvolumePatchRequest) error
UpdateThenPoll performs Update then polls until it's completed
type SubvolumeInfo ¶
type SubvolumeInfo struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *SubvolumeProperties `json:"properties,omitempty"` SystemData *systemdata.SystemData `json:"systemData,omitempty"` Type *string `json:"type,omitempty"` }
type SubvolumeInfoOperationPredicate ¶
func (SubvolumeInfoOperationPredicate) Matches ¶
func (p SubvolumeInfoOperationPredicate) Matches(input SubvolumeInfo) bool
type SubvolumeModel ¶
type SubvolumeModel struct { Id *string `json:"id,omitempty"` Name *string `json:"name,omitempty"` Properties *SubvolumeModelProperties `json:"properties,omitempty"` Type *string `json:"type,omitempty"` }
type SubvolumeModelProperties ¶
type SubvolumeModelProperties struct { AccessedTimeStamp *string `json:"accessedTimeStamp,omitempty"` BytesUsed *int64 `json:"bytesUsed,omitempty"` ChangedTimeStamp *string `json:"changedTimeStamp,omitempty"` CreationTimeStamp *string `json:"creationTimeStamp,omitempty"` ModifiedTimeStamp *string `json:"modifiedTimeStamp,omitempty"` ParentPath *string `json:"parentPath,omitempty"` Path *string `json:"path,omitempty"` Permissions *string `json:"permissions,omitempty"` ProvisioningState *string `json:"provisioningState,omitempty"` Size *int64 `json:"size,omitempty"` }
func (*SubvolumeModelProperties) GetAccessedTimeStampAsTime ¶
func (o *SubvolumeModelProperties) GetAccessedTimeStampAsTime() (*time.Time, error)
func (*SubvolumeModelProperties) GetChangedTimeStampAsTime ¶
func (o *SubvolumeModelProperties) GetChangedTimeStampAsTime() (*time.Time, error)
func (*SubvolumeModelProperties) GetCreationTimeStampAsTime ¶
func (o *SubvolumeModelProperties) GetCreationTimeStampAsTime() (*time.Time, error)
func (*SubvolumeModelProperties) GetModifiedTimeStampAsTime ¶
func (o *SubvolumeModelProperties) GetModifiedTimeStampAsTime() (*time.Time, error)
func (*SubvolumeModelProperties) SetAccessedTimeStampAsTime ¶
func (o *SubvolumeModelProperties) SetAccessedTimeStampAsTime(input time.Time)
func (*SubvolumeModelProperties) SetChangedTimeStampAsTime ¶
func (o *SubvolumeModelProperties) SetChangedTimeStampAsTime(input time.Time)
func (*SubvolumeModelProperties) SetCreationTimeStampAsTime ¶
func (o *SubvolumeModelProperties) SetCreationTimeStampAsTime(input time.Time)
func (*SubvolumeModelProperties) SetModifiedTimeStampAsTime ¶
func (o *SubvolumeModelProperties) SetModifiedTimeStampAsTime(input time.Time)
type SubvolumePatchParams ¶
type SubvolumePatchRequest ¶
type SubvolumePatchRequest struct {
Properties *SubvolumePatchParams `json:"properties,omitempty"`
}
type SubvolumeProperties ¶
type UpdateOperationResponse ¶
type UpdateOperationResponse struct { Poller polling.LongRunningPoller HttpResponse *http.Response }
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 ¶
ParseVolumeID parses 'input' into a VolumeId
func ParseVolumeIDInsensitively ¶
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) Segments ¶
func (id VolumeId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Volume ID
Source Files ¶
- client.go
- id_subvolume.go
- id_volume.go
- method_create_autorest.go
- method_delete_autorest.go
- method_get_autorest.go
- method_getmetadata_autorest.go
- method_listbyvolume_autorest.go
- method_update_autorest.go
- model_subvolumeinfo.go
- model_subvolumemodel.go
- model_subvolumemodelproperties.go
- model_subvolumepatchparams.go
- model_subvolumepatchrequest.go
- model_subvolumeproperties.go
- predicates.go
- version.go