storage

package
v4.0.0-beta+incompatible Latest Latest
Warning

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

Go to latest
Published: Sep 1, 2016 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package storage implements the Azure ARM Storage service API version 2016-01-01.

The Storage Management Client.

Index

Constants

View Source
const (
	// APIVersion is the version of the Storage
	APIVersion = "2016-01-01"

	// DefaultBaseURI is the default URI used for the service Storage
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccessTier

type AccessTier string

AccessTier enumerates the values for access tier.

const (
	// Cool specifies the cool state for access tier.
	Cool AccessTier = "Cool"
	// Hot specifies the hot state for access tier.
	Hot AccessTier = "Hot"
)

type Account

type Account struct {
	autorest.Response `json:"-"`
	ID                *string             `json:"id,omitempty"`
	Name              *string             `json:"name,omitempty"`
	Type              *string             `json:"type,omitempty"`
	Location          *string             `json:"location,omitempty"`
	Tags              *map[string]*string `json:"tags,omitempty"`
	Sku               *Sku                `json:"sku,omitempty"`
	Kind              Kind                `json:"kind,omitempty"`
	Properties        *AccountProperties  `json:"properties,omitempty"`
}

Account is the storage account.

type AccountCheckNameAvailabilityParameters

type AccountCheckNameAvailabilityParameters struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

AccountCheckNameAvailabilityParameters is

type AccountCreateParameters

type AccountCreateParameters struct {
	Sku        *Sku                               `json:"sku,omitempty"`
	Kind       Kind                               `json:"kind,omitempty"`
	Location   *string                            `json:"location,omitempty"`
	Tags       *map[string]*string                `json:"tags,omitempty"`
	Properties *AccountPropertiesCreateParameters `json:"properties,omitempty"`
}

AccountCreateParameters is the parameters to provide for the account.

type AccountKey

type AccountKey struct {
	KeyName     *string       `json:"keyName,omitempty"`
	Value       *string       `json:"value,omitempty"`
	Permissions KeyPermission `json:"permissions,omitempty"`
}

AccountKey is an access key for the storage account.

type AccountListKeysResult

type AccountListKeysResult struct {
	autorest.Response `json:"-"`
	Keys              *[]AccountKey `json:"keys,omitempty"`
}

AccountListKeysResult is the ListKeys operation response.

type AccountListResult

type AccountListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Account `json:"value,omitempty"`
}

AccountListResult is the list storage accounts operation response.

type AccountProperties

type AccountProperties struct {
	ProvisioningState   ProvisioningState `json:"provisioningState,omitempty"`
	PrimaryEndpoints    *Endpoints        `json:"primaryEndpoints,omitempty"`
	PrimaryLocation     *string           `json:"primaryLocation,omitempty"`
	StatusOfPrimary     AccountStatus     `json:"statusOfPrimary,omitempty"`
	LastGeoFailoverTime *date.Time        `json:"lastGeoFailoverTime,omitempty"`
	SecondaryLocation   *string           `json:"secondaryLocation,omitempty"`
	StatusOfSecondary   AccountStatus     `json:"statusOfSecondary,omitempty"`
	CreationTime        *date.Time        `json:"creationTime,omitempty"`
	CustomDomain        *CustomDomain     `json:"customDomain,omitempty"`
	SecondaryEndpoints  *Endpoints        `json:"secondaryEndpoints,omitempty"`
	Encryption          *Encryption       `json:"encryption,omitempty"`
	AccessTier          AccessTier        `json:"accessTier,omitempty"`
}

AccountProperties is

type AccountPropertiesCreateParameters

type AccountPropertiesCreateParameters struct {
	CustomDomain *CustomDomain `json:"customDomain,omitempty"`
	Encryption   *Encryption   `json:"encryption,omitempty"`
	AccessTier   AccessTier    `json:"accessTier,omitempty"`
}

AccountPropertiesCreateParameters is

type AccountPropertiesUpdateParameters

type AccountPropertiesUpdateParameters struct {
	CustomDomain *CustomDomain `json:"customDomain,omitempty"`
	Encryption   *Encryption   `json:"encryption,omitempty"`
	AccessTier   AccessTier    `json:"accessTier,omitempty"`
}

AccountPropertiesUpdateParameters is

type AccountRegenerateKeyParameters

type AccountRegenerateKeyParameters struct {
	KeyName *string `json:"keyName,omitempty"`
}

AccountRegenerateKeyParameters is

type AccountStatus

type AccountStatus string

AccountStatus enumerates the values for account status.

const (
	// Available specifies the available state for account status.
	Available AccountStatus = "Available"
	// Unavailable specifies the unavailable state for account status.
	Unavailable AccountStatus = "Unavailable"
)

type AccountUpdateParameters

