blobservice

package
v0.20230728.1130002 Latest Latest
Warning

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

Go to latest
Published: Jul 28, 2023 License: MPL-2.0 Imports: 9 Imported by: 0

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-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 := blobservice.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 := blobservice.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 := blobservice.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

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAllowedMethods

func PossibleValuesForAllowedMethods() []string

func PossibleValuesForName

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

type BlobServiceClient

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

func NewBlobServiceClientWithBaseURI

func NewBlobServiceClientWithBaseURI(endpoint string) BlobServiceClient

func (BlobServiceClient) GetServiceProperties

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

GetServiceProperties ...

func (BlobServiceClient) List

List ...

func (BlobServiceClient) SetServiceProperties

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
	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
	Model        *BlobServiceItems
}

type Name

type Name string
const (
	NameAccessTimeTracking Name = "AccessTimeTracking"
)

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)

func (*RestorePolicyProperties) SetLastEnabledTimeAsTime

func (o *RestorePolicyProperties) SetLastEnabledTimeAsTime(input time.Time)

func (*RestorePolicyProperties) SetMinRestoreTimeAsTime

func (o *RestorePolicyProperties) SetMinRestoreTimeAsTime(input time.Time)

type SetServicePropertiesOperationResponse

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

type SkuTier

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL