fileservice

README

github.com/hashicorp/go-azure-sdk/resource-manager/storage/2022-09-01/fileservice Documentation

The fileservice SDK allows for interaction with the Azure Resource Manager Service storage (API Version 2022-09-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/storage/2022-09-01/fileservice"

Client Initialization

client := fileservice.NewFileServiceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: FileServiceClient.GetServiceProperties

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

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

Example Usage: FileServiceClient.List

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

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

Example Usage: FileServiceClient.SetServiceProperties

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

payload := fileservice.FileServiceProperties{
	// ...
}


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

Documentation

Index

• func PossibleValuesForAllowedMethods() []string
• func PossibleValuesForSkuName() []string
• func PossibleValuesForSkuTier() []string
• func ValidateStorageAccountID(input interface{}, key string) (warnings []string, errors []error)
• type AllowedMethods
• type CorsRule
• type CorsRules
• type DeleteRetentionPolicy
• type FileServiceClient
  • func NewFileServiceClientWithBaseURI(endpoint string) FileServiceClient
  • func (c FileServiceClient) GetServiceProperties(ctx context.Context, id StorageAccountId) (result GetServicePropertiesOperationResponse, err error)
  • func (c FileServiceClient) List(ctx context.Context, id StorageAccountId) (result ListOperationResponse, err error)
  • func (c FileServiceClient) SetServiceProperties(ctx context.Context, id StorageAccountId, input FileServiceProperties) (result SetServicePropertiesOperationResponse, err error)
• type FileServiceItems
• type FileServiceProperties
• type FileServicePropertiesProperties
• type GetServicePropertiesOperationResponse
• type ListOperationResponse
• type Multichannel
• type ProtocolSettings
• type SetServicePropertiesOperationResponse
• type Sku
• type SkuName
• type SkuTier
• type SmbSetting
• type StorageAccountId
  • func NewStorageAccountID(subscriptionId string, resourceGroupName string, storageAccountName string) StorageAccountId
  • func ParseStorageAccountID(input string) (*StorageAccountId, error)
  • func ParseStorageAccountIDInsensitively(input string) (*StorageAccountId, error)
  • func (id StorageAccountId) ID() string
  • func (id StorageAccountId) Segments() []resourceids.Segment
  • func (id StorageAccountId) String() string

Functions

func PossibleValuesForAllowedMethods

func PossibleValuesForAllowedMethods() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

func ValidateStorageAccountID

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

ValidateStorageAccountID checks that 'input' can be parsed as a Storage Account ID

Types

type AllowedMethods

type AllowedMethods string

const (
	AllowedMethodsDELETE  AllowedMethods = "DELETE"
	AllowedMethodsGET     AllowedMethods = "GET"
	AllowedMethodsHEAD    AllowedMethods = "HEAD"
	AllowedMethodsMERGE   AllowedMethods = "MERGE"
	AllowedMethodsOPTIONS AllowedMethods = "OPTIONS"
	AllowedMethodsPATCH   AllowedMethods = "PATCH"
	AllowedMethodsPOST    AllowedMethods = "POST"
	AllowedMethodsPUT     AllowedMethods = "PUT"
)

type CorsRule

type CorsRule struct {
	AllowedHeaders  []string         `json:"allowedHeaders"`
	AllowedMethods  []AllowedMethods `json:"allowedMethods"`
	AllowedOrigins  []string         `json:"allowedOrigins"`
	ExposedHeaders  []string         `json:"exposedHeaders"`
	MaxAgeInSeconds int64            `json:"maxAgeInSeconds"`
}

type CorsRules

type CorsRules struct {
	CorsRules *[]CorsRule `json:"corsRules,omitempty"`
}

type DeleteRetentionPolicy

type DeleteRetentionPolicy struct {
	AllowPermanentDelete *bool  `json:"allowPermanentDelete,omitempty"`
	Days                 *int64 `json:"days,omitempty"`
	Enabled              *bool  `json:"enabled,omitempty"`
}

type FileServiceClient

type FileServiceClient struct {
	Client autorest.Client
	// contains filtered or unexported fields
}

func NewFileServiceClientWithBaseURI

func NewFileServiceClientWithBaseURI(endpoint string) FileServiceClient

func (FileServiceClient) GetServiceProperties

func (c FileServiceClient) GetServiceProperties(ctx context.Context, id StorageAccountId) (result GetServicePropertiesOperationResponse, err error)

GetServiceProperties ...

func (FileServiceClient) List

func (c FileServiceClient) List(ctx context.Context, id StorageAccountId) (result ListOperationResponse, err error)

List ...

func (FileServiceClient) SetServiceProperties

func (c FileServiceClient) SetServiceProperties(ctx context.Context, id StorageAccountId, input FileServiceProperties) (result SetServicePropertiesOperationResponse, err error)

SetServiceProperties ...

type FileServiceItems

type FileServiceItems struct {
	Value *[]FileServiceProperties `json:"value,omitempty"`
}

type FileServiceProperties

type FileServiceProperties struct {
	Id         *string                          `json:"id,omitempty"`
	Name       *string                          `json:"name,omitempty"`
	Properties *FileServicePropertiesProperties `json:"properties,omitempty"`
	Sku        *Sku                             `json:"sku,omitempty"`
	Type       *string                          `json:"type,omitempty"`
}

type FileServicePropertiesProperties

type FileServicePropertiesProperties struct {
	Cors                       *CorsRules             `json:"cors,omitempty"`
	ProtocolSettings           *ProtocolSettings      `json:"protocolSettings,omitempty"`
	ShareDeleteRetentionPolicy *DeleteRetentionPolicy `json:"shareDeleteRetentionPolicy,omitempty"`
}

type GetServicePropertiesOperationResponse

type GetServicePropertiesOperationResponse struct {
	HttpResponse *http.Response
	Model        *FileServiceProperties
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	Model        *FileServiceItems
}

type Multichannel

type Multichannel struct {
	Enabled *bool `json:"enabled,omitempty"`
}

type ProtocolSettings

type ProtocolSettings struct {
	Smb *SmbSetting `json:"smb,omitempty"`
}

type SetServicePropertiesOperationResponse

type SetServicePropertiesOperationResponse struct {
	HttpResponse *http.Response
	Model        *FileServiceProperties
}

type Sku

type Sku struct {
	Name SkuName  `json:"name"`
	Tier *SkuTier `json:"tier,omitempty"`
}

type SkuName

type SkuName string

const (
	SkuNamePremiumLRS     SkuName = "Premium_LRS"
	SkuNamePremiumZRS     SkuName = "Premium_ZRS"
	SkuNameStandardGRS    SkuName = "Standard_GRS"
	SkuNameStandardGZRS   SkuName = "Standard_GZRS"
	SkuNameStandardLRS    SkuName = "Standard_LRS"
	SkuNameStandardRAGRS  SkuName = "Standard_RAGRS"
	SkuNameStandardRAGZRS SkuName = "Standard_RAGZRS"
	SkuNameStandardZRS    SkuName = "Standard_ZRS"
)

type SkuTier

type SkuTier string

const (
	SkuTierPremium  SkuTier = "Premium"
	SkuTierStandard SkuTier = "Standard"
)

type SmbSetting

type SmbSetting struct {
	AuthenticationMethods    *string       `json:"authenticationMethods,omitempty"`
	ChannelEncryption        *string       `json:"channelEncryption,omitempty"`
	KerberosTicketEncryption *string       `json:"kerberosTicketEncryption,omitempty"`
	Multichannel             *Multichannel `json:"multichannel,omitempty"`
	Versions                 *string       `json:"versions,omitempty"`
}

type StorageAccountId

type StorageAccountId struct {
	SubscriptionId     string
	ResourceGroupName  string
	StorageAccountName string
}

StorageAccountId is a struct representing the Resource ID for a Storage Account

func NewStorageAccountID

func NewStorageAccountID(subscriptionId string, resourceGroupName string, storageAccountName string) StorageAccountId

NewStorageAccountID returns a new StorageAccountId struct

func ParseStorageAccountID

func ParseStorageAccountID(input string) (*StorageAccountId, error)

ParseStorageAccountID parses 'input' into a StorageAccountId

func ParseStorageAccountIDInsensitively

func ParseStorageAccountIDInsensitively(input string) (*StorageAccountId, error)

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

func (StorageAccountId) ID

func (id StorageAccountId) ID() string

ID returns the formatted Storage Account ID

func (StorageAccountId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Storage Account ID

func (StorageAccountId) String

func (id StorageAccountId) String() string

String returns a human-readable description of this Storage Account ID