fileservice

README

github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/fileservice Documentation

The fileservice SDK allows for interaction with Azure Resource Manager storage (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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/storage/2023-05-01/fileservice"

Client Initialization

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

Example Usage: FileServiceClient.GetServiceProperties

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

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 := commonids.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountName")

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 := commonids.NewStorageAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "storageAccountName")

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
• type AllowedMethods
  • func (s *AllowedMethods) UnmarshalJSON(bytes []byte) error
• type CorsRule
• type CorsRules
• type DeleteRetentionPolicy
• type FileServiceClient
  • func NewFileServiceClientWithBaseURI(sdkApi sdkEnv.Api) (*FileServiceClient, error)
  • func (c FileServiceClient) GetServiceProperties(ctx context.Context, id commonids.StorageAccountId) (result GetServicePropertiesOperationResponse, err error)
  • func (c FileServiceClient) List(ctx context.Context, id commonids.StorageAccountId) (result ListOperationResponse, err error)
  • func (c FileServiceClient) SetServiceProperties(ctx context.Context, id commonids.StorageAccountId, ...) (result SetServicePropertiesOperationResponse, err error)
• type FileServiceItems
• type FileServiceProperties
• type FileServicePropertiesProperties
• type GetServicePropertiesOperationResponse
• type ListOperationResponse
• type Multichannel
• type ProtocolSettings
• type SetServicePropertiesOperationResponse
• type Sku
• type SkuName
  • func (s *SkuName) UnmarshalJSON(bytes []byte) error
• type SkuTier
  • func (s *SkuTier) UnmarshalJSON(bytes []byte) error
• type SmbSetting

Functions

func PossibleValuesForAllowedMethods

func PossibleValuesForAllowedMethods() []string

func PossibleValuesForSkuName

func PossibleValuesForSkuName() []string

func PossibleValuesForSkuTier

func PossibleValuesForSkuTier() []string

Types

type AllowedMethods

type AllowedMethods string

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

func (*AllowedMethods) UnmarshalJSON

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

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 *resourcemanager.Client
}

func NewFileServiceClientWithBaseURI

func NewFileServiceClientWithBaseURI(sdkApi sdkEnv.Api) (*FileServiceClient, error)

func (FileServiceClient) GetServiceProperties

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

GetServiceProperties ...

func (FileServiceClient) List

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

List ...

func (FileServiceClient) SetServiceProperties

func (c FileServiceClient) SetServiceProperties(ctx context.Context, id commonids.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
	OData        *odata.OData
	Model        *FileServiceProperties
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	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
	OData        *odata.OData
	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"
)

func (*SkuName) UnmarshalJSON

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

type SkuTier

type SkuTier string

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

func (*SkuTier) UnmarshalJSON

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

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