blobservice

README

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

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

Client Initialization

client := blobservice.NewBlobServiceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: BlobServiceClient.GetServiceProperties

ctx := context.TODO()
id := commonids.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: BlobServiceClient.List

ctx := context.TODO()
id := commonids.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: BlobServiceClient.SetServiceProperties

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

payload := blobservice.BlobServiceProperties{
	// ...
}


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 PossibleValuesForName() []string
• func PossibleValuesForSkuName() []string
• func PossibleValuesForSkuTier() []string
• type AllowedMethods
  • func (s *AllowedMethods) UnmarshalJSON(bytes []byte) error
• type BlobServiceClient
  • func NewBlobServiceClientWithBaseURI(sdkApi sdkEnv.Api) (*BlobServiceClient, error)
  • func (c BlobServiceClient) GetServiceProperties(ctx context.Context, id commonids.StorageAccountId) (result GetServicePropertiesOperationResponse, err error)
  • func (c BlobServiceClient) List(ctx context.Context, id commonids.StorageAccountId) (result ListOperationResponse, err error)
  • func (c BlobServiceClient) SetServiceProperties(ctx context.Context, id commonids.StorageAccountId, ...) (result SetServicePropertiesOperationResponse, err error)
• type BlobServiceItems
• type BlobServiceProperties
• type BlobServicePropertiesProperties
• type ChangeFeed
• type CorsRule
• type CorsRules
• type DeleteRetentionPolicy
• type GetServicePropertiesOperationResponse
• type LastAccessTimeTrackingPolicy
• type ListOperationResponse
• type Name
  • func (s *Name) UnmarshalJSON(bytes []byte) error
• type RestorePolicyProperties
  • func (o *RestorePolicyProperties) GetLastEnabledTimeAsTime() (*time.Time, error)
  • func (o *RestorePolicyProperties) GetMinRestoreTimeAsTime() (*time.Time, error)
• type SetServicePropertiesOperationResponse
• type Sku
• type SkuName
  • func (s *SkuName) UnmarshalJSON(bytes []byte) error
• type SkuTier
  • func (s *SkuTier) UnmarshalJSON(bytes []byte) error

Functions

func PossibleValuesForAllowedMethods

func PossibleValuesForAllowedMethods() []string

func PossibleValuesForName

func PossibleValuesForName() []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 BlobServiceClient

type BlobServiceClient struct {
	Client *resourcemanager.Client
}

func NewBlobServiceClientWithBaseURI

func NewBlobServiceClientWithBaseURI(sdkApi sdkEnv.Api) (*BlobServiceClient, error)

func (BlobServiceClient) GetServiceProperties

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

GetServiceProperties ...

func (BlobServiceClient) List

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

List ...

func (BlobServiceClient) SetServiceProperties

func (c BlobServiceClient) SetServiceProperties(ctx context.Context, id commonids.StorageAccountId, input BlobServiceProperties) (result SetServicePropertiesOperationResponse, err error)

SetServiceProperties ...

type BlobServiceItems

type BlobServiceItems struct {
	Value *[]BlobServiceProperties `json:"value,omitempty"`
}

type BlobServiceProperties

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

type BlobServicePropertiesProperties

type BlobServicePropertiesProperties struct {
	AutomaticSnapshotPolicyEnabled *bool                         `json:"automaticSnapshotPolicyEnabled,omitempty"`
	ChangeFeed                     *ChangeFeed                   `json:"changeFeed,omitempty"`
	ContainerDeleteRetentionPolicy *DeleteRetentionPolicy        `json:"containerDeleteRetentionPolicy,omitempty"`
	Cors                           *CorsRules                    `json:"cors,omitempty"`
	DefaultServiceVersion          *string                       `json:"defaultServiceVersion,omitempty"`
	DeleteRetentionPolicy          *DeleteRetentionPolicy        `json:"deleteRetentionPolicy,omitempty"`
	IsVersioningEnabled            *bool                         `json:"isVersioningEnabled,omitempty"`
	LastAccessTimeTrackingPolicy   *LastAccessTimeTrackingPolicy `json:"lastAccessTimeTrackingPolicy,omitempty"`
	RestorePolicy                  *RestorePolicyProperties      `json:"restorePolicy,omitempty"`
}

type ChangeFeed

type ChangeFeed struct {
	Enabled         *bool  `json:"enabled,omitempty"`
	RetentionInDays *int64 `json:"retentionInDays,omitempty"`
}

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 GetServicePropertiesOperationResponse

type GetServicePropertiesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BlobServiceProperties
}

type LastAccessTimeTrackingPolicy

type LastAccessTimeTrackingPolicy struct {
	BlobType                  *[]string `json:"blobType,omitempty"`
	Enable                    bool      `json:"enable"`
	Name                      *Name     `json:"name,omitempty"`
	TrackingGranularityInDays *int64    `json:"trackingGranularityInDays,omitempty"`
}

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BlobServiceItems
}

type Name

type Name string

const (
	NameAccessTimeTracking Name = "AccessTimeTracking"
)

func (*Name) UnmarshalJSON

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

type RestorePolicyProperties

type RestorePolicyProperties struct {
	Days            *int64  `json:"days,omitempty"`
	Enabled         bool    `json:"enabled"`
	LastEnabledTime *string `json:"lastEnabledTime,omitempty"`
	MinRestoreTime  *string `json:"minRestoreTime,omitempty"`
}

func (*RestorePolicyProperties) GetLastEnabledTimeAsTime

func (o *RestorePolicyProperties) GetLastEnabledTimeAsTime() (*time.Time, error)

func (*RestorePolicyProperties) GetMinRestoreTimeAsTime

func (o *RestorePolicyProperties) GetMinRestoreTimeAsTime() (*time.Time, error)

type SetServicePropertiesOperationResponse

type SetServicePropertiesOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *BlobServiceProperties
}

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