azure-sdk-for-go: github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2015-06-15/storage Index | Files | Directories

package storage

import "github.com/Azure/azure-sdk-for-go/services/storage/mgmt/2015-06-15/storage"

Package storage implements the Azure ARM Storage service API version 2015-06-15.

The Azure Storage Management API.

Index

Package Files

accounts.go client.go models.go usage.go version.go

Constants

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

func UserAgent Uses

func UserAgent() string

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

func Version Uses

func Version() string

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

type Account Uses

type Account struct {
    autorest.Response  `json:"-"`
    *AccountProperties `json:"properties,omitempty"`
    // ID - READ-ONLY; Resource Id
    ID  *string `json:"id,omitempty"`
    // Name - READ-ONLY; Resource name
    Name *string `json:"name,omitempty"`
    // Type - READ-ONLY; Resource type
    Type *string `json:"type,omitempty"`
    // Location - Resource location
    Location *string `json:"location,omitempty"`
    // Tags - Resource tags
    Tags map[string]*string `json:"tags"`
}

Account the storage account.

func (Account) MarshalJSON Uses

func (a Account) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Account.

func (*Account) UnmarshalJSON Uses

func (a *Account) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Account struct.

type AccountCheckNameAvailabilityParameters Uses

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

AccountCheckNameAvailabilityParameters the parameters used to check the availability of the storage account name.

type AccountCreateParameters Uses

type AccountCreateParameters struct {
    // Location - The location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
    Location *string `json:"location,omitempty"`
    // Tags - A list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.
    Tags                               map[string]*string `json:"tags"`
    *AccountPropertiesCreateParameters `json:"properties,omitempty"`
}

AccountCreateParameters the parameters to provide for the account.

func (AccountCreateParameters) MarshalJSON Uses