type AccountUpdateParameters struct {
	Sku        *Sku                               `json:"sku,omitempty"`
	Tags       *map[string]*string                `json:"tags,omitempty"`
	Properties *AccountPropertiesUpdateParameters `json:"properties,omitempty"`
}

AccountUpdateParameters is the parameters to provide for the account.

type AccountsClient

type AccountsClient struct {
	ManagementClient
}

AccountsClient is the the Storage Management Client.

func NewAccountsClient

func NewAccountsClient(subscriptionID string) AccountsClient

NewAccountsClient creates an instance of the AccountsClient client.

func NewAccountsClientWithBaseURI

func NewAccountsClientWithBaseURI(baseURI string, subscriptionID string) AccountsClient

NewAccountsClientWithBaseURI creates an instance of the AccountsClient client.

func (AccountsClient) CheckNameAvailability

func (client AccountsClient) CheckNameAvailability(accountName AccountCheckNameAvailabilityParameters) (result CheckNameAvailabilityResult, err error)

CheckNameAvailability checks that account name is valid and is not in use.

accountName is the name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

func (AccountsClient) CheckNameAvailabilityPreparer

func (client AccountsClient) CheckNameAvailabilityPreparer(accountName AccountCheckNameAvailabilityParameters) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (AccountsClient) CheckNameAvailabilityResponder

