filesystems

package
v0.20240321.1145953 Latest Latest
Warning

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

 Go to latest Published: Mar 21, 2024 License: MPL-2.0 Imports: 14 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/qumulostorage/2022-10-12/filesystems Documentation

The filesystems SDK allows for interaction with the Azure Resource Manager Service qumulostorage (API Version 2022-10-12).

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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/qumulostorage/2022-10-12/filesystems"

Client Initialization

client := filesystems.NewFileSystemsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FileSystemsClient.CreateOrUpdate

ctx := context.TODO()
id := filesystems.NewFileSystemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "fileSystemValue")

payload := filesystems.FileSystemResource{
	// ...
}


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

Example Usage: FileSystemsClient.Delete

ctx := context.TODO()
id := filesystems.NewFileSystemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "fileSystemValue")

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

Example Usage: FileSystemsClient.Get

ctx := context.TODO()
id := filesystems.NewFileSystemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "fileSystemValue")

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: FileSystemsClient.ListByResourceGroup

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

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

Example Usage: FileSystemsClient.ListBySubscription

ctx := context.TODO()
id := commonids.NewSubscriptionID("12345678-1234-9876-4563-123456789012")

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

Example Usage: FileSystemsClient.Update

ctx := context.TODO()
id := filesystems.NewFileSystemID("12345678-1234-9876-4563-123456789012", "example-resource-group", "fileSystemValue")

payload := filesystems.FileSystemResourceUpdate{
	// ...
}


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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForMarketplaceSubscriptionStatus 

func PossibleValuesForMarketplaceSubscriptionStatus() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForStorageSku 

func PossibleValuesForStorageSku() []string

func ValidateFileSystemID 

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

ValidateFileSystemID checks that 'input' can be parsed as a File System ID

Types

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FileSystemResource
}

type DeleteOperationResponse 

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

type FileSystemId 

type FileSystemId struct {
	SubscriptionId    string
	ResourceGroupName string
	FileSystemName    string
}

FileSystemId is a struct representing the Resource ID for a File System

func NewFileSystemID 

func NewFileSystemID(subscriptionId string, resourceGroupName string, fileSystemName string) FileSystemId

NewFileSystemID returns a new FileSystemId struct

func ParseFileSystemID 

func ParseFileSystemID(input string) (*FileSystemId, error)

ParseFileSystemID parses 'input' into a FileSystemId

func ParseFileSystemIDInsensitively 

func ParseFileSystemIDInsensitively(input string) (*FileSystemId, error)

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

func (*FileSystemId) FromParseResult 

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

func (FileSystemId) ID 

func (id FileSystemId) ID() string

ID returns the formatted File System ID

func (FileSystemId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this File System ID

func (FileSystemId) String 

func (id FileSystemId) String() string

String returns a human-readable description of this File System ID

type FileSystemResource 

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

type FileSystemResourceOperationPredicate 

type FileSystemResourceOperationPredicate struct {
	Id       *string
	Location *string
	Name     *string
	Type     *string
}

func (FileSystemResourceOperationPredicate) Matches 

func (p FileSystemResourceOperationPredicate) Matches(input FileSystemResource) bool

type FileSystemResourceProperties 

type FileSystemResourceProperties struct {
	AdminPassword      string             `json:"adminPassword"`
	AvailabilityZone   *string            `json:"availabilityZone,omitempty"`
	ClusterLoginUrl    *string            `json:"clusterLoginUrl,omitempty"`
	DelegatedSubnetId  string             `json:"delegatedSubnetId"`
	InitialCapacity    int64              `json:"initialCapacity"`
	MarketplaceDetails MarketplaceDetails `json:"marketplaceDetails"`
	PrivateIPs         *[]string          `json:"privateIPs,omitempty"`
	ProvisioningState  *ProvisioningState `json:"provisioningState,omitempty"`
	StorageSku         StorageSku         `json:"storageSku"`
	UserDetails        UserDetails        `json:"userDetails"`
}

type FileSystemResourceUpdate 

type FileSystemResourceUpdate struct {
	Identity   *identity.SystemAndUserAssignedMap  `json:"identity,omitempty"`
	Properties *FileSystemResourceUpdateProperties `json:"properties,omitempty"`
	Tags       *map[string]string                  `json:"tags,omitempty"`
}

type FileSystemResourceUpdateProperties 

type FileSystemResourceUpdateProperties struct {
	ClusterLoginUrl    *string             `json:"clusterLoginUrl,omitempty"`
	DelegatedSubnetId  *string             `json:"delegatedSubnetId,omitempty"`
	MarketplaceDetails *MarketplaceDetails `json:"marketplaceDetails,omitempty"`
	PrivateIPs         *[]string           `json:"privateIPs,omitempty"`
	UserDetails        *UserDetails        `json:"userDetails,omitempty"`
}

type FileSystemsClient 

type FileSystemsClient struct {
	Client *resourcemanager.Client
}

func NewFileSystemsClientWithBaseURI 

func NewFileSystemsClientWithBaseURI(sdkApi sdkEnv.Api) (*FileSystemsClient, error)

func (FileSystemsClient) CreateOrUpdate 

func (c FileSystemsClient) CreateOrUpdate(ctx context.Context, id FileSystemId, input FileSystemResource) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (FileSystemsClient) CreateOrUpdateThenPoll 

func (c FileSystemsClient) CreateOrUpdateThenPoll(ctx context.Context, id FileSystemId, input FileSystemResource) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (FileSystemsClient) Delete 

func (c FileSystemsClient) Delete(ctx context.Context, id FileSystemId) (result DeleteOperationResponse, err error)

Delete ...

func (FileSystemsClient) DeleteThenPoll 

func (c FileSystemsClient) DeleteThenPoll(ctx context.Context, id FileSystemId) error

DeleteThenPoll performs Delete then polls until it's completed

func (FileSystemsClient) Get 

func (c FileSystemsClient) Get(ctx context.Context, id FileSystemId) (result GetOperationResponse, err error)

Get ...

func (FileSystemsClient) ListByResourceGroup 

func (c FileSystemsClient) ListByResourceGroup(ctx context.Context, id commonids.ResourceGroupId) (result ListByResourceGroupOperationResponse, err error)

ListByResourceGroup ...

func (FileSystemsClient) ListByResourceGroupComplete 

func (c FileSystemsClient) ListByResourceGroupComplete(ctx context.Context, id commonids.ResourceGroupId) (ListByResourceGroupCompleteResult, error)

ListByResourceGroupComplete retrieves all the results into a single object

func (FileSystemsClient) ListByResourceGroupCompleteMatchingPredicate 

func (c FileSystemsClient) ListByResourceGroupCompleteMatchingPredicate(ctx context.Context, id commonids.ResourceGroupId, predicate FileSystemResourceOperationPredicate) (result ListByResourceGroupCompleteResult, err error)

ListByResourceGroupCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FileSystemsClient) ListBySubscription 