func (acp AccountCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountCreateParameters.

func (*AccountCreateParameters) UnmarshalJSON Uses

func (acp *AccountCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AccountCreateParameters struct.

type AccountKeys Uses

type AccountKeys struct {
    autorest.Response `json:"-"`
    // Key1 - The value of key 1.
    Key1 *string `json:"key1,omitempty"`
    // Key2 - The value of key 2.
    Key2 *string `json:"key2,omitempty"`
}

AccountKeys the access keys for the storage account.

type AccountListResult Uses

type AccountListResult struct {
    autorest.Response `json:"-"`
    // Value - The list of storage accounts and their properties.
    Value *[]Account `json:"value,omitempty"`
}

AccountListResult the list storage accounts operation response.

type AccountProperties Uses

type AccountProperties struct {
    // ProvisioningState - The status of the storage account at the time the operation was called. Possible values include: 'Creating', 'ResolvingDNS', 'Succeeded'
    ProvisioningState ProvisioningState `json:"provisioningState,omitempty"`
    // AccountType - The type of the storage account. Possible values include: 'StandardLRS', 'StandardZRS', 'StandardGRS', 'StandardRAGRS', 'PremiumLRS'
    AccountType AccountType `json:"accountType,omitempty"`
    // PrimaryEndpoints - The URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.
    PrimaryEndpoints *Endpoints `json:"primaryEndpoints,omitempty"`
    // PrimaryLocation - The location of the primary data center for the storage account.
    PrimaryLocation *string `json:"primaryLocation,omitempty"`
    // StatusOfPrimary - The status indicating whether the primary location of the storage account is available or unavailable. Possible values include: 'Available', 'Unavailable'
    StatusOfPrimary AccountStatus `json:"statusOfPrimary,omitempty"`
    // LastGeoFailoverTime - The timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS.
    LastGeoFailoverTime *date.Time `json:"lastGeoFailoverTime,omitempty"`
    // SecondaryLocation - The location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.
    SecondaryLocation *string `json:"secondaryLocation,omitempty"`
    // StatusOfSecondary - The status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS. Possible values include: 'Available', 'Unavailable'
    StatusOfSecondary AccountStatus `json:"statusOfSecondary,omitempty"`
    // CreationTime - The creation date and time of the storage account in UTC.
    CreationTime *date.Time `json:"creationTime,omitempty"`
    // CustomDomain - The custom domain the user assigned to this storage account.
    CustomDomain *CustomDomain `json:"customDomain,omitempty"`
    // SecondaryEndpoints - The URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS.
    SecondaryEndpoints *Endpoints `json:"secondaryEndpoints,omitempty"`
}

AccountProperties properties of the storage account.

type AccountPropertiesCreateParameters Uses

type AccountPropertiesCreateParameters struct {
    // AccountType - The sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType. Possible values include: 'StandardLRS', 'StandardZRS', 'StandardGRS', 'StandardRAGRS', 'PremiumLRS'
    AccountType AccountType `json:"accountType,omitempty"`
}

AccountPropertiesCreateParameters the parameters used to create the storage account.

type AccountPropertiesUpdateParameters Uses

type AccountPropertiesUpdateParameters struct {
    // AccountType - The account type. Note that StandardZRS and PremiumLRS accounts cannot be changed to other account types, and other account types cannot be changed to StandardZRS or PremiumLRS. Possible values include: 'StandardLRS', 'StandardZRS', 'StandardGRS', 'StandardRAGRS', 'PremiumLRS'
    AccountType AccountType `json:"accountType,omitempty"`
    // CustomDomain - User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property.
    CustomDomain *CustomDomain `json:"customDomain,omitempty"`
}

AccountPropertiesUpdateParameters the parameters used when updating a storage account.

type AccountRegenerateKeyParameters Uses

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

AccountRegenerateKeyParameters the parameters used to regenerate the storage account key.

type AccountStatus Uses

type AccountStatus string

AccountStatus enumerates the values for account status.

const (
    // Available ...
    Available AccountStatus = "Available"
    // Unavailable ...
    Unavailable AccountStatus = "Unavailable"
)

func PossibleAccountStatusValues Uses

func PossibleAccountStatusValues() []AccountStatus

PossibleAccountStatusValues returns an array of possible values for the AccountStatus const type.

type AccountType Uses

type AccountType string

AccountType enumerates the values for account type.

const (
    // PremiumLRS ...
    PremiumLRS AccountType = "Premium_LRS"
    // StandardGRS ...
    StandardGRS AccountType = "Standard_GRS"
    // StandardLRS ...
    StandardLRS AccountType = "Standard_LRS"
    // StandardRAGRS ...
    StandardRAGRS AccountType = "Standard_RAGRS"
    // StandardZRS ...
    StandardZRS AccountType = "Standard_ZRS"
)

func PossibleAccountTypeValues Uses

func PossibleAccountTypeValues() []AccountType

PossibleAccountTypeValues returns an array of possible values for the AccountType const type.

type AccountUpdateParameters Uses

type AccountUpdateParameters struct {
    // Tags - Resource tags
    Tags                               map[string]*string `json:"tags"`
    *AccountPropertiesUpdateParameters `json:"properties,omitempty"`
}

AccountUpdateParameters the parameters to update on the account.

func (AccountUpdateParameters) MarshalJSON Uses

func (aup AccountUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AccountUpdateParameters.

func (*AccountUpdateParameters) UnmarshalJSON Uses

func (aup *AccountUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AccountUpdateParameters struct.

type AccountsClient Uses

type AccountsClient struct {
    BaseClient
}

AccountsClient is the the Azure Storage Management API.

func NewAccountsClient Uses

func NewAccountsClient(subscriptionID string) AccountsClient

NewAccountsClient creates an instance of the AccountsClient client.

func NewAccountsClientWithBaseURI Uses

func NewAccountsClientWithBaseURI(baseURI string, subscriptionID string) AccountsClient

NewAccountsClientWithBaseURI creates an instance of the AccountsClient client.

func (AccountsClient) CheckNameAvailability Uses

func (client AccountsClient) CheckNameAvailability(ctx context.Context, accountName AccountCheckNameAvailabilityParameters) (result CheckNameAvailabilityResult, err error)

CheckNameAvailability checks that the storage account name is valid and is not already in use. Parameters: accountName - 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 Uses

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

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (AccountsClient) CheckNameAvailabilityResponder Uses

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 Uses

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 Uses

func (client AccountsClient) Create(ctx context.Context, resourceGroupName string, accountName string, parameters AccountCreateParameters) (result AccountsCreateFuture, err error)

Create asynchronously creates a new storage account with the specified parameters. If an account is already created and a subsequent create request is issued with different properties, the account properties will be updated. If an account is already created and a subsequent create or update request is issued with the exact same set of properties, the request will succeed. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. accountName - 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 - the parameters to provide for the created account.

func (AccountsClient) CreatePreparer Uses

func (client AccountsClient) CreatePreparer(ctx context.Context, resourceGroupName string, accountName string, parameters AccountCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (AccountsClient) CreateResponder Uses

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

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

func (AccountsClient) CreateSender Uses

func (client AccountsClient) CreateSender(req *http.Request) (future AccountsCreateFuture, err error)

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

func (AccountsClient) Delete Uses

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

Delete deletes a storage account in Microsoft Azure. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. accountName - 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 Uses

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

DeletePreparer prepares the Delete request.

func (AccountsClient) DeleteResponder Uses

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 Uses

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 Uses

func (client AccountsClient) GetProperties(ctx context.Context, resourceGroupName string, accountName string) (result Account, err error)

GetProperties returns the properties for the specified storage account including but not limited to name, SKU name, location, and account status. The ListKeys operation should be used to retrieve storage keys. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. accountName - 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 Uses

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

GetPropertiesPreparer prepares the GetProperties request.

func (AccountsClient) GetPropertiesResponder Uses

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 Uses

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 Uses

func (client AccountsClient) List(ctx context.Context) (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 Uses

func (client AccountsClient) ListByResourceGroup(ctx context.Context, 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. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive.

func (AccountsClient) ListByResourceGroupPreparer Uses

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

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (AccountsClient) ListByResourceGroupResponder Uses

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 Uses

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 Uses

func (client AccountsClient) ListKeys(ctx context.Context, resourceGroupName string, accountName string) (result AccountKeys, err error)

ListKeys lists the access keys for the specified storage account. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. accountName - 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) ListKeysPreparer Uses

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

ListKeysPreparer prepares the ListKeys request.

func (AccountsClient) ListKeysResponder Uses

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

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

func (AccountsClient) ListKeysSender Uses

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 Uses

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

ListPreparer prepares the List request.

func (AccountsClient) ListResponder Uses

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 Uses

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 Uses

func (client AccountsClient) RegenerateKey(ctx context.Context, resourceGroupName string, accountName string, regenerateKey AccountRegenerateKeyParameters) (result AccountKeys, err error)

RegenerateKey regenerates one of the access keys for the specified storage account. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. accountName - 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 - specifies name of the key which should be regenerated -- key1 or key2.

func (AccountsClient) RegenerateKeyPreparer Uses

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

RegenerateKeyPreparer prepares the RegenerateKey request.

func (AccountsClient) RegenerateKeyResponder Uses

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

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

func (AccountsClient) RegenerateKeySender Uses

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 Uses

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

Update the update operation can be used to update the SKU, encryption, access tier, 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; the 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 can be set. The update of multiple properties is supported. This call does not change the storage keys for the account. If you want to change the storage account keys, use the regenerate keys operation. The location and name of the storage account cannot be changed after creation. Parameters: resourceGroupName - the name of the resource group within the user's subscription. The name is case insensitive. accountName - 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 - the parameters to provide for the updated account.

func (AccountsClient) UpdatePreparer Uses

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

UpdatePreparer prepares the Update request.

func (AccountsClient) UpdateResponder Uses

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 Uses

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 AccountsCreateFuture Uses

type AccountsCreateFuture struct {
    azure.Future
}

AccountsCreateFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (*AccountsCreateFuture) Result Uses

func (future *AccountsCreateFuture) Result(client AccountsClient) (a Account, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type BaseClient Uses

type BaseClient struct {
    autorest.Client
    BaseURI        string
    SubscriptionID string
}

BaseClient is the base client for Storage.

func New Uses

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI Uses

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

type CheckNameAvailabilityResult Uses

type CheckNameAvailabilityResult struct {
    autorest.Response `json:"-"`
    // NameAvailable - Boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or is invalid and cannot be used.
    NameAvailable *bool `json:"nameAvailable,omitempty"`
    // Reason - The reason that a storage account name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: 'AccountNameInvalid', 'AlreadyExists'
    Reason Reason `json:"reason,omitempty"`
    // Message - The error message explaining the Reason value in more detail.
    Message *string `json:"message,omitempty"`
}

CheckNameAvailabilityResult the CheckNameAvailability operation response.

type CustomDomain Uses

type CustomDomain struct {
    // Name - The custom domain name. Name is the CNAME source.
    Name *string `json:"name,omitempty"`
    // UseSubDomainName - Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates
    UseSubDomainName *bool `json:"useSubDomainName,omitempty"`
}

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

type Endpoints Uses

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

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

type ProvisioningState Uses

type ProvisioningState string

ProvisioningState enumerates the values for provisioning state.

const (
    // Creating ...
    Creating ProvisioningState = "Creating"
    // ResolvingDNS ...
    ResolvingDNS ProvisioningState = "ResolvingDNS"
    // Succeeded ...
    Succeeded ProvisioningState = "Succeeded"
)

func PossibleProvisioningStateValues Uses

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns an array of possible values for the ProvisioningState const type.

type Reason Uses

type Reason string

Reason enumerates the values for reason.

const (
    // AccountNameInvalid ...
    AccountNameInvalid Reason = "AccountNameInvalid"
    // AlreadyExists ...
    AlreadyExists Reason = "AlreadyExists"
)

func PossibleReasonValues Uses

func PossibleReasonValues() []Reason

PossibleReasonValues returns an array of possible values for the Reason const type.

type Resource Uses

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

Resource describes a storage resource.

func (Resource) MarshalJSON Uses

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Resource.

type Usage Uses

type Usage struct {
    // Unit - The unit of measurement. Possible values include: 'Count', 'Bytes', 'Seconds', 'Percent', 'CountsPerSecond', 'BytesPerSecond'
    Unit UsageUnit `json:"unit,omitempty"`
    // CurrentValue - The current count of the allocated resources in the subscription.
    CurrentValue *int32 `json:"currentValue,omitempty"`
    // Limit - The maximum count of the resources that can be allocated in the subscription.
    Limit *int32 `json:"limit,omitempty"`
    // Name - The name of the type of usage.
    Name *UsageName `json:"name,omitempty"`
}

Usage describes Storage Resource Usage.

type UsageClient Uses

type UsageClient struct {
    BaseClient
}

UsageClient is the the Azure Storage Management API.

func NewUsageClient Uses

func NewUsageClient(subscriptionID string) UsageClient

NewUsageClient creates an instance of the UsageClient client.

func NewUsageClientWithBaseURI Uses

func NewUsageClientWithBaseURI(baseURI string, subscriptionID string) UsageClient

NewUsageClientWithBaseURI creates an instance of the UsageClient client.

func (UsageClient) List Uses

func (client UsageClient) List(ctx context.Context) (result UsageListResult, err error)

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

func (UsageClient) ListPreparer Uses

func (client UsageClient) ListPreparer(ctx context.Context) (*http.Request, error)

ListPreparer prepares the List request.

func (UsageClient) ListResponder Uses

func (client UsageClient) 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 (UsageClient) ListSender Uses

func (client UsageClient) 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 UsageListResult Uses

type UsageListResult struct {
    autorest.Response `json:"-"`
    // Value - The list Storage Resource Usages.
    Value *[]Usage `json:"value,omitempty"`
}

UsageListResult the List Usages operation response.

type UsageName Uses

type UsageName struct {
    // Value - A string describing the resource name.
    Value *string `json:"value,omitempty"`
    // LocalizedValue - A localized string describing the resource name.
    LocalizedValue *string `json:"localizedValue,omitempty"`
}

UsageName the Usage Names.

type UsageUnit Uses

type UsageUnit string

UsageUnit enumerates the values for usage unit.

const (
    // Bytes ...
    Bytes UsageUnit = "Bytes"
    // BytesPerSecond ...
    BytesPerSecond UsageUnit = "BytesPerSecond"
    // Count ...
    Count UsageUnit = "Count"
    // CountsPerSecond ...
    CountsPerSecond UsageUnit = "CountsPerSecond"
    // Percent ...
    Percent UsageUnit = "Percent"
    // Seconds ...
    Seconds UsageUnit = "Seconds"
)

func PossibleUsageUnitValues Uses

func PossibleUsageUnitValues() []UsageUnit

PossibleUsageUnitValues returns an array of possible values for the UsageUnit const type.

Directories

PathSynopsis
storageapi

Package storage imports 9 packages (graph) and is imported by 4 packages. Updated 2019-08-04. Refresh now. Tools for package owners.