func (client AccountsClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameAvailabilityResult, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (AccountsClient) CheckNameAvailabilitySender

func (client AccountsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) Create

func (client AccountsClient) Create(resourceGroupName string, accountName string, parameters AccountCreateParameters, cancel <-chan struct{}) (result autorest.Response, err error)

Create asynchronously creates a new storage account with the specified parameters. If an account is already created and subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and subsequent create or update request is issued with exact same set of properties, the request will succeed. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is the name of the resource group within the user's subscription. accountName is the name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. parameters is the parameters to provide for the created account.

func (AccountsClient) CreatePreparer

func (client AccountsClient) CreatePreparer(resourceGroupName string, accountName string, parameters AccountCreateParameters, cancel <-chan struct{}) (*http.Request, error)

CreatePreparer prepares the Create request.

func (AccountsClient) CreateResponder

func (client AccountsClient) CreateResponder(resp *http.Response) (result autorest.Response, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (AccountsClient) CreateSender

func (client AccountsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) Delete

func (client AccountsClient) Delete(resourceGroupName string, accountName string) (result autorest.Response, err error)

Delete deletes a storage account in Microsoft Azure.

resourceGroupName is the name of the resource group within the user's subscription. accountName is the name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

func (AccountsClient) DeletePreparer

func (client AccountsClient) DeletePreparer(resourceGroupName string, accountName string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (AccountsClient) DeleteResponder

func (client AccountsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (AccountsClient) DeleteSender

func (client AccountsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) GetProperties

func (client AccountsClient) GetProperties(resourceGroupName string, accountName string) (result Account, err error)

GetProperties returns the properties for the specified storage account including but not limited to name, account type, location, and account status. The ListKeys operation should be used to retrieve storage keys.

resourceGroupName is the name of the resource group within the user's subscription. accountName is the name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

func (AccountsClient) GetPropertiesPreparer

func (client AccountsClient) GetPropertiesPreparer(resourceGroupName string, accountName string) (*http.Request, error)

GetPropertiesPreparer prepares the GetProperties request.

func (AccountsClient) GetPropertiesResponder

func (client AccountsClient) GetPropertiesResponder(resp *http.Response) (result Account, err error)

GetPropertiesResponder handles the response to the GetProperties request. The method always closes the http.Response Body.

func (AccountsClient) GetPropertiesSender

func (client AccountsClient) GetPropertiesSender(req *http.Request) (*http.Response, error)

GetPropertiesSender sends the GetProperties request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) List

func (client AccountsClient) List() (result AccountListResult, err error)

List lists all the storage accounts available under the subscription. Note that storage keys are not returned; use the ListKeys operation for this.

func (AccountsClient) ListByResourceGroup

func (client AccountsClient) ListByResourceGroup(resourceGroupName string) (result AccountListResult, err error)

ListByResourceGroup lists all the storage accounts available under the given resource group. Note that storage keys are not returned; use the ListKeys operation for this.

resourceGroupName is the name of the resource group within the user's subscription.

func (AccountsClient) ListByResourceGroupPreparer

func (client AccountsClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AccountsClient) ListByResourceGroupResponder

func (client AccountsClient) ListByResourceGroupResponder(resp *http.Response) (result AccountListResult, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (AccountsClient) ListByResourceGroupSender

func (client AccountsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) ListKeys

func (client AccountsClient) ListKeys(resourceGroupName string, accountName string) (result AccountListKeysResult, err error)

ListKeys lists the access keys for the specified storage account.

resourceGroupName is the name of the resource group. accountName is the name of the storage account.

func (AccountsClient) ListKeysPreparer

func (client AccountsClient) ListKeysPreparer(resourceGroupName string, accountName string) (*http.Request, error)

ListKeysPreparer prepares the ListKeys request.

func (AccountsClient) ListKeysResponder

func (client AccountsClient) ListKeysResponder(resp *http.Response) (result AccountListKeysResult, err error)

ListKeysResponder handles the response to the ListKeys request. The method always closes the http.Response Body.

func (AccountsClient) ListKeysSender

func (client AccountsClient) ListKeysSender(req *http.Request) (*http.Response, error)

ListKeysSender sends the ListKeys request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) ListPreparer

func (client AccountsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (AccountsClient) ListResponder

func (client AccountsClient) ListResponder(resp *http.Response) (result AccountListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (AccountsClient) ListSender

func (client AccountsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) RegenerateKey

func (client AccountsClient) RegenerateKey(resourceGroupName string, accountName string, regenerateKey AccountRegenerateKeyParameters) (result AccountListKeysResult, err error)

RegenerateKey regenerates the access keys for the specified storage account.

resourceGroupName is the name of the resource group within the user's subscription. accountName is the name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. regenerateKey is specifies name of the key which should be regenerated. key1 or key2 for the default keys

func (AccountsClient) RegenerateKeyPreparer

func (client AccountsClient) RegenerateKeyPreparer(resourceGroupName string, accountName string, regenerateKey AccountRegenerateKeyParameters) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (AccountsClient) RegenerateKeyResponder

func (client AccountsClient) RegenerateKeyResponder(resp *http.Response) (result AccountListKeysResult, err error)

RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.

func (AccountsClient) RegenerateKeySender

func (client AccountsClient) RegenerateKeySender(req *http.Request) (*http.Response, error)

RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.

func (AccountsClient) Update

func (client AccountsClient) Update(resourceGroupName string, accountName string, parameters AccountUpdateParameters) (result Account, err error)

Update the update operation can be used to update the account type, encryption, or tags for a storage account. It can also be used to map the account to a custom domain. Only one custom domain is supported per storage account and. replacement/change of custom domain is not supported. In order to replace an old custom domain, the old value must be cleared/unregistered before a new value may be set. Update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation.

resourceGroupName is the name of the resource group within the user's subscription. accountName is the name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. parameters is the parameters to provide for the updated account.

func (AccountsClient) UpdatePreparer

func (client AccountsClient) UpdatePreparer(resourceGroupName string, accountName string, parameters AccountUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (AccountsClient) UpdateResponder

func (client AccountsClient) UpdateResponder(resp *http.Response) (result Account, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (AccountsClient) UpdateSender

func (client AccountsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type CheckNameAvailabilityResult

type CheckNameAvailabilityResult struct {
	autorest.Response `json:"-"`
	NameAvailable     *bool   `json:"nameAvailable,omitempty"`
	Reason            Reason  `json:"reason,omitempty"`
	Message           *string `json:"message,omitempty"`
}

CheckNameAvailabilityResult is the CheckNameAvailability operation response.

type CustomDomain

type CustomDomain struct {
	Name         *string `json:"name,omitempty"`
	UseSubDomain *bool   `json:"useSubDomain,omitempty"`
}

CustomDomain is the custom domain assigned to this storage account. This can be set via Update.

type Encryption

type Encryption struct {
	Services  *EncryptionServices `json:"services,omitempty"`
	KeySource *string             `json:"keySource,omitempty"`
}

Encryption is the encryption settings on the account.

type EncryptionService

type EncryptionService struct {
	Enabled         *bool      `json:"enabled,omitempty"`
	LastEnabledTime *date.Time `json:"lastEnabledTime,omitempty"`
}

EncryptionService is an encrypted service.

type EncryptionServices

type EncryptionServices struct {
	Blob *EncryptionService `json:"blob,omitempty"`
}

EncryptionServices is the encrypted services.

type Endpoints

type Endpoints struct {
	Blob  *string `json:"blob,omitempty"`
	Queue *string `json:"queue,omitempty"`
	Table *string `json:"table,omitempty"`
	File  *string `json:"file,omitempty"`
}

Endpoints is the URIs that are used to perform a retrieval of a public blob, queue or table object.

type KeyPermission

type KeyPermission string

KeyPermission enumerates the values for key permission.

const (
	// FULL specifies the full state for key permission.
	FULL KeyPermission = "FULL"
	// READ specifies the read state for key permission.
	READ KeyPermission = "READ"
)

type Kind

type Kind string

Kind enumerates the values for kind.

const (
	// BlobStorage specifies the blob storage state for kind.
	BlobStorage Kind = "BlobStorage"
	// Storage specifies the storage state for kind.
	Storage Kind = "Storage"
)

type ManagementClient

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	APIVersion     string
	SubscriptionID string
}

ManagementClient is the base client for Storage.

func New

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

type ProvisioningState

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
	// Creating specifies the creating state for provisioning state.
	Creating ProvisioningState = "Creating"
	// ResolvingDNS specifies the resolving dns state for provisioning state.
	ResolvingDNS ProvisioningState = "ResolvingDNS"
	// Succeeded specifies the succeeded state for provisioning state.
	Succeeded ProvisioningState = "Succeeded"
)

type Reason

type Reason string

Reason enumerates the values for reason.

const (
	// AccountNameInvalid specifies the account name invalid state for reason.
	AccountNameInvalid Reason = "AccountNameInvalid"
	// AlreadyExists specifies the already exists state for reason.
	AlreadyExists Reason = "AlreadyExists"
)

type Resource

type Resource struct {
	ID       *string             `json:"id,omitempty"`
	Name     *string             `json:"name,omitempty"`
	Type     *string             `json:"type,omitempty"`
	Location *string             `json:"location,omitempty"`
	Tags     *map[string]*string `json:"tags,omitempty"`
}

Resource is

type Sku

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

Sku is the SKU of the storage account.

type SkuName

type SkuName string

SkuName enumerates the values for sku name.

const (
	// PremiumLRS specifies the premium lrs state for sku name.
	PremiumLRS SkuName = "Premium_LRS"
	// StandardGRS specifies the standard grs state for sku name.
	StandardGRS SkuName = "Standard_GRS"
	// StandardLRS specifies the standard lrs state for sku name.
	StandardLRS SkuName = "Standard_LRS"
	// StandardRAGRS specifies the standard ragrs state for sku name.
	StandardRAGRS SkuName = "Standard_RAGRS"
	// StandardZRS specifies the standard zrs state for sku name.
	StandardZRS SkuName = "Standard_ZRS"
)

type SkuTier

type SkuTier string

SkuTier enumerates the values for sku tier.

const (
	// Premium specifies the premium state for sku tier.
	Premium SkuTier = "Premium"
	// Standard specifies the standard state for sku tier.
	Standard SkuTier = "Standard"
)

type Usage

type Usage struct {
	Unit         UsageUnit  `json:"unit,omitempty"`
	CurrentValue *int32     `json:"currentValue,omitempty"`
	Limit        *int32     `json:"limit,omitempty"`
	Name         *UsageName `json:"name,omitempty"`
}

Usage is describes Storage Resource Usage.

type UsageListResult

type UsageListResult struct {
	autorest.Response `json:"-"`
	Value             *[]Usage `json:"value,omitempty"`
}

UsageListResult is the List Usages operation response.

type UsageName

type UsageName struct {
	Value          *string `json:"value,omitempty"`
	LocalizedValue *string `json:"localizedValue,omitempty"`
}

UsageName is the Usage Names.

type UsageOperationsClient

type UsageOperationsClient struct {
	ManagementClient
}

UsageOperationsClient is the the Storage Management Client.

func NewUsageOperationsClient

func NewUsageOperationsClient(subscriptionID string) UsageOperationsClient

NewUsageOperationsClient creates an instance of the UsageOperationsClient client.

func NewUsageOperationsClientWithBaseURI

func NewUsageOperationsClientWithBaseURI(baseURI string, subscriptionID string) UsageOperationsClient

NewUsageOperationsClientWithBaseURI creates an instance of the UsageOperationsClient client.

func (UsageOperationsClient) List

func (client UsageOperationsClient) List() (result UsageListResult, err error)

List gets the current usage count and the limit for the resources under the subscription.

func (UsageOperationsClient) ListPreparer

func (client UsageOperationsClient) ListPreparer() (*http.Request, error)

ListPreparer prepares the List request.

func (UsageOperationsClient) ListResponder

func (client UsageOperationsClient) ListResponder(resp *http.Response) (result UsageListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UsageOperationsClient) ListSender

func (client UsageOperationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type UsageUnit

type UsageUnit string

UsageUnit enumerates the values for usage unit.

const (
	// Bytes specifies the bytes state for usage unit.
	Bytes UsageUnit = "Bytes"
	// BytesPerSecond specifies the bytes per second state for usage unit.
	BytesPerSecond UsageUnit = "BytesPerSecond"
	// Count specifies the count state for usage unit.
	Count UsageUnit = "Count"
	// CountsPerSecond specifies the counts per second state for usage unit.
	CountsPerSecond UsageUnit = "CountsPerSecond"
	// Percent specifies the percent state for usage unit.
	Percent UsageUnit = "Percent"
	// Seconds specifies the seconds state for usage unit.
	Seconds UsageUnit = "Seconds"
)

Jump to

Keyboard shortcuts

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