func (c FileSystemsClient) ListBySubscription(ctx context.Context, id commonids.SubscriptionId) (result ListBySubscriptionOperationResponse, err error)

ListBySubscription ...

func (FileSystemsClient) ListBySubscriptionComplete 

func (c FileSystemsClient) ListBySubscriptionComplete(ctx context.Context, id commonids.SubscriptionId) (ListBySubscriptionCompleteResult, error)

ListBySubscriptionComplete retrieves all the results into a single object

func (FileSystemsClient) ListBySubscriptionCompleteMatchingPredicate 

func (c FileSystemsClient) ListBySubscriptionCompleteMatchingPredicate(ctx context.Context, id commonids.SubscriptionId, predicate FileSystemResourceOperationPredicate) (result ListBySubscriptionCompleteResult, err error)

ListBySubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (FileSystemsClient) Update 

func (c FileSystemsClient) Update(ctx context.Context, id FileSystemId, input FileSystemResourceUpdate) (result UpdateOperationResponse, err error)

Update ...

type GetOperationResponse 

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

type ListByResourceGroupCompleteResult 

type ListByResourceGroupCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []FileSystemResource
}

type ListByResourceGroupOperationResponse 

type ListByResourceGroupOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]FileSystemResource
}

type ListBySubscriptionCompleteResult 

type ListBySubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []FileSystemResource
}

type ListBySubscriptionOperationResponse 

type ListBySubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]FileSystemResource
}

type MarketplaceDetails 

type MarketplaceDetails struct {
	MarketplaceSubscriptionId     *string                        `json:"marketplaceSubscriptionId,omitempty"`
	MarketplaceSubscriptionStatus *MarketplaceSubscriptionStatus `json:"marketplaceSubscriptionStatus,omitempty"`
	OfferId                       string                         `json:"offerId"`
	PlanId                        string                         `json:"planId"`
	PublisherId                   string                         `json:"publisherId"`
}

type MarketplaceSubscriptionStatus 

type MarketplaceSubscriptionStatus string
const (
	MarketplaceSubscriptionStatusPendingFulfillmentStart MarketplaceSubscriptionStatus = "PendingFulfillmentStart"
	MarketplaceSubscriptionStatusSubscribed              MarketplaceSubscriptionStatus = "Subscribed"
	MarketplaceSubscriptionStatusSuspended               MarketplaceSubscriptionStatus = "Suspended"
	MarketplaceSubscriptionStatusUnsubscribed            MarketplaceSubscriptionStatus = "Unsubscribed"
)

func (*MarketplaceSubscriptionStatus) UnmarshalJSON 

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

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateAccepted     ProvisioningState = "Accepted"
	ProvisioningStateCanceled     ProvisioningState = "Canceled"
	ProvisioningStateCreating     ProvisioningState = "Creating"
	ProvisioningStateDeleted      ProvisioningState = "Deleted"
	ProvisioningStateDeleting     ProvisioningState = "Deleting"
	ProvisioningStateFailed       ProvisioningState = "Failed"
	ProvisioningStateNotSpecified ProvisioningState = "NotSpecified"
	ProvisioningStateSucceeded    ProvisioningState = "Succeeded"
	ProvisioningStateUpdating     ProvisioningState = "Updating"
)

func (*ProvisioningState) UnmarshalJSON 

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

type StorageSku 

type StorageSku string
const (
	StorageSkuPerformance StorageSku = "Performance"
	StorageSkuStandard    StorageSku = "Standard"
)

func (*StorageSku) UnmarshalJSON 

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

type UpdateOperationResponse 

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *FileSystemResource
}

type UserDetails 

type UserDetails struct {
	Email string `json:"email"`
}

